Balance object

A balance is the balance of a connected account on a given date and time. Numeral connects to your banks to retrieve account statements and extract account balances.

AttributeDescription
id
string
The balance ID.
object
string
Always balance.
connected_account_id
string
The connected account ID.
amount
integer
The balance amount, in the currency's smallest unit.

For instance, euro smallest unit is cents and €20 is thus represented as 2000.
currency
string
The balance currency. All ISO-4217 currency codes are supported.
direction
string
The balance direction, either debit or credit.
type
string
The balance type. When retrieving multiple balances on the same date day, balance records are created and sorted as follows:
  • interim_booked
  • closing_booked
  • closing_available
  • opening_booked
  • opening_available
  • interim_available
  • previously_closed
  • expected
  • forward_available
  • info
  • undefined
date
date
The balance date.
bank_data
object
Bank data in JSON key:value format.
created_at
datetime
The balance creation UTC timestamp.

Below is an example of a balance:

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