Skip to main content
GET
JavaScript

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

id
string
required

External ID of the customer the invoice belongs to: your customer ref when mapped, otherwise the Received customer ID

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$

Query Parameters

limit
integer
default:20

Maximum number of items to return

Required range: 1 <= x <= 100
after
string

Return items that come after this cursor

Maximum string length: 255
before
string

Return items that come before this cursor

Maximum string length: 255
contractExternalId
string

Filter to invoices for this contract only (contract external ID or Received contract ID). Omit for all contracts.

Maximum string length: 255
stateIn
string

Filter by invoice state. Supports comma-separated values for multiple states

Maximum string length: 255
issuedAfter
string<date-time>

Filter to invoices issued on or after this date, inclusive (ISO 8601)

issuedBefore
string<date-time>

Filter to invoices issued on or before this date, inclusive (ISO 8601)

orderBy
enum<string>

Field to sort by: issueDate (default), dueDate, or total

Available options:
issueDate,
dueDate,
total
orderDir
enum<string>

Sort direction: ASC (default) or DESC

Available options:
ASC,
DESC

Response

A cursor-paginated list of the customer's invoices.

A cursor-paginated list of a customer's invoices

data
Invoice · object[]
required
pagination
object
required

Pagination metadata including cursors for navigating through results