📈Income

Generate a summary report of incomes for a defined period of time.

Income

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

Generate a summary report of incomes for a defined period of time.

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"

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 Link has expired."
}
```

200: OK Income report successfully generated

```postman_json
{
    "data": [
        {
            "id": "d2f860e8-3152-466c-90c0-13e8687b7f1f",
            "report": {
                "year": 2023,
                "month": "February",
                "incomes": "73603.18"
            },
            "startDate": "2023-02-01",
            "endDate": "2023-02-28",
            "type": "incomes"
        },
        {
            "id": "89d57d43-358f-41e7-8842-0762c62331cf",
            "report": {
                "year": 2023,
                "month": "March",
                "incomes": "70603.00"
            },
            "startDate": "2023-03-01",
            "endDate": "2023-03-31",
            "type": "incomes"
        }
    ]
}
```