Record a payment
invoices_record_paymentRecord money received against a sent invoice: amount, date, method and reference. It becomes partially_paid, or paid when nothing is left. A payment can't be more than the balance, unless keep_excess keeps the rest as the customer's credit (an overpayment, like Xero's, for invoices_use_credit); a negative amount records a refund. When the account keeps books, it is posted to them. Costs $0.01 per call; nothing if it fails.
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": {
"invoice_id": "<invoice_id>",
"amount": "<amount>"
},
"name": "invoices_record_payment"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | When it was paid. Default today. | |
| note | No | ||
| amount | Yes | In the invoice's currency, e.g. "250.00". Negative for a refund. | |
| method | No | other | |
| reference | No | e.g. the bank transfer reference or the payment id. | |
| invoice_id | Yes | The invoice_id invoices_create returned (quotes and credit notes have one too). | |
| keep_excess | No | Paid more than the balance: keep the rest as the customer's credit. |