Balance Over Time Report
This report shows the changes to an account balance over time.
This report can be requested via the Modular Report endpoint.
ReportOptions
This report has no options to be considered.
Response Structure of Balance Over Time Report
The generated report will be part of the modular report response.
{
"type": "BALANCE_OVER_TIME",
"balances": Array<BalanceInfo>
}
type String, always present
The type
always contains the value "BALANCE_OVER_TIME" for this report.
balances BalanceInfo[], always present
List of balances for the account for each date between the given report-timeframe.
BalanceInfo
{
"date": date,
"balance": Amount
}
Example request
{
"insights_consumer_id": "6c03aff-8fa0046-ffae74-b0cbc-4d5fd1",
"report_days": 3,
"reports": [
{
"type": "BALANCE_OVER_TIME"
}
]
}
Example response
{
"data": {
"accounts": [
{
"insights_account_id": "3b3d678f-66b7-4b23-a2a5-0bfd275e86a1",
"reports": [
{
"type": "BALANCE_OVER_TIME",
"balances" :
[
{
"date": "2020-10-18",
"balance":
{
"amount": 15400,
"currency": "EUR"
}
},
{
"date": "2020-10-19",
"balance":
{
"amount": 12137,
"currency": "EUR"
}
},
{
"date": "2020-10-20",
"balance":
{
"amount": 169758,
"currency": "EUR"
}
}
]
}
]
}
]
}
}