Batches export API
| Method |
Endpoint |
Description |
GET |
/api/batches |
Export batches |
Export batches
GET /api/batches
Export batches. Date filter must always be specified (either using date or startDate+endDate).
Query parameters
| Name |
Type |
Required |
Default |
Description |
Example |
date |
string (date) |
|
|
Batch date in ISO format (YYYY-MM-DD). Incompatible with other date/time parameters. |
"2023-06-18" |
startDate |
string (date-time) |
|
|
Start of date range, inclusive, in ISO format. 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. Must be used in conjunction with startDate. |
"2023-06-18T01:30:00.000+02:00" |
tids |
array[string] |
|
|
List of TIDs (terminal IDs). 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). If both tids and bids are specified, the resulting filter is applied as a logical (inclusive) disjunction (OR). |
|
Responses
200 — OK
Security
Person_apiKey — API key in header Authorization — Example: 'ApiKey uihdrtghb9843ui5dfgbdwjk'