Update Sales Invoice Settings
PUT/api/settings/sales-invoices
Save the invoicing settings. Fields: default_policy (per_order, per_shipment, manual), number_format (tokens {order}, {seq}, {seq:3}, {series}, {series:6}, {series:numeric15}; must include {seq} or {series}), number_series_next (≥ 1), auto_issue_shipment_invoices, fee_allocation (prorate, first_invoice, last_invoice, separate_invoice), invoice_date_basis (ship_date, issue_date), email_on_issue, overdue_reminders[] (days after due, 1–365), invoice_awaiting_info_shipments, auto_void_on_shipment_void, and channels[] {id, invoicing_policy, fee_allocation, number_format} (null clears an override). Formats are checked against QuickBooks' 21-character and Walmart's 15-digit limits; a bad channel format is reported on channels.N.number_format. Changing a default never changes existing orders.
settings:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Requires the settings:write scope and the settings.update permission.
Request
Responses
- 200
- 401
- 403
- 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.
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.