List Balances
Retrieve a list of all Balances for your Organization.
This endpoint returns a list of all Balances associated with your organization. You can filter the Balances by the end customer's Account UUID and end dates, and paginate through them using the pageSize and nextToken parameters.
NOTE: If a Balance has a rollover amount configured and you want to use the endDateStart or endDateEnd query parameters, the rolloverEndDate is used as the end date for the Balance.
Path parameters
The unique identifier (UUID) for your organization. The Organization represents your company as a direct customer of our service.
Query parameters
The maximum number of Balances to return per page.
The nextToken for retrieving the next page of Balances. It is used to fetch the next page of Balances in a paginated list.
The unique identifier (UUID) for the end customer's account.
Only include Balances with end dates equal to or later than this date. If a Balance has a rollover amount configured, then the rolloverEndDate will be used as the end date.
Only include Balances with end dates earlier than this date. If a Balance has a rollover amount configured, then the rolloverEndDate will be used as the end date.
Filter Balances by contract id. Use '' with accountId to fetch unlinked balances.
A list of unique identifiers (UUIDs) for specific Balances to retrieve.
Response
Returns list of Balances