API reference

List balances

get
https://sandbox.numeral.io/v1/balances

List all balances. In the response, balance records are sorted as follow:

  • from the most recent to the oldest, based on date.
  • within each day, an additional ordering by type is applied, and balances are fetched in the order defined here.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 100
Defaults to 25
string

The ID of the object from which your list request will start. It is not included in the result.

string
enum

Order is based on attribute date. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

Allowed:
date

The date of the balance.

date

The date of the balance.

string

The ID of the connected account related to the balance.

string
enum

The direction of the balance.

Allowed:
string
enum

The type of the balance.

string

The currency of the balance.

integer
≥ 0

The amount of the balance

integer
≥ 0

The amount of the balance

string

The ID of the file including the balance.

boolean

If true, only latest balances per connected_account_id and currency are returned. Balances with type forward_available are excluded.

Responses

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago