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

The balance information provided by banks may not always reflect the real-time balance displayed in the bank’s online portal or mobile application. In some cases, it may correspond to the previous day’s balance (e.g., as of 10:00 PM or midnight), a near real-time balance, or another reference point determined by the bank. As a result, this balance must not be relied upon for accounting reconciliation purposes.

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

Name	Type	Description
accountId*	String	ID of the bank account

Query Parameters

Name	Type	Description
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.

200: OK List of balances

Response body: BalanceGroupsList object

Path Parameters

Name	Type	Description
accountId*	String	KZiKbVB6V4BF

Query Parameters

Name	Type	Description
min_date	Date	fljlFaZDqiN4
max_date	Date	wlFJvI4sxPuY

Data model

BalanceGroupsList object

Property	Type	Description
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

Property	Type	Description
min_date	Date	Start date of the group item.
max_date	Date	End date of the group item.
currencies	Array of BalanceCurrencyGroup objects	List of balance details grouped by currency.
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

Property	Type	Description
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

The day-by-day balance becomes available as soon as date parameters are specified in the GET query.

Property	Type	Description
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