Get /api/v3/batch

Operation: GetBatchesV3 Permissions: BillsAndBatches (View) Paginated

ℹ️ NOTE
This API is paginated. Note that the initial response may not represent all available records.
Please see the paging tutorial for more information.

Summary

Path and Query Parameters

Parameter Description Type Location
filter string Query
pageSize The number of elements to return in a page integer Query
pageNumber The current page number integer Query

Filters

Name Description Type Operators
accountPeriod accountperiod equals, not equals, less than, between, greater than, less than equal, greater than equal
batchCode Batch Number string equals, not equals, less than, between, one of, greater than, less than equal, greater than equal, like, not like, not one of
batchStatus Batch Status string equals, not equals, one of, not one of
billCount Bills in Batch integer equals, not equals, less than, between, greater than, less than equal, greater than equal
controlCode Batch Control Batch string equals, not equals, less than, between, one of, greater than, less than equal, greater than equal, like, not like, not one of
duedate Batch Due Date string equals, not equals, less than, between, one of, greater than, less than equal, greater than equal, like, not like, not one of
endDate Batch Close Date date equals, not equals, less than, between, greater than, less than equal, greater than equal
fullName string equals, not equals, less than, between, one of, greater than, less than equal, greater than equal, like, not like, not one of
HasImportsWithKickout Batch Has Imports with Kickouts boolean equals
invoiceNumber Batch Invoice Number string equals, not equals, less than, between, one of, greater than, less than equal, greater than equal, like, not like, not one of
isOpen boolean equals
nextReading Batch Next Reading Date string equals, not equals, less than, between, one of, greater than, less than equal, greater than equal, like, not like, not one of
runningTotal Batch Total Cost double equals, not equals, less than, between, greater than, less than equal, greater than equal
startDate Batch Open Date date equals, not equals, less than, between, greater than, less than equal, greater than equal
statementDate Batch Statement Date string equals, not equals, less than, between, one of, greater than, less than equal, greater than equal, like, not like, not one of
systemUserCode Batch Created By User Code string equals, not equals, less than, between, one of, greater than, less than equal, greater than equal, like, not like, not one of
systemUserId integer equals, not equals, less than, between, greater than, less than equal, greater than equal

Response Parameters

HTTP 200

Header Parameters

Header Description Type
PageNumber The current page number integer
TotalPages The total number of pages available given the current page size integer
PageSize The current page size integer
TotalNumberOfRecords The total number of records available integer


Body Parameters

Content Type: application/json

Type Reference: BatchResponse [Array]

Parameter Description Type
array
   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

Responses

HTTP 200

Header

{
  "PageNumber": 1,
  "TotalPages": 1,
  "PageSize": 1,
  "TotalNumberOfRecords": 1
}

Body

Content Type: application/json
[
  {
    "batchId": 1,
    "batchCode": "string",
    "isOpen": false,
    "batchStatus": "string",
    "startDate": "2025-11-14",
    "endDate": "2025-11-14",
    "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
  }
]