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 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
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. |
period | String | Split output with the given period. The period is composed with units (days, months, years) and numbers. You can give for example |
bookmarked | String | Whether the bank account is bookmarked. |
usage | BankAccountUsage string | Account usage. |
Response body: BalanceGroupsList object
Data model
BalanceGroupsList object
Property | Type | Description |
---|---|---|
| Array of BalanceGroup objects | List of balance group items matching the requested period and bounds. |
| Date | Minimum available date for results. |
| Date | Maximum available date for results. |
| Date | Minimum date of results in the current response. |
| Date | Maximum date of results in the current response. |
BalanceGroup object
Property | Type | Description |
---|---|---|
| Date | Start date of the group item. |
| Date | End date of the group item. |
| Array of BalanceCurrencyGroup objects | List of balance details grouped by currency. |
BalanceCurrencyGroup object
Property | Type | Description |
---|---|---|
| String | ISO code of the currency. |
| String | Display symbol of the currency. |
| Decimal | Balance of the account at the end of the period group. |
| Decimal | Total of expenses over the period group. |
| Decimal | Total of incomes over the period group. |
| Decimal | Difference between expenses and incomes over the period group. |
Last updated