Skip to main content
GET
List eligible invoices

Authorizations

X-API-Key
string
header
required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Query Parameters

limit
integer

Page size (1-100). Defaults to 100 when omitted.

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

The next_cursor value from the previous page. Keep the other filters unchanged.

customer_name
string

Customer name, matched as a substring without case sensitivity. stripe_customer_id takes precedence. A name that matches several customers returns an empty page.

Required string length: 1 - 256
stripe_customer_id
string

Stripe customer id.

Required string length: 1 - 256
status
string

Comma-separated invoice statuses: open (the default), paid, draft, void or uncollectible. An unknown value matches nothing.

Required string length: 1 - 64
amount
string

Match invoices by amount due. Use tolerance to widen the amount range.

tolerance
string

Requires amount. Non-negative range around the requested amount; defaults to 5.

date_from
string

Inclusive lower bound on invoice date. A bare YYYY-MM-DD date or a full ISO 8601 timestamp.

date_to
string

Inclusive upper bound on invoice date. A bare YYYY-MM-DD date is clamped to end-of-day UTC; a full ISO 8601 timestamp is the exact instant (not clamped).

Response

A page of invoices eligible for cash application.

data
object[]
required

The records.

has_more
boolean
required

Whether another page is available.

next_cursor
string | null
required

Cursor for the next page, or null on the last page.

resolution
object

Customers that match customer_name.