v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

balances

Retrieve balance

Retrieve a balance

get/balances/{id}

Path parameters

idstring required

Example:210910eb-a84a-40f6-ac68-7a2c18d62692

The ID of the balance.

Response

200

idstring required

UUID of the balance.

object'balance' required

Label used to identify this kind of object.

connected_account_idstring required

The ID of the connected account.

amountinteger required

The absolute amount of balance of the account, in the currency's smallest unit.

For euro transactions, the smallest unit is cents. €20 is represented as 2000.

currency'EUR' required

Currency in which an amount is expressed

direction'credit' | 'debit' required

Balance's direction:

credit:
debit:

Balance's type:

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

datestring date required

The date of the balance. (Format: YYYY-MM-DD)

created_atstring date-time required

The UTC timestamp of the creation of this balance.

Example response

{
  "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"
}