Numeral collects account statements from banks and extracts balances of connected accounts.

Balance object

A balance has a type, debit or credit direction, amount, connected account, date, and created_at date. The date is the date of the balance, while the created_at date is the date at which the balance has been collected from the bank and created by Numeral.

{
  "id": "210910eb-a84a-40f6-ac68-7a2c18d62692",
  "object": "balance",
  "connected_account_id": "ff1714ae-3ec8-450d-984c-c6ee44c82a88",
  "direction": "credit",
  "amount": 1200000,
  "currency": "EUR",
  "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"
}

Types of balances

Banks calculate and provide multiple balances, with different types and timings and their various possible combinations:

Types: balances can be booked or available. A booked balance includes all transactions booked on an account, which an available balance includes a booked balance adjusted for transactions that might not have been booked on an account
Timings: most common balances include opening balance (also equal to the closing balance of the previous day), interim balance (including new transactions booked since the previous closing or opening balance), and closing balance (including all transactions of the day)

Type	Description
`opening_available`	Balance available at the beginning of the period, e.g. the start of the bank working day
`closing_available`	Balance available at the end of the period, e.g. the cut-off time
`opening_booked`	Balance booked at the beginning of the period
`closing_booked`	Balance booked at the end of the period
`interim_available`	Updated available balance
`interim_booked`	Updated booked balance

Searching balances

You can use the List all balances feature to retrieve balances.

The connected_account_id, type, start_date, and end_date query parameters let you filter for specific balances.

To learn more about balances, check the Balance object.