Retrieve Remita Collection Batches

Overview

Retrieves a paginated list of Remita collection batches. Supports filtering by organisation and date range, with optional export mode for bulk data extraction.

Command Details

• Command: RetrieveRemitaCollectionBatchesQuery
• Type: Query

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
pageNumber	int	No	Page number for pagination (default: 1)
pageSize	int	No	Number of records per page (default: 10)
organisationId	long	No	Filter by organisation
isExport	bool	No	Export mode for bulk retrieval (default: false)
startDate	string	No	Filter batches created on or after this date (ISO 8601)
endDate	string	No	Filter batches created on or before this date (ISO 8601)

Try It Out

POST/api/bpm/cmdRetrieveRemitaCollectionBatchesQuery

Base URL

Bearer Token

Request Body

{ "cmd": "RetrieveRemitaCollectionBatchesQuery", "data": { "pageNumber": 1, "pageSize": 10, "isExport": false, "startDate": "2026-01-01", "endDate": "2026-03-31" } }

Response Structure

{
  "success": true,
  "data": {
    "items": [
      {
        "id": 3001,
        "batchName": "March 2026 Loan Collections",
        "status": "Authorized",
        "createdAt": "2026-03-08T10:30:00Z"
      },
      {
        "id": 2998,
        "batchName": "February 2026 Loan Collections",
        "status": "Completed",
        "createdAt": "2026-02-05T09:00:00Z"
      }
    ],
    "totalCount": 15,
    "pageNumber": 1,
    "pageSize": 10
  },
  "message": "Collection batches retrieved successfully"
}

Related Operations

• Retrieve Collection Batch by ID — Get a single batch by ID
• Create Collection Batch — Create a new batch
• Retrieve Collections — List individual collection records