Transactions export API
| Method | Endpoint | Description |
|---|---|---|
GET |
/api/transactions |
Export transactions |
POST |
/api/transactions/query |
Export transactions |
Export transactions
GET /api/transactions
Export transactions in various formats. The requested media type determines which parameters are supported. See the description of individual parameters for details. Date filter must always be specified (using date, processedDate, or startDate+endDate).
Query parameters
| Name | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
date |
string (date) | Transaction date in ISO format (YYYY-MM-DD). Supported for XML and JSON export. Incompatible with other date/time parameters. | "2023-06-18" |
||
processedDate |
string (date) | Transaction processed date in ISO format (YYYY-MM-DD). Supported for XML and JSON export. Incompatible with other date/time parameters. | "2023-06-18" |
||
startDate |
string (date-time) | Start of date range, inclusive, in ISO format. Supported for XLSX, PDF and JSON export. Must be used in conjunction with endDate. |
"2023-06-18T01:30:00.000+02:00" |
||
endDate |
string (date-time) | End of date range, exclusive, in ISO format. Supported for XLSX, PDF and JSON export. Must be used in conjunction with startDate. |
"2023-06-18T01:30:00.000+02:00" |
||
tids |
array[string] | List of TIDs (terminal IDs). Supported for XLSX, PDF and JSON export. If both tids and bids are specified, the resulting filter is applied as a logical (inclusive) disjunction (OR). |
|||
bids |
array[string] | List of BIDs (branch IDs). Supported for XLSX, PDF and JSON export. If both tids and bids are specified, the resulting filter is applied as a logical (inclusive) disjunction (OR). |
|||
approvedOnly |
boolean | false |
If true, only approved transactions will be included in the export. Supported for XLSX and PDF export. |
||
unpairedNexi |
boolean | Filter transactions based on their pairing status. Supported for XLSX and PDF export. | |||
grouped |
boolean | false |
If true, transactions will be grouped by their reporting group. Supported for PDF export. |
Responses
200 — OK
| Media Type | Schema |
|---|---|
application/pdf |
string (binary) |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
string (binary) |
application/x-ndjson |
TransactionsJsonExportDto |
application/xml |
TransactionsXmlExportResponseXsd |
Security
Person_apiKey— API key in headerAuthorization— Example: 'ApiKey uihdrtghb9843ui5dfgbdwjk'
Export transactions
POST /api/transactions/query
Export transactions in XLSX or PDF. If both bids and tids are specified in the request body, the resulting filter is applied as a logical (inclusive) disjunction (OR). The requested media type determines which request body schema is supported. See the descriptions of request body for details.
Request Body
Required.
| Media Type | Schema |
|---|---|
application/json |
TransactionsExportRequestDto — Supported for XLSX export TransactionsPdfExportRequestDto — Supported for PDF export |
Responses
200 — OK
| Media Type | Schema |
|---|---|
application/pdf |
string (binary) |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
string (binary) |
Security
Person_apiKey— API key in headerAuthorization— Example: 'ApiKey uihdrtghb9843ui5dfgbdwjk'