A balance is the balance of a connected account on a given date and time. Numeral connects to your bank to retrieve account statements and extract account balances.
Attribute | Description |
---|---|
id string | UUID of the balance. |
object string | The object, here balance . |
connected_account_id string | The ID of the connected account. |
amount integer | 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 string | The currency of the balance. All ISO-4217 currency codes are supported. |
direction string | Balance directions can be debit or credit . |
type string | The type of the balance. When retrieving several balances on the same created_at day, balance records of the same day are fetched depending on their type, in the following order :
|
date date | The date of the balance. |
bank_data object | Bank data containing a reference to the file in which this balance has been described (file_id ) as well as bank specific information related to this balance (optional). For instance: statement_id (ISO 20022). |
created_at datetime | The UTC timestamp of the creation of the balance. |
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"
}