cancel_disbursements.md

layout
title description tableOfContents outline pagination visible true visible visible true visible true visible true

cancel_disbursements

API Attributes
Direction	Inward
Invoked by	PBMS
Mode	Synchronous
Tables	disbursement

Will update disbursement.cancellation_status to CANCELLED

Will also decrement the following attributes in disbursement_envelope_batch_status

• total_disbursement_amount_received
• number_of_disbursements_received

Bulk Update should be used

Transaction control should ALL or NONE - i.e. either all disbursements should be updated or none should be updated.

Validations & exceptions

1. Cancellation is only possible before the disbursement_envelope.disbursement_schedule_date