Skip to main content

Retrieve Remita Collection Batch by ID

Overview​

Retrieves a single Remita collection batch by its ID, including full batch details and associated collection items.

Command Details​

  • Command: RetrieveRemitaCollectionBatchByIdQuery
  • Type: Query

API Endpoint​

POST /api/bpm/cmd

Request Structure​

FieldTypeRequiredDescription
idlongYesThe ID of the collection batch to retrieve

Try It Out​

POST/api/bpm/cmdRetrieveRemitaCollectionBatchByIdQuery
Request Body

Response Structure​

{
"success": true,
"data": {
"id": 3001,
"batchName": "March 2026 Loan Collections",
"batchDescription": "Monthly Remita loan repayment batch",
"status": "Authorized",
"organisationId": 1001,
"createdAt": "2026-03-08T10:30:00Z"
},
"message": "Collection batch retrieved successfully"
}