Check report generation status

Use case

In this example, we will review how to check the status of a requested report file.

Use case data	API parameters with values
The generationId number of the report file that was previously requested.	...api/v2/generations/ID-ID-2864

Sample API call

To find the status of the requested report, make the following API call.

reports-api.sandbox.tuumplatform.com/ api/v2/generations/{generationId}

See more about the find report status endpoint in the Tuum developer portal.

Sample request

Below is an example request of the API call to find report status.

JSON

No request body.

cURL

curl --location --request GET 'https://reports-api.sandbox.tuumplatform.com/api/v2/generations/ID-4714' \
--header 'x-channel-code: system' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiT2ZmaWNlciBUZXN0IiwiZW1wbG95ZWVJZCI6IklELTEyMzgiLCJ0ZW5hbnRDb2RlIjoiTUIuRVUiLCJleHBpcnlEVGltZSI6IjIwMjUtMDMtMDdUMTg6MzY6NTAiLCJleHAiOjE3NDEzNzI2MTAsInJvbGVzIjpbIkFDQ09VTlRBTlQiLCJBRE1JTiJdfQ.WMgoNN6FnntbkVsSxBZtI6mosBNnoOWBrC14reJ9RJM' \
--header 'Content-Type: application/json' \
--data '{
  "accountTypeCode": "INTERNAL",
  "personName": "Trevor Harry Tuum",
  "residencyCountryCode": "GB",
  "customerGroupCode": "INTERNAL",
  "priceListTypeCode": "INTERNAL",
  "currencyCode": "EUR"
}'

Sample response

Below you find an example response body to the API call above.

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "generationId": "ID-2864",
        "generationTypeCode": "ACCOUNT_TRANSACTIONS",
        "generationGroupCode": "ACCOUNT",
        "statusCode": "DONE",
        "createdDTime": "2025-03-07T17:57:04.304Z",
        "entryDate": null,
        "inputJson": "{\"exportFileType\":\"JSON\",\"transactionType\":null,\"transactionSubtype\":null,\"dateFrom\":\"2029-04-01\",\"dateTo\":\"2029-05-31\",\"dateType\":\"POSTING_DATE\",\"directionCode\":null,\"amountFrom\":null,\"amountTo\":null,\"currencyCode\":null,\"contractNumber\":null,\"transactionGroupCodes\":null,\"referenceNumber\":null,\"counterpartyNameSubstring\":null,\"counterpartyAccountNumberSubstring\":null,\"detailsSubstring\":null,\"virtualAccountId\":null,\"source\":null,\"includeAccessRestricted\":false,\"uniqueIdentifier\":null}",
        "errorCode": null,
        "source": {
            "sourceName": "ACCOUNT",
            "sourceRef": "ID-12333"
        },
        "fileInfos": [
            {
                "generationFileId": "ID-2864",
                "fileName": "account-transactions-ID-12333-20250307-1757-04-365.json",
                "storageSource": null,
                "additionalData": null
            }
        ],
        "previewJson": null
    }
}

Result

This endpoint returns the status of the account transactions report. When the statusCode has a value DONE, the report is ready for download. In this example, the generationFileId of the report file is ID-2864.