Refresh Sales Invoice from Order
POST/api/sales-invoices/:salesInvoice/refresh-from-order
Rebuild a draft invoice's lines from its sales order's current billable state and prices: quantities are clipped to what is still billable, prices and discounts are re-read from the order, and fees are re-allocated by the order's fee policy. A draft linked to shipments is rebuilt from those shipments. Use it after the order changed under a draft (a price correction, a cancelled line). No request body.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Returns the refreshed invoice. Returns 422 when the invoice is not a draft (issued invoices are frozen), is an order invoice (kind order_mirror, which always follows its order), is a deposit invoice, covers several orders, or nothing on the order is left to bill.
Requires orders:write and sales_invoices.update.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
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.