POST (create) a reports action/generate a report

POST

/clients/{clientno}/actions/reports/{reporttype}

Creates one new reports action (generate a report request, ready for execution). About required input, see the description for each report type code

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

OK. The request succeeded

Body

🟢201

🟠422

🟠400BadRequest

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/clients//actions/reports/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "metadata": {
        "userId": "TestUser"
    },
    "action": {
        "report": {
            "includeSum": "includeSum",
            "adb": {
                "debtCollectionColumn": true,
                "intervals": [
                    {
                        "intervalNo": 1,
                        "intervalLength": 20
                    },
                    {
                        "intervalNo": 4,
                        "intervalLength": 40
                    },
                    {
                        "intervalNo": 5,
                        "intervalLength": 60
                    }
                ]
            }
        }
    }
}'

Response Example

200 - Action created, reports

{
    "status": "PROCESSED",
    "result": "CREATED",
    "message": "Action reports created and accepted for processing",
    "reportType": "adb",
    "clientNo": 2218,
    "jobQueueId": 908966
}

Modified at 2026-04-14 09:49:15

POST (create) an action

ArItems