Skip to main content
GET
List Invoices

Authorizations

Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId
string<uuid>
required

Company identifier

Query Parameters

status
string

Comma-separated invoice statuses (OR within the column) — any of no_charges, owed, partially_paid, paid, voided. deleted is rejected (400): deleted invoices are hidden from lists

categoryId
string<uuid>

Only invoices in this transaction category

linkedEvent
string<uuid>

Only invoices linked to this event

linkedPolicy
string<uuid>

Only invoices linked to this policy

linkedPayee
string<uuid>

Only invoices with this payee

number
string

Only the invoice with this exact invoice number

Minimum string length: 1
incurredAfter
string<date>

Only invoices incurred on or after this date (YYYY-MM-DD)

incurredBefore
string<date>

Only invoices incurred on or before this date (YYYY-MM-DD)

dueAfter
string<date>

Only invoices due on or after this date (YYYY-MM-DD)

dueBefore
string<date>

Only invoices due on or before this date (YYYY-MM-DD)

unlinked
boolean

true matches invoices with no event and no policy link; false applies no filter

limit
integer
default:50

Page size (default 50, maximum 200)

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

The previous page's nextCursor, echoed verbatim. Opaque — its internals may change shape at any time

Response

One page of invoices

invoices
object[]
required
nextCursor
string | null
required

Cursor for the next page; null exactly when the listing is exhausted