Update payment
update_paymentUpdate an existing payment. paymentId accepts a full UUID or a unique prefix of one in this building; an ambiguous or unknown id fails with an error asking for the full UUID. Only supplied fields change. startDate and endDate cover whole months; when only one is supplied, the existing other bound is reused. Setting status to COMPLETED generates a receipt number when needed. cashBox moves a CASH payment in or out of the building cash box. Setting status to CANCELLED stores an optional cancelReason that appears in the audit log and the apartment ledger; on an already-cancelled payment the reason can be set or changed without resending the status.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"buildingId": "<buildingId>",
"paymentId": "<paymentId>"
},
"name": "update_payment"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | ||
| amount | No | ||
| status | No | ||
| cashBox | No | True when the money sits in the building cash box. Only meaningful for CASH payments; storing false for any other method keeps it out of the cash box. | |
| dueDate | No | ||
| endDate | No | ||
| paidDate | No | ||
| paymentId | Yes | ||
| startDate | No | ||
| buildingId | Yes | ||
| description | No | ||
| cancelReason | No | Why the payment was cancelled. Supply it together with status CANCELLED, or later on an already-cancelled payment to set or change the reason without resending the status; it is stored on the payment and shown in the audit log and the apartment ledger. | |
| paymentMethod | No | ||
| referenceNumber | No |