Advisory (obsolete)
The Advisory product lets you retrieve metrics computed on end user’s banking data.
Last updated
Was this helpful?
The Advisory product lets you retrieve metrics computed on end user’s banking data.
Last updated
Was this helpful?
GET
https://{domain}.biapi.pro/2.0/users/{userId}/advisory
Get advisory metrics computed on end user’s banking data by user ID.
userId*
Integer
ID of the user
Response body: UserAdvisory object
id_user
Integer
Id of the user.
last_update
DateTime
DateTime of the last Advisory run.
currency
String
periods
List of periods.
period
String
Month analyzed in format YYYY_MM e.g. 2023_12.
transactions_count
Integer
Number of transactions in the analyzed month.
id_accounts
Array of Integer
List of account ids.
min_date
Date
Date of the first analyzed transaction in the period.
max_date
Date
Date of the last analyzed transaction in the period.
disposable_income
Recurring revenues minus recurring expenses.
net_savings
Net balance changed relatively to last month. A positive value corresponds to an increase in balance.
events
List of events.
transaction_types
List of transaction type summaries.
transaction_categories
List of transaction categories.
count
Integer
Number of occurrences.
event
Name of the detected event.
type
Type of transaction.
count
Integer
Number of transactions of this type in the analyzed month.
expenses_count
Integer
Number of expenses of this type in the analyzed month.
expenses_total
Sum of expenses of this type in the analyzed month.
incomes_count
Integer
Number of incomes of this type in the analyzed month.
incomes_total
Sum of incomes of this type in the analyzed month.
total
Sum of transactions of this category in the analyzed month.
category
Category of the transaction.
count
Integer
Number of transactions of this category in the analyzed month.
total
Sum of transactions of this category in the analyzed month.
revenue
A recurring earning, such as salaries, pensions, and rental income. Only transactions with a positive value (e.g. inflows) can be categorized as revenue.
housing
Housing related recurring expenses. Includes energy and utility. Excludes rental income. Only transactions with a negative value can be categorized as housing.
loans
Payments towards the reimbursement of a loan, consumer credit or mortgage. Only transactions with a negative value can be categorized as loans.
household
Child raises expenses, includes child_care and child_support. Only transactions with a negative value can be categorized as household.
unauthorized-overdraft
User's overdraft exceeds the allowed amount.
currency
String
value
String
Amount value. Rounded to two decimal places.
of the analyzed accounts. EUR
only.
Array of objects
object
object
Array of objects
Array of objects
Array of objects
string
string
object
object
object
string
object
of the analyzed accounts. EUR only.