# Monthly

## Monthly

<mark style="color:green;">`POST`</mark> `{{baseUrl}}/bank-accounts/:bank_account_id/transaction-reports/monthly`

Generate a report with a summary of total values, number of transactions per transaction category and monthly averages for incomes, expenses and debt repayments over a given period.&#x20;

#### Path Parameters

| Name                                                | Type   | Description                                                                                                                                                                                                                                                                                                                |
| --------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| bank\_account\_id<mark style="color:red;">\*</mark> | String | The UUID for a Bank Account that gets generated and returned in the [*<mark style="color:orange;">**POST**</mark>**&#x20;\*\*\*\*Create n***](https://finch-technologies.gitbook.io/gathr-api-documentation/consumer-affordability-v1/reports/broken-reference)[***ew Bank Account*** ](#create-new-bank-account)response. |

#### Request Body

| Name                                          | Type   | Description                                                                                                                             |
| --------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| start\_date<mark style="color:red;">\*</mark> | 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<mark style="color:red;">\*</mark>    | 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"` |

{% tabs %}
{% tab title="200: OK Monthly report successfully generated " %}

````json
```postman_json
{
    "data": [
        {
            "id": "17dcdfff-ff66-433d-bce1-7f16f6b342b3",
            "report": {
                "year": 2023,
                "month": "February",
                "incomes": "36479.28",
                "expenses": "73603.18",
                "fullMonth": null,
                "main_income": "36159.28",
                "debt_repayments": "4157.47",
                "main_income_date": "24-02-23",
                "main_income_type": "salary-wages",
                "number_of_incomes": 4,
                "main_income_transaction": "FNB OB Pmt Finch Salary 62563987381",
                "number_of_debt_repayments": 1,
                "number_of_expense_transactions": 91
            },
            "startDate": "2023-02-01",
            "endDate": "2023-02-28",
            "type": "monthly"
        },
        {
            "id": "05dd907d-2b79-4904-8016-b93cb6c774a5",
            "report": {
                "year": 2023,
                "month": "March",
                "incomes": "52105.21",
                "expenses": "81201.07",
                "fullMonth": null,
                "main_income": "46785.21",
                "debt_repayments": "4157.47",
                "main_income_date": "25-03-23",
                "main_income_type": "salary-wages",
                "number_of_incomes": 11,
                "main_income_transaction": "FNB OB Pmt Salary 62563987381",
                "number_of_debt_repayments": 1,
                "number_of_expense_transactions": 71
            },
            "startDate": "2023-03-01",
            "endDate": "2023-03-31",
            "type": "monthly"
        }
    ]
}
```
````

{% endtab %}

{% tab title="400: Bad Request Inactive Online Session" %}

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

{% endtab %}

{% tab title="400: Bad Request Incomplete Online Session" %}

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

{% endtab %}

{% tab title="400: Bad Request Failed Online Session" %}

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

{% endtab %}

{% tab title="400: Bad Request Expired Online Session" %}

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

{% endtab %}
{% endtabs %}