payments_create
Record an invoice payment to update the paid amount and balance, automatically setting the invoice status to partially paid or paid. Supports partial payments with method, reference, and notes.
Instructions
Record a payment received for an invoice. Updates the invoice amountPaid and balance, and automatically changes invoice status to "partially_paid" or "paid" as appropriate. Supports partial payments with full details (method, reference, notes).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | No | Additional notes about this payment | |
| amount | Yes | Payment amount (must be greater than 0) | |
| currency | No | Currency code (ISO 4217). Defaults to invoice currency. Include if payment is in a different currency. | |
| companyId | No | Company UUID override (uses active company if not set) | |
| invoiceId | Yes | Invoice UUID to record payment for | |
| reference | No | Payment reference number (e.g., bank transfer reference, receipt number) | |
| paymentDate | Yes | Date payment was received in ISO 8601 format (YYYY-MM-DD) | |
| paymentMethod | No | Payment method: bank_transfer (default), cash, card, cheque, or other |