A balance object is a specific number reported by your bank regarding your bank account balance. Often this is split up into many different categories depending on on how the bank handles its reporting.
Also see: Balance Reports
| Attribute | Description |
|---|---|
| id string | The unique identifier for the balance. |
| amount int | The balance amount. |
| currency string | The currency of the balance. |
| balance_type string | The specific type of balance reported. One of opening_ledger, closing_ledger, current_ledger, opening_available, opening_available_next_business_day, closing_available, current_available, or other. |
| vendor_code string | The code used by the bank when reporting this specific balance. |
| vendor_code_type string | The type of vendor_code being reported. See possible Vendor Code Types at Transactions |
| live_mode boolean | This field will be true if this object exists in the live environment or false if it exists in the test environment. |
{
"id": "1f4b0995-338e-41ed-93c4-a41ed8312312",
"object": "balance",
"amount": 1033236,
"currency": "USD",
"balance_type": "opening_ledger",
"vendor_code": "010",
"vendor_code_type": "bai2",
"live_mode": true,
"created_at": "2019-11-09T00:11:07Z",
"updated_at": "2019-11-09T00:11:07Z"
}