Allocate Payment to Sales Invoice
POST/api/sales-invoices/:salesInvoice/allocations
Apply part of an existing payment of the invoice's sales order (e.g. an on-account deposit) to this invoice. payment_id and amount (> 0) are required. Over-allocating the payment or the invoice is refused.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
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.