Links

Balances (obsolete)

The current version of this feature is obsolete. A major redesign of it is in progress.

API endpoints

Authentication: endpoints listed in this page require header authentication with a user token.
get
https://{domain}.biapi.pro/2.0
/users/{userId}/accounts/{accountId}/balances
Get balances of an account

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.

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.