Balances
Last updated
Was this helpful?
Last updated
Was this helpful?
Authentication: endpoints listed in this page require with a user token.
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.
accountId*
String
ID of the bank account
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
accountId*
String
KZiKbVB6V4BF
min_date
Date
fljlFaZDqiN4
max_date
Date
wlFJvI4sxPuY
balances
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.
min_date
Date
Start date of the group item.
max_date
Date
End date of the group item.
currencies
List of balance details grouped by currency.
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.
Array of objects
Array of objects