Record Sales Invoice Payment
POST/api/sales-invoices/:salesInvoice/payments
Record a payment against an issued invoice. amount (required, non-zero), payment_date (required), payment_type_id (required), reference (optional). An amount above the balance due becomes an overpayment credit for the customer, linked to the invoice (on a consolidated invoice the credit belongs to the customer rather than to one order). Returns the updated invoice.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
On an invoice that mirrors its sales order, the payment is recorded on the order with the same rules as adding a sales order payment: a negative amount is a refund and cannot exceed what the order has been paid, and a positive payment is refused once the order is fully paid. On any other invoice the amount must be positive — refund it with a credit note instead.
Requires orders:write and sales_invoices.manage_payments.
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.