Skip to main content
GET
List cash applications
Use the etag of an item for conditional updates.

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

application_ids
string[]

IDs to return, separated by commas. The other filters also apply.

Required array length: 1 - 100 elements
Minimum string length: 1
stripe_status
enum<string>

Filter on the Stripe sync sub-state. Takes precedence over status = applied or partially_applied. Combining it with status = draft or voided returns 400.

Available options:
pending,
synced,
failed
limit
integer
default:25

Maximum number of records to return.

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

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

status
enum<string>

Filter by cash application status.

Available options:
draft,
applied,
partially_applied,
voided

Legal entity ID (le_…).

Example:

"le_507f1f77bcf86cd799439011"

deposit_transaction_id
string

Transaction ID (txn_…).

Example:

"txn_507f1f77bcf86cd799439011"

invoice_id
string

Invoice ID (inv_…).

Example:

"inv_507f1f77bcf86cd799439011"

Response

The request succeeded.

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.