Introduction to Balances

Find out in what range the customer's balances are.

This report is appropriate for B2B and B2C use cases.

What it solves

To get a quick overview of a customer's overall financial situation, it's worth taking a look at their account balances. Balances provide an overview that shows when the balance was at its lowest or highest. In addition, the average is also shown, as well as the basic income and spending.

These values can be used to quickly assess whether the customer is a reliable partner or whether the financial situation is rather uncomfortable.

Balances Report

The Balance Report is based on the daily balances of one or more accounts.
A separate section is created for each account to see the differences between accounts.

For example, if a client has transferred the money of all accounts to one account in order to be better off, this can be seen from the balances, because the values of the other accounts are stable on average, but at one point they decrease, while another account increases unusually.

Used data fields

The data basis for this report are the daily balances.

The report response itself is divided into the following sections.

Main Section

The main part of the report can be found at $.reports.balances and the type will be BALANCES.

This gives you a quick overview of the transactions used in the report through aggregated values that can serve as a summary.

A full API schema can be seen here: https://docs.finapi.io/?product=di#get-/cases/-caseId-/reports

Field	Description	Mandatory
`creationDate`	Timestamp of when the report was created, in the format '`YYYY-MM-DD HH:MM:SS.SSS`' (CET Europe / Berlin).	yes
`caseId`	ID of the case in which the report was created.	yes
`type`	Defines the type of the report.	yes
`startDate`	Timestamp of the start date of the reporting period under review in the format '`YYYY-MM-DD HH:MM:SS.SSS`' (CET Europe / Berlin).	no
`endDate`	Timestamp of the end date of the reporting period under review in the format '`YYYY-MM-DD HH:MM:SS.SSS`' (CET Europe / Berlin)	no
`daysOfReport`	The number of full days, that the reporting period under review contains.	no
`countIncomeTransactions`	The total count of positive transactions in the report.	yes
`countSpendingTransactions`	The total count of negative transactions in the report.	yes
`totalIncome`	The total income.	yes
`totalSpending`	The total spending.	yes
`totalBalance`	The total balance.	yes
`accountData`	List of accounts-related data with the relevant balances information.	no
`childReports`	List of reports, created automatically with the specified frequency (defined by `interval` and `intervalPeriod`) once the parent report is defined as a continuous one.	no

Account Data Section

The account data section can be found under the accountData field.
It contains data about the account at the first level.
If more than one account is included in the report, they will be displayed individually in the list.

Field	Description	Mandatory
`bankName`	Name of the bank.	yes
`bankId`	Unique identifier of the Bank, generated by finAPI.	yes
`accountIban`	IBAN of the bank account.	no
`accountId`	Unique identifier of the bank account belonging to the imported bank connection.	no
`transactionsStartDate`	Date of the account first transaction, regardless of the report period under review, in the format '`YYYY-MM-DD`' (CET Europe / Berlin). This field takes into consideration all the transactions of the account, irrespectively of the assigned to them label.
`accountType`	Type of the account. Can be: `CHECKING` `SAVINGS` `CREDITCARD` `SECURITY` `LOAN` `POCKET` `MEMBERSHIP` `BUILDING_SAVINGS`
`balances`	Detailed values of the balances	no
`monthlyData`	Monthly data about balances in the account.

Balances Section

This section displays the values of the balances for the given account.

Field	Description	Mandatory
`balancesStartDate`	Timestamp of the date, when user's first daily balance data was retrieved for the given account in the report period under review in the format `YYYY-MM-DD HH:MM:SS.SSS` (CET Europe / Berlin).	no
`totalBalancesDaysCount`	The number of days, daily balances for which were retrieved for the given account in the report period under review.	no
`balance`	Latest account's balance.	yes
`averageBalance`	The average balance amount during the period specified in `maxDaysForCase`.	yes
`minimumBalance`	The lowest balance available on the account within specified `maxDaysForCase`.	yes
`minimumBalanceDate`	Date on which the given account had the lowest balance available within the given period. Date format `YYYY-MM-DD`.	yes
`maximumBalance`	The highest balance available on the account within the specified `maxDaysForCase`.	yes
`maximumBalanceDate`	Date on which the given account had the highest balance available within the given period. Date format `YYYY-MM-DD`.	yes
`overdraftLimit`	The maximum allowed overdraft for the given account if provided by a bank. This field is optional because the limit cannot be determined for all banks.	no
`spending`	Spendings of the account within `maxDaysForCase`.	yes
`income`	Income of the account within `maxDaysForCase`.	yes

Monthly Data Section

In this section, the balances are broken down on a monthly basis. This makes it possible to see the financial development.

If showOnlyCompleteMonths=false, the list of months is calculated between transactionsStartDate of the report and endDate of the report, hence both complete and incomplete months are included.

If showOnlyCompleteMonths=true, only the list of complete months between transactionsStartDate of the report and endDate of the report, is included.

Field	Description	Mandatory
`month`	Month for which the values are calculated.	no
`minMonthlyBalance`	The lowest balance available on the account within the month.	no
`maxMonthlyBalance`	The highest balance available on the account within the month.	no
`averageMonthlyBalance`	The average balance amount on the account within the month.	no
`dailyBalancesCount`	The number of daily balances which were retrieved for the given account within the month.	no
`daysPositiveBalance`	The number af days with positive balance within the month.	no
`daysNegativeBalance`	The number af days with negative balance within the month.	no
`minMonthlyBalanceDate`	The date of the month with the lowest balance within the month.	no
`maxMonthlyBalanceDate`	The date of the month with the highest balance within the month.	no