List invoices
List invoices for the authenticated tenant.
Returns a paginated list of invoices and credit notes. Filters combine with AND. Each item includes counterparty display fields and computed overdue flags. Payment-schedule installments are not included on the list; use Get invoice.
Query parameters
| Name | Type | Required |
|---|---|---|
pageSizePage size. Default 20, maximum 100. Example: 20 | integer | Optional |
cursorOpaque cursor: pass the nextCursor of the previous response. Valid only with the same sortBy, sortOrder, and filters. Omit it for the first page. Example: Y3JlYXRlZF9hdDpkZXNjfDIwMjYtMDktMDhUMTQ6MTA6MDAuMDAwWnw3ZDljMTNlNA | string Max 512 | Optional |
includeTotaltotal is returned on the first page unless includeTotal=false, and on cursor pages only when includeTotal=true. Skip it to save a count. Allowed values truefalse | boolean | Optional |
pageDeprecated. Offset page number kept for older integrations; use cursor instead. Ignored when cursor is sent. Example: 2 | integer | Optional |
updatedSinceISO 8601 instant. Returns only rows modified strictly after it. Use it with cursor for incremental sync. Example: 2026-09-01T00:00:00Z | string No maximum | Optional |
sortBySort column. Default invoice_date. | string No maximum | Optional |
Allowed values invoice_numberinvoice_datedue_dateamount_incl_vatrecovery_percentsettled_amountopen_amountvat_amountstatuscreated_at | ||
sortOrderSort direction. Default desc. Allowed values ascdesc | string No maximum | Optional |
statusSingle status or comma-separated list. overdue is computed from open amount past due, not only stored status. unmatched means unpaid or overdue. | string No maximum | Optional |
Allowed values unpaidpartialpaidcancelledoverdueunmatched | ||
typeissued (you billed) or received (you were billed). Allowed values issuedreceived | string No maximum | Optional |
kindInvoice or credit note. Allowed values invoicecredit_note | string No maximum | Optional |
counterpartyIdFilter by counterparty code ( Example: CPT-042 | string No maximum | Optional |
paymentMethodExpected payment channel. | string No maximum | Optional |
Allowed values cardtransferdirect_debitcashcheckcryptoother | ||
searchCase-insensitive match on invoice_number, recipient_name, customer_name, external_reference, or description. Example: INV-2026 | string Max 100 | Optional |
externalReferenceExact external reference. Example: LC-SO-9081 | string Max 255 | Optional |
startDateInclusive start of invoice_date (YYYY-MM-DD). Example: 2026-09-01 | string No maximum | Optional |
endDateInclusive end of invoice_date (YYYY-MM-DD). Example: 2026-09-30 | string No maximum | Optional |
dueStartDateInclusive start of due_date (YYYY-MM-DD). Example: 2026-09-01 | string No maximum | Optional |
dueEndDateInclusive end of due_date (YYYY-MM-DD). Example: 2026-10-31 | string No maximum | Optional |
minRecoveryMinimum recovery_percent (0-100). Example: 0 | number | Optional |
maxRecoveryMaximum recovery_percent (0-100). Example: 100 | number | Optional |
hasOpenIf true, only invoices with open_amount > 0. Allowed values truefalse | boolean | Optional |
overdueIf true, only invoices past their next due date with an open amount. Allowed values truefalse | boolean | Optional |
Errors
This operation can return the following errors in addition to generic HTTP failures.
| Error | HTTP code | Description |
|---|---|---|
Missing Bearer token | 401 | The Authorization header is missing or is not a Bearer token. |
Invalid or revoked API key | 401 | The API key is unknown, malformed, expired, or has been revoked. |
API key is missing scope invoices:read | 403 | The key does not include invoices:read. A write scope does not imply the matching read scope. |
Too many requests, please try again later | 429 | More than 100 requests in one minute from this API key or IP address. Wait for the Retry-After header (seconds) and retry. |
Invalid query parameters | 400 | A query value failed validation. details lists field and message. |
Internal server error | 500 | Unexpected server error. The JSON body includes correlationId. Retry with backoff. |