Introduction to Maximum Available Funds
Find out at what time your customer has the most funds available. The Maximum Available Funds is the sum of the account balance and the overdraft limit.
This report is appropriate for B2B and B2C use cases.
What it solves
This report can be used to find out at which point in the month the client has the most money available. Included is the money on the account as well as the overdraft limit.
Maximum Available Funds Report
The Maximum Available Funds report is based on the label MAXIMUMAVAILABLEFUNDS, and its further sub-labels with a higher level of detail.
The report gives an overview of data such as the number of relevant transactions. What is the maximum of available funds? At what time does the customer have this maximum liquidity?
Other data includes the account information and the transactions used in the report. This is very helpful if you want to check the values, for example, as part of a detailed credit check.
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
The daily balances of the customer are used as the data basis.
The report response itself is divided into the following sections.
Main Section
The main part of the report can be found at $.reports.maximumAvailableFunds and the type will be MAXIMUMAVAILABLEFUNDS.
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 |
|---|---|---|
| Timestamp of when the report was created, in the format ' | yes |
| ID of the case in which the report was created. | yes |
| Defines the type of the report. | yes |
| Timestamp of the start date of the reporting period under review in the format ' | no |
| Timestamp of the end date of the reporting period under review in the format ' | no |
| The number of full days, that the reporting period under review contains. | no |
| List of maximum available funds calculation results for each account. | yes |
Maximum Available Funds Data Section
This section contains a list of the Maximum Available Funds data that were calculated.
In the list, there is a separate element for each account.
Field | Description | Mandatory |
|---|---|---|
| Latest account's balance. | no |
| Timestamp of when the report was created, in the format ' | yes |
| 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 ' | no |
| The number of days, daily balances for which were retrieved for the given account in the report period under review. | no |
| The maximum amount of funds available on the account on one of the days belonging to the period of the report. | yes |
| The sum of income for the given period as for the given account. | yes |
| The sum of spending for the given period as for the given account. | yes |
| UUID of the bank account belonging to the imported bank connection. | yes |
| IBAN of the bank account. | yes |