Get all batches

GET

/batches

Retrieve all batches with optional filtering

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Query Params

Responses

🟢200OK

application/json

Body

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🔴500Internal Server Error

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/batches?State&Type&PageToken&PageSize&SortDirection' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "summary": {
        "status": "string",
        "nextPageToken": "string"
    },
    "data": [
        {
            "batchId": "5579c111-9c50-47e2-af92-f16d52e63189",
            "type": "NONE",
            "status": {
                "statuscode": 0,
                "errors": [
                    {
                        "objectname": "string",
                        "objectindex": 0,
                        "message": "string"
                    }
                ],
                "responses": [
                    {
                        "objectname": "string",
                        "objectindex": 0,
                        "ledgerref": "string",
                        "status_statuscode": "string"
                    }
                ]
            },
            "createdAt": "2019-08-24T14:15:22Z",
            "finishedAt": "2019-08-24T14:15:22Z",
            "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
            "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
            "succeeded": [
                {
                    "$type": "invoiceSuccess",
                    "invoiceNumber": "string",
                    "caseId": "string",
                    "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec"
                }
            ],
            "failed": [
                null
            ]
        }
    ]
}

Modified at 2025-09-23 10:42:55

banqsoft

Get organization batches