Determine how often your client has to use the overdraft limit and how much interest they have to pay.
What it solves
Some information about the customer can be gained from how he handles his overdraft level. How often does he need to use his overdraft? At what point in time does he have to do so? How much interest does he pay on the overdraft? From this information, some possible actions can be derived, regarding the customer's creditworthiness and product features.
Overdraft Interest Report
The Overdraft Interest Report shows how often the customer uses their overdraft limit and how much interest they pay.
In addition, further reports can be created based on an initial report. These continuous reports can then be provided with triggers that always compare the values of the previous report with the current one and look for defined changes.
This is useful if you have access to the client's account data over a longer period of time.
It is important that not only days but ideally months are considered.
Used data fields
All transactions of the customer are used for this purpose. This includes data like
account holder name,
amount, and so on.
The report response itself is divided into the following sections.
The main part of the report can be found at
$.reports.overdraftInterest and the
type will be
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
Timestamp of when the report was created, in the format '
ID of the case in which the report was created.
Defines the type of the report.
Timestamp of the start date of the reporting period under review in the format '
Timestamp of the end date of the reporting period under review in the format '
The number of full days, that the reporting period under review contains.
Timestamp of the date, when user's first transaction took place in the report period under review in the format '
The number of the user transactions, that took place in the report period under review. This field takes into consideration all the transactions of the user, irrespectively of the assigned to them label.
The total count of positive transactions in the report.
The total count of negative transactions in the report.
The total income.
The total spending.
The total balance.
List of accounts-related data with the relevant transactions information.
List of reports, created automatically with the specified frequency (defined by
Account Data Section
The account data section can be found under the
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.
Name of the bank.
Unique identifier of the Bank, generated by finAPI.
IBAN of the bank account.
Unique identifier of the bank account belonging to the imported bank connection.
List of transactions related to the chosen report type.
This section displays the transactions used in the report and can be found under the
accountData element in the field
Please note that this list may be very long, especially for business accounts.
Depending on what the report is used for, the transactions can be retrieved for later review or documentation, or they can be turned off. The latter would be the case, for example, if you only want to do a quick check of the overall data and do not need any details.
If transactions are not of interest, you can also disable this section by giving the query parameter
withTransactions=false to the report.
The transactions include the following values.
Value date in the format '
Bank booking date in the format '
Counterpart account number.
Counterpart bank name.
A list of labels assigned by the system. This does not contain the complete label structure in the sense of level of detail.
Includes a much more detailed view of the labels including all level of detail and the most significant labels. To see this section, the report must be called with the query parameter
Extracted details for transactions with related to overdraft interests.
Monthly Data (Aggregations)
Monthly Data are aggregations generated over the report period for specific sub-aspects of the report.
These are reported on a monthly basis and made available as a summary.
This field contains a list of months for which finAPI has complete records available. This automatically means that the first and the last month of the report period are omitted from the list.
Monthly aggregations of various data are listed under this field. These reflect the monthly development of certain criteria in the transactions.
The month, the value, and the number of transactions behind it are always indicated.
Subelements of Monthly Data
This section describes the subfields of the Monthly Data section that can appear in the report.
Additionally, aggregations are provided for the sections behind the subelement, which include values such as
Here we take into consideration the data from both complete and incomplete months inside the report period under review.
Overdraft information-related amounts, organized by months.
Label Details Section
To get more information about labels or the whole Level of Detail structure, this section can be enabled using the query parameter
This is particularly interesting if you want to perform your own evaluations based on the reports. You are able to select all transactions of a certain level of detail because the complete structure is available.
List of labels including their Level of Details structure.
List of labels including the level of details as a flat list.
Most significant labels in the report context including its level of detail, depending on the priority of labels.
Most significate label of level 1
Most significant income related label of level 2
Labels with Level of Details
The general part of the Label Details section is summarized in the
This shows the complete structure for each label in a list.
For example, if a label with
REALESTATELOAN was output in a transaction, this element returns the following structure for the label:
This allows to derive some more context and it allows to select for example
LOANANDINTEREST in all issued transactions of the report, should one be interested only in such transactions.
Since labels may belong to several label groups (e.g.
CARLOAN is both
MOBILITY), it is possible to identify which groups are involved.
Labels Expanded Lower Level of Details
In the field
labelsExpandedLowerLod a simple list of all labels and their level of details is displayed. However, there is no order of the levels, but only all labels, including the levels below them, are displayed as text.
Therefore, this field is best suited for a simple one of a particular label group.
Most significant labels
mostSignificantLabels field returns the most appropriate labels in the report context including its level of detail.
This is controlled by the priorities when the report is created.
For example, if a transaction has the label
CARLOAN, it may appear in the level of detail 1 in the groups
However, by using the priorities, which map what you are most interested in, only one group is returned here.
For example, if the priority of
BANKANDCREDIT is higher than that of
MOBILITY, the structure of
BANKANDCREDIT will be returned.
The reverse would be the
Most significant Level of Detail 1
This area is represented by the field
Only the most important label of level 1, is returned. This is the label that has the highest value in the level.
This is provided for the selection of transactions at level 1. The assumption is that a higher level of detail often results in more accurate, specialized recognition.
Most significant Level of Detail 2 for income transactions
If there are multiple labels in an incoming (positive) transaction, the most significant label is mapped here.
This is also based on the priorities, which can be set with the field
incomeLevelOfDetail2Priority when creating the report.
As a result, the highest level of detail of the transaction is returned here, which can be an indicator that this is the most accurate context.