Balances
The balances feature allows you to retrieve an account’s monthly balance, view daily balances by specifying a date range, and track the number of overdraft days during the selected period.
API endpoints
Authentication: endpoints listed in this page require header authentication with a user token.
Get balances of an account
GET https://{domain}.biapi.pro/2.0/users/{userId}/accounts/{accountId}/balances
Get balances (income, outcome and balance) of a single account, for a given period.
Path Parameters
accountId*
String
ID of the bank account
Query Parameters
min_date
Date
Minimum date (inclusive). The default is the start of the current month.
max_date
Date
Maximum date (inclusive). The default is the end of the current month.
Response body: BalanceGroupsList object
Path Parameters
accountId*
String
KZiKbVB6V4BF
Query Parameters
min_date
Date
fljlFaZDqiN4
max_date
Date
wlFJvI4sxPuY
Data model
BalanceGroupsList object
balances
Array of BalanceGroup objects
List of balance group items matching the requested period and bounds.
first_date
Date
Minimum available date for results.
last_date
Date
Maximum available date for results.
result_min_date
Date
Minimum date of results in the current response.
result_max_date
Date
Maximum date of results in the current response.
BalanceGroup object
min_date
Date
Start date of the group item.
max_date
Date
End date of the group item.
n_overdraft
Integer
Number of days with a negative balance
balance
Decimal
Final account balance at the end of the period
expenses, incomes, remains
Decimal
Total expenses, incomes, and net flow
currencies
BalanceCurrencyGroup[]
Breakdown per currency
daily_balances
DailyBalance[]
Daily values for balance, income, expense, and net result
BalanceCurrencyGroup object
id
String
ISO code of the currency.
symbol
String
Display symbol of the currency.
balance
Decimal
Balance of the account at the end of the period group.
expenses
Decimal
Total of expenses over the period group.
incomes
Decimal
Total of incomes over the period group.
remains
Decimal
Difference between expenses and incomes over the period group.
DailyBalance
date
Date
The specific day
balance
Decimal
Balance of the account at the end of the day.
expenses
Decimal
Total of expenses over the day.
incomes
Decimal
Total of incomes over the day.
remains
Decimal
Difference between expenses and incomes over the day
Last updated
Was this helpful?