Advisory

The Advisory product lets you retrieve metrics computed on end user’s banking data.

API endpoint

Authentication: endpoint in this page requires header authentication with a user token.

Get advisory data for the user

GET https://{domain}.biapi.pro/2.0/users/{userId}/advisory

Get advisory metrics computed on end user’s banking data by user ID.

Path Parameters

Name	Type	Description
userId*	Integer	ID of the user

200: OK User’s advisory metrics

Response body: UserAdvisory object

Data model

UserAdvisory object

Property	Type	Description
id_user	Integer	Id of the user.
last_update	DateTime	DateTime of the last Advisory run.
currency	String	Currency codes (ISO 4217) of the analyzed accounts. EUR only.
periods	Array of Period objects	List of periods.

Period object

Property	Type	Description
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	MonetaryAmount object	Recurring revenues minus recurring expenses.
net_savings	MonetaryAmount object	Net balance changed relatively to last month. A positive value corresponds to an increase in balance.
events	Array of Event objects	List of events.
transaction_types	Array of TransactionTypeSummary objects	List of transaction type summaries.
transaction_categories	Array of TransactionCategory objects	List of transaction categories.

Event object

Property	Type	Definition
count	Integer	Number of occurrences.
event	TransactionEvent string	Name of the detected event.

TransactionTypeSummary object

Property	Type	Definition
type	TransactionType string	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	MonetaryAmount object	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	MonetaryAmount object	Sum of incomes of this type in the analyzed month.
total	MonetaryAmount object	Sum of transactions of this category in the analyzed month.

TransactionCategory object

Property	Type	Definition
category	TransactionCategory string	Category of the transaction.
count	Integer	Number of transactions of this category in the analyzed month.
total	MonetaryAmount object	Sum of transactions of this category in the analyzed month.

TransactionCateogry Values

Value	Description
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.

Forward compatibility requirement: new value related to child category may be added in the future.

TransactionEvent Value

Value	Description
unauthorized-overdraft	User's overdraft exceeds the allowed amount.

MonetaryAmout object

Property	Type
currency	String	Currency codes (ISO 4217) of the analyzed accounts. EUR only.
value	String	Amount value. Rounded to two decimal places.