Skip to main content
GET
List Invoices

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Query Parameters

personId
string<uuid>

Only include invoices for this person (e.g. the contractor the invoice pays). Matches the personId field on the invoice.

userId
string<uuid>

Only include invoices belonging to this user

source
enum<string>

Filter by invoice origin, e.g. only contractor-submitted invoices (CONTRACTOR_SUBMITTED) or invoices auto-created from payroll (PAYROLL)

Available options:
SYSTEM,
USER,
REIMBURSEMENT,
PAYROLL,
CONTRACTOR_SUBMITTED
status
string

Filter by invoice status (case-insensitive), e.g. Pending, Processing, Paid, Partially Paid, Overdue, Cancelled

type
enum<string>

Filter by invoice type

Available options:
MANUAL,
PAYROLL,
CONTRACTOR
startDate
string<date>

Only include invoices with an invoice date on or after this date

endDate
string<date>

Only include invoices with an invoice date on or before this date

limit
integer
default:20

Maximum number of invoices to return per page (default 20)

cursor
string

Opaque pagination cursor from the previous page's node.next. Omit to start from the first page.

Response

A list of invoices

data
object[]
node
object

Pagination cursors