Banking account balances
Changes to bank accounts and bank transactions
The Codat data types for bank accounts and bank transactions are going to change. Currently both data types are used for both accounting and banking integrations. In future, these will be separated as follows: accounting packages will use bankAccounts and accountTransactions and banking sources will use banking-accounts and banking-transactions.
Explore the Banking Account Balances endpoint in Swagger.
Overview
The Banking Account Balances data type provides a list of balances for a bank account including end-of-day batch balance or running balances per transaction.
From the Banking Account Balances endpoint, you can retrieve a list of all bank account balances:
GET /companies/{companyId}/connections/{connectionId}/data/banking-accountBalances
Responses are paged, so you should provide page and pageSize query parameters in your request. See Pagination for details.
Data model
Balance
Field | Type | Description |
|---|---|---|
available | decimal | The funds available to withdraw from the bank account. |
current | decimal | The funds in or owed by the bank account. |
limit | decimal | The credit limit or overdraft limit of the bank account. |
Example data
{
"accountBalances": [
{
"accountId": "cce404db-27f7-4286-95db-622b53596cf4",
"balance": {
"available": 714374.48,
"current": 714374.57,
"limit": 5000.0
},
"date": "2021-03-18T00:00:00"
},
{
"accountId": "cce404db-27f7-4286-95db-622b53596cf4",
"balance": {
"available": 714374.48,
"current": 714374.57,
"limit": 5000.0
},
"date": "2021-03-19T00:00:00"
},
{
"accountId": "cce404db-27f7-4286-95db-622b53596cf4",
"balance": {
"available": 714195.66,
"current": 714204.39,
"limit": 5000.0
},
"date": "2021-03-22T00:00:00"
},
{
"accountId": "2f593774-1075-4805-a552-84eecc7eb264",
"balance": {
"available": -644945.42,
"current": -644925.84,
"limit": 0
},
"date": "2022-03-09T00:00:00"
}
]
}
Updated 2 days ago