Record payment
record_paymentRecord a payment for an apartment. Defaults to status COMPLETED paid today. For prepayment of several months pass startDate and endDate (YYYY-MM); the debt calculation covers every month in that range. Pass cashBox true when the money went into the building cash box (CASH payments only; it defaults to true for CASH).
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>",
"apartmentId": "<apartmentId>",
"amount": "<amount>",
"dueDate": "<dueDate>",
"type": "<type>"
},
"name": "record_payment"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | ||
| amount | Yes | ||
| status | No | Payment status. The tool applies COMPLETED when this field is omitted. | |
| cashBox | No | True when the money went into the building cash box. Only meaningful for CASH payments; other methods ignore it. Defaults to true for CASH and false otherwise. | |
| dueDate | Yes | ||
| endDate | No | Whole-month coverage end. For a 5-month prepayment use startDate '2026-09' and endDate '2027-01'. Any supplied day is normalized to the last day of its month. | |
| paidDate | No | Date the payment was paid. Defaults to today in the building time zone when status is COMPLETED. | |
| startDate | No | Whole-month coverage start. For a 5-month prepayment use startDate '2026-09' and endDate '2027-01'. Any supplied day is normalized to the first day of its month. | |
| buildingId | Yes | ||
| apartmentId | Yes | ||
| description | No | ||
| paymentMethod | No | Payment method used when marking the payment COMPLETED. Defaults to BANK_TRANSFER. | |
| referenceNumber | No | Optional bank, cheque, card, or other transaction reference. |