Sign in
Balances

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.

get/organizations/{orgId}/balances

Path parameters

orgIdstring required

The unique identifier (UUID) for your organization. The Organization represents your company as a direct customer of our service.

Query parameters

pageSizeinteger

The maximum number of Balances to return per page.

nextTokenstring

The nextToken for retrieving the next page of Balances. It is used to fetch the next page of Balances in a paginated list.

accountIdstring

The unique identifier (UUID) for the end customer's account.

endDateStartstring

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.

endDateEndstring

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.

contractstring
contractIdstring

Filter Balances by contract id. Use '' with accountId to fetch unlinked balances.

idsstring[]

A list of unique identifiers (UUIDs) for specific Balances to retrieve.

Response

Returns list of Balances

nextTokenstring

Changes

Changed in 4 of the 10 revisions of this API.235

  • ac93d1a9e6d92See the full diff
    • ○

      added the new optional query request parameter contractId

      new-optional-request-parameter

    • ○

      added the new optional query request parameter ids

      new-optional-request-parameter

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0f92c877619f1See the full diff
    • ●

      added the new AD_HOC enum value to the data/items/allOf[subschema #3]/lineItemTypes/items/ response property for the response status 200

      response-property-enum-value-added

  • 9f9e5f3dbde713See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      added the new optional query request parameter contract

      new-optional-request-parameter

    • ○

      added the optional property data to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property nextToken to the response with the 200 status

      response-optional-property-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b512See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ●

      removed the optional property data from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property nextToken from the response with the 200 status

      response-optional-property-removed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog