---
title: "Get invoice payments by invoice Id"
method: GET
path: "/1.0/invoices/{invoiceId}/payments"
tags: ["Invoices"]
---

# Get invoice payments by invoice Id

`GET /1.0/invoices/{invoiceId}/payments`

## Path parameters

- `invoiceId` integer, required

## Query parameters

- `pageSize` number
- `pageToken` string

## Response `200`

The requested action was successfully executed.

- ExampleAPIResponseInvoicePayments
  - `data` PaymentRecordPublicAPIResponseEntity[] — Reflects all the default and custom fields and their values for the object searched, in an array format. If the includeFields param is utilised in the request body, it will return a customised response.
    - `paymentId` integer — The unique identifier for the payment record.
    - `paymentRecordType` 'PAID' | 'WRITE_OFF' — The identifier for payment type (e.g WRITE_OFF,PAID)
    - `currency` 'AFN' | 'ALL' | 'DZD' | 'ARS' | 'AMD' | 'AUD' | 'AZN' | 'BHD' | 'BDT' | 'BYN' | 'BZD' | 'BOB' | 'BAM' | 'BWP' | 'BRL' | 'GBP' | 'BND' | 'BGN' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DJF' | 'DOP' | 'EGP' | 'ERN' | 'EEK' | 'ETB' | 'EUR' | 'GEL' | 'GHS' | 'GTQ' | 'GNF' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'LVL' | 'LBP' | 'LYD' | 'LTL' | 'MOP' | 'MKD' | 'MGA' | 'MYR' | 'MUR' | 'MXN' | 'MDL' | 'MAD' | 'MZN' | 'MMK' | 'NAD' | 'NPR' | 'TWD' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PKR' | 'PAB' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'SAR' | 'RSD' | 'SGD' | 'SOS' | 'ZAR' | 'KRW' | 'LKR' | 'SDG' | 'SEK' | 'CHF' | 'SYP' | 'TZS' | 'THB' | 'TOP' | 'TTD' | 'TND' | 'TRY' | 'USD' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'XOF' | 'YER' | 'ZMK' | 'ZWL' — Currency of the invoice amount
    - `paymentDate` string — The date when the payment was made.
    - `amount` number — The amount of the payment.
    - `notes` string — Additional notes or comments regarding the payment.
  - `pagination` ExamplePaginationInvoicePayments — Responses that return multiple objects will be paginated. The pagination params define how pages are structured and how to traverse through pages.
    - `pageSize` integer — Denotes the page size mentioned in the current request (limit). It defaults to 100 if left blank.
    - `hasMore` boolean — Tells us if there is more content.
    - `totalRecordCount` integer — Denotes the total resources matching the filters.
    - `nextPage` string — Denotes an API URL, which can be conveniently called to perform the subsequent search call to get to the next page.
    - `nextPageToken` string — Denotes a unique token that points to the next page of resources. To get results from subsequent pages, you can use the nextPageToken available in the response under pagination. This token is valid for 15 minutes.

## Other responses

- `400` — This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.
- `401` — You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.
- `404` — If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.

---

[API](https://skmtc.net/rocketlane/apis/rocketlane-api.md) · [All operations](https://skmtc.net/rocketlane/apis/rocketlane-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rocketlane/rocketlane-api/versions/1e8ba619e741/schema)