v2

latestSwagger 2.02026-08-04108164321.0 KB
Payment

Retrieves a paginated list of customer payments, including allocations to specific invoices. Can filter by invoice or updated date.

get/api/Payment

Query parameters

InvoiceTransactionIDinteger

Filter for Payments that have at least one allocation against a given Invoice Transaction ID

UpdatedAfterstring date-time

Only return records updated after this UTC date-time (ISO 8601 format). Useful for incremental sync.

pageSizeinteger

Number of items per page (max 1000)

pageNumberinteger

Page to display. Starts from 1.

Response

Returns a paginated list of customer payments with allocations.

TotalCountinteger

Total number of records matching the query across all pages.

PageNumberinteger

The current page number (1-based).

PageSizeinteger

The number of records per page.