Skip to main content
GET
List invoices

Authorizations

Authorization
string
header
required

An API key created in Settings, sent as Authorization: Bearer <key>.

Query Parameters

customerId
string<uuid>

Only this customer's invoices.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
customerIds
string

Only the invoices of these customers, separated by commas. With customerId as well, an invoice must match both.

contractId
string<uuid>

Only this contract's invoices.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
statuses
string

Only invoices whose status is one of these, separated by commas — for example DRAFT,APPROVED. The statuses are DRAFT, APPROVED, ISSUING, ISSUED, VOIDED. Leave it out for every status but VOIDED.

needsApproval
boolean

true for only the drafts waiting for a person to approve them. A new draft can take a day or more to be listed. false, or leaving it out, applies no filter.

issueDateStartAt
string

Only invoices whose issuedAt, or periodStartAt while issuedAt is null, is at or after this time.

issueDateEndAt
string

Only invoices whose issuedAt, or periodStartAt while issuedAt is null, is at or before this time.

dueDateStartAt
string

Only issued invoices whose dueAt is at or after this time.

dueDateEndAt
string

Only issued invoices whose dueAt is at or before this time.

periodStartAtOrAfter
string

Only invoices whose periodStartAt is at or after this time.

periodStartBefore
string

Only invoices whose periodStartAt is before this time.

hasOutstandingBalance
boolean

Only issued invoices, whichever value is sent: true for those whose appliedAmount is less than totalAmount, false for the rest.

hasAppliedPayments
boolean

Only issued invoices, whichever value is sent: true for those whose appliedAmount is above 0, false for the rest.

hasUncoveredBalance
boolean

Only issued invoices, whichever value is sent: true for those whose remainingAmount is above 0, false for the rest.

orderBy
string

issuedAt:ASC or issuedAt:DESC. An invoice whose issuedAt is null is ordered by its periodStartAt. Omit it for the order Synthetic created the invoices in, oldest first.

startingAfter
string

The nextCursor of the previous page, to read the page after it.

Required string length: 1 - 1024
Pattern: ^[A-Za-z0-9._-]+$
endingBefore
string

The prevCursor of the previous page, to read the page before it.

Required string length: 1 - 1024
Pattern: ^[A-Za-z0-9._-]+$
limit
integer
default:50

Rows per page, 1 to 100.

Required range: 1 <= x <= 100

Response

Successful response

data
object[]
required
hasMore
boolean
required
nextCursor
string
prevCursor
string