📓Debt

Generate a summary report of debt repayments for a defined period of time.

Debt

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

Generate a summary report of debt repayments 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"

200: OK Debt report successfully generated

```postman_json
{
    "data": [
        {
            "id": "8c498370-44eb-4164-8700-8e3bd0cf7d5c",
            "report": {
                "year": 2023,
                "month": "February",
                "debt_repayments": "4157.47"
            },
            "startDate": "2023-02-01",
            "endDate": "2023-02-28",
            "type": "debt"
        },
        {
            "id": "7631a0ec-6fc7-4b2a-9eb2-3673b719b6fc",
            "report": {
                "year": 2023,
                "month": "March",
                "debt_repayments": "4157.47"
            },
            "startDate": "2023-03-01",
            "endDate": "2023-03-31",
            "type": "debt"
        }
    ]
}
```

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