Operation: GetBatchV3
| Parameter | Description | Type | Location |
|---|---|---|---|
| batchId | Required | integer | Path |
Type Reference: BatchResponse
| Parameter | Description | Type |
|---|---|---|
| batchId | The batch identifier | integer |
| batchCode | The batch code | string |
| isOpen | Is the batch open | boolean |
| batchStatus | The status of the batch (open, pending, closed) | string |
| startDate | The date when the batch was created | string |
| endDate | The date when the batch was closed | string |
| billCount | The number of bills in this batch | integer |
| runningTotal | The cost of all bills in this batch | number |
| statementDate | Statement date batch setting | string |
| dueDate | Due date batch setting | string |
| nextReading | Next reading date batch setting | string |
| controlCode | Control code batch setting | string |
| invoiceNumber | Invoice number batch setting | string |
| accountPeriodName | Account period name batch setting | string |
| accountPeriodNumber | Account period number batch setting | integer |
| accountPeriodYear | Account period year batch setting | integer |
| note | Note/comment for the batch | string |
| createdBy | UserChild | |
| userId | The user identifier | integer |
| userCode | The user code | string |
| fullName | The user’s full name | string |
| flagCount | Number of unresolved flags on bills contained in this batch | integer |
| analyzingCount | Number of bills contained in this batch that are currently being analyzed | integer |
| hasImportedBills | Denotes if the Batch has any imported bills associated with it | boolean |
| hasImportsWithKickout | Denotes if the Batch has any import task with Status = “Completed with kickouts” | boolean |
| hasLogs | Denotes if the Batch has any move log events associated with it | boolean |
{
"batchId": 1,
"batchCode": "string",
"isOpen": false,
"batchStatus": "string",
"startDate": "2025-12-05",
"endDate": "2025-12-05",
"billCount": 1,
"runningTotal": 1.0,
"statementDate": "string",
"dueDate": "string",
"nextReading": "string",
"controlCode": "string",
"invoiceNumber": "string",
"accountPeriodName": "string",
"accountPeriodNumber": 1,
"accountPeriodYear": 1,
"note": "string",
"createdBy": {
"userId": 1,
"userCode": "string",
"fullName": "string"
},
"flagCount": 1,
"analyzingCount": 1,
"hasImportedBills": false,
"hasImportsWithKickout": false,
"hasLogs": false
}