Skip to main content

Delete Disbursement Batch

Overview​

Permanently deletes a disbursement batch and all its associated entries. This action is irreversible. Only batches in Draft or Cancelled status can be deleted.

Command Details​

  • Command: DeleteDisbursementBatchCommand
  • Type: Command (write operation)
  • Batch status requirement: Draft or Cancelled
  • Permissions required: Disbursement Create

API Endpoint​

POST /api/bpm/cmd

Request Structure​

FieldTypeRequiredDescription
batchIdlongYesID of the batch

Try It Out​

POST/api/bpm/cmdDeleteDisbursementBatchCommand
Request Body

Response Structure​

{
  "success": true,
  "data": {
    "batchId": 1024
  },
  "message": "Batch deleted permanently"
}