Request to generate account transactions report

Here, you will learn how to generate account transactions report in Tuum.

Use case

In this example, we will review how to request to generate account transactions report.

Use case data	API parameters with values
The ID of the account from where the transactions report will be exported.	...accounts/ID-12333/transactions/export
The type of report file that is going to be generated. The exportFileType can be: JSON or CSV.	"exportFileType": "JSON"
The transaction export time frame. For the dateType you can choose: POSTING_DATE - is the current Tuum banking date when the account transaction was posted. VALUE_DATE - is the date on which operation actually carries out or is supposed to carry out in the account. Must be the same or earlier than the posting date.	"dateFrom": "2029-04-01", "dateTo": "2029-05-31", "dateType": "POSTING_DATE"

Sample API call

To request account transaction report, make the following call.

https://account-api.sandbox.tuumplatform.com/api/v4/accounts/{accountId}/transactions/export

Learn more about the export account transactions endpoint in the Tuum developer portal.

Sample request

In the sample below you will find information on how to request an account transactions report.

JSON

{
  "exportFileType": "JSON",
  "dateFrom": "2029-04-01",
  "dateTo": "2029-05-31",
  "dateType": "POSTING_DATE"
}

cURL

Sample response

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

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "generationId": "ID-2864",
        "generationTypeCode": "ACCOUNT_TRANSACTIONS",
        "groupTypeCode": "ACCOUNT",
        "statusCode": "PENDING",
        "createdDTime": "2025-03-07T17:21:10.04Z",
        "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"
        },
        "previewEnabled": false
    }
}

Note that the report generation process is asynchronous. Use the generationId parameter (ID-2864 in this example) to check the report status and retrieve the report in the subsequent steps.

Result

As a result, a request was made to generate an account transaction report.