Skip to main content
POST
List historical balances

Authorizations

Authorization
string
header
required

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

Body

application/json

List historical balances for a customer

customer_id
string<uuid>
required
contract_id
string<uuid>

Return only historical balances from this contract.

id
string<uuid>

Return only the historical balance with this ID.

covering_date
string<date-time>

Return only historical balances with access schedules that cover this date.

starting_at
string<date-time>

Return only historical balances with any access on or after this date.

effective_before
string<date-time>

Return only historical balances with any access before this date (exclusive).

moved_to_history_after
string<date-time>

Return only balances that became historical at or after this date.

moved_to_history_before
string<date-time>

Return only balances that became historical before this date (exclusive).

include_ledgers
boolean
default:false

Include ledgers in the response. Setting this flag may cause the query to be slower.

next_page
string

The next page token from a previous response.

limit
integer
default:25

The maximum number of historical balances to return. Defaults to 25.

Required range: 1 <= x <= 25

Response

Success

data
object[]
required
next_page
string | null
required