🧮Averages

Generate a summary report of averages and rolling averages for incomes, expenses and debt repayments for a defined period of time.

Averages

POST {{baseUrl}}/bank-accounts/:bank_account_id/transaction-reports/averages

Generate a summary report of averages for incomes, expenses and debt repayments for a defined period of time. Plus a rolling 3-month averages for all transaction categories.

Path Parameters

Name	Type	Description
bank_account_id*	String	The UUID for a Bank Account that gets generated and returned in the POST Create new Bank Account response.

Request Body

Name	Type	Description
start_date*	String	This field indicates the start date from which you would like to generate the summary report. In the following format: yyyy-mm-dd
end_date*	String	This field indicates the end date up until which you would like to generate the summary report. In the following format: yyyy-mm-dd

200: OK Average report successfully generated

```postman_json
{
    "data": [
        {
            "id": "8c498370-44eb-4164-8700-8e3bd0cf7d5c",
            "report": {
                "average_incomes": "15000.00",
                "average_expenses": "10207.20",
                "last_transaction": "01 February",
                "first_transaction": "07 December",
                "total_average_incomes": "15000.00",
                "number_of_transactions": 12,
                "total_average_expenses": "10207.20",
                "average_debt_repayments": "0.00",
                "total_average_debt_repayments": "0.00"
            },
            "startDate": "2021-12-01",
            "endDate": "2022-02-28",
            "type": "averages"
        }
    ]
}
```

400: Bad Request Inactive Online Session

```postman_json
{
    "data": "Online Banking Login Session has not been activated."
}
```

400: Bad Request Incomplete Online Session

```postman_json
{
    "data": "Online Banking Login Session Incomplete."
}
```

400: Bad Request Failed Online Session

```postman_json
{
    "data": "Online Banking Login Session Failed."
}
```

400: Bad Request Expired Online Session

```postman_json
{
    "data": "Online Banking Login Session has expired."
}
```