Modifying disbursements

You can modify agency bill disbursements and suspense disbursements using Cloud API. The endpoint and PATCHable fields are the same regardless of the parent entity.

Use the following endpoint to modify disbursements:
  • PATCH /billing/v1/disbursements/{disbursementId}
The following fields can be modified:
  • address*
  • dueDate
  • internalComment
  • mailTo*
  • memo*
  • payTo*
  • paymentInstrument

*These fields can only be mmodified by callers with the disbpayeeedit permission.

The same validations apply both when PATCHing disbursements and when POSTing disbursements. For example, the due date of a modified disbursement cannot be in the past or before the payment date of the suspense payment. If a disbursement has been sent or rejected, the only field that you can modify is internalComment.

The following example PATCHes all modifiable fields on a disbursement:

Command
PATCH /billing/v1/disbursements/bc:325
Request body
{
  "data": {
    "attributes": {
      "address": " 930 Updated ln.",
      "dueDate": "2025-11-11",
      "internalComment": "Updating all fields",
      "mailTo": "Effective Agency",
      "memo": "Payment reference number: bc:302192833",
      "payTo": "Effective Insurance",
      "paymentInstrument": {
        "id": "bc:SNJ_s0ECcwKa29io9kcvk"
      }
    }
  }
}