v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB

Invoice payments

Lists all invoice payments

Pages every customer payment recorded against invoices across the organization, independent of which invoice it settled. Use updated.gt and sort_by when syncing integrations; follow the pagination cursor until no next page remains.

get/invoice-payments

Query parameters

limitinteger

Maximum number of rows to return in the page.

cursorstring

If defined, a cursor to retrieve the next page.

Example:iLQvkEj3sh3UiweC

Pagination cursor to navigate through the full response.

updated.gtstring date-time

Example:2023-01-01T00:00:00Z

Filter payments updated after this timestamp

sort_by'created' | 'updated'

the field the payments should be sorted by descending (either created or updated)

Response

Example response

{
  "payments": [
    {
      "amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "account_code": "11112"
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}