v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

balances

List 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 sorted in the order defined here

get/balances

Query parameters

limitinteger

starting_afterstring

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

sort_order'asc' | 'desc'

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.

start_datestring date

The date of the balance.

end_datestring date

The date of the balance.

connected_account_idstring

The ID of the connected account related to the balance.

direction'credit' | 'debit'

The direction of the balance.

Balance's type:

closing_available:
closing_booked:
opening_available:
opening_booked:
interim_available:
interim_booked:
previously_closed:
expected:
forward_available:
info:
undefined:

Example:opening_available

The type of the balance.

currencystring

The currency of the balance.

amount_frominteger

The amount of the balance

amount_tointeger

The amount of the balance

file_idstring

The ID of the file including the balance.

latestboolean

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

Response

200

Example response

{
  "records": [
    {
      "id": "210910eb-a84a-40f6-ac68-7a2c18d62692",
      "object": "balance",
      "connected_account_id": "ff1714ae-3ec8-450d-984c-c6ee44c82a88",
      "amount": 1200000,
      "currency": "EUR",
      "direction": "credit",
      "type": "opening_available",
      "date": "2022-01-03",
      "bank_data": {
        "file_id": "26f4ca1c-65b0-412f-b464-206721d1e6d8",
        "statement_id": "STS-C4RR9YPLL0HHIFFHR-D8CEX3"
      },
      "created_at": "2022-01-03T00:11:07Z"
    }
  ]
}