Skip to main content
GET
List supplier invoices

Authorizations

x-api-key
string
header
required

Your API key, for example cmp_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx. Create one on the Integrations page of the compliance dashboard.

Query Parameters

businessId
string

The business to act for. Required for organisation-wide keys; omit it for a business-bound key. List the ids you can use with GET /v1/businesses.

cursor
string

The pagination.nextCursor value from the previous page, passed back unchanged.

pageSize
integer
default:20

Items per page, 1 to 100. A value outside that range is a 400, not clamped.

Required range: 1 <= x <= 100
status
enum<string>

Only invoices in this review status.

Available options:
pulled,
pending_review,
confirmed,
rejected
startDate
string<date>

Only documents on or after this date, as YYYY-MM-DD.

endDate
string<date>

Only documents on or before this date, as YYYY-MM-DD.

Response

A page of supplier invoices.

data
object
pagination
object