๐Ÿ’ดSummary Report

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

Summary Report

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

Generate a report with a summary of total values and monthly averages for incomes, expenses and debt repayments over a given period.

Path Parameters

NameTypeDescription

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

NameTypeDescription

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"

```postman_json
{
    "data": [
        {
            "id": "9db85029-0408-42ab-b8c1-c8b46269611b",
            "report": {
                "months": {
                    "year": 2023,
                    "month": "February",
                    "incomes": "36479.28",
                    "expenses": "73603.18",
                    "fullMonth": true,
                    "debt_repayments": "4157.47"
                },
                "averages": {
                    "average_incomes": "9119.82",
                    "average_expenses": "808.83",
                    "last_transaction": "28 February",
                    "first_transaction": "01 February",
                    "average_debt_repayments": "4157.47"
                }
            },
            "startDate": "2023-02-01",
            "endDate": "2023-02-28",
            "type": "summary"
        },
        {
            "id": "d581b80c-ac5e-421f-b50f-75e07bd01d92",
            "report": {
                "months": {
                    "year": 2023,
                    "month": "March",
                    "incomes": "52105.21",
                    "expenses": "81201.07",
                    "fullMonth": true,
                    "debt_repayments": "4157.47"
                },
                "averages": {
                    "average_incomes": "4736.84",
                    "average_expenses": "1143.68",
                    "last_transaction": "31 March",
                    "first_transaction": "01 March",
                    "average_debt_repayments": "4157.47"
                }
            },
            "startDate": "2023-03-01",
            "endDate": "2023-03-31",
            "type": "summary"
        }
    ]
}
```

Last updated