# 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

<mark style="color:blue;">Bulk Update should be used</mark>

<mark style="color:blue;">Transaction control should ALL or NONE - i.e. either all disbursements should be updated or none should be updated.</mark>

### Validations & exceptions

1. Cancellation is only possible before the disbursement\_envelope.disbursement\_schedule\_date


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.openg2p.org/products/g2p-bridge/development/design-specifications/persistent-objects/cancel_disbursements.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.