Skip to main content
GET
List invoices

Authorizations

Authorization
string
header
required

Send header: Authorization: Bearer <apiKey>.

Query Parameters

reference
string

Filter by invoice reference.

customerDocumentNumber
string

Filter by customer document number.

contract
string

Filter by contract identifier.

paymentDate
string<date>

Filter by exact payment date.

settlementDate
string<date>

Filter by settlement date.

settlementCycle
string

Filter by settlement cycle.

limit
integer
default:20

Number of results per page. Min 1, max 100.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor from a previous response to fetch the next page.

Response

Paginated invoices list

items
object[]
required

Invoices in the current page.

count
integer
required

Number of invoices returned in this page.

cursor
string | null

Cursor for the next page. null when there are no more pages.