Update Numeral Settings
PUT/api/numeral/instances/:instance
Updates any subset of the connection settings. Keys may be sent flat or nested under settings; omitted keys are left unchanged.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body fields (all optional):
- push_enabled (boolean): send sales to Numeral. Refused with 422
unclassified_channels(and achannelslist) while any included sales channel has no tax-collection classification. - start_date (date, Y-m-d, not in the future): send sales dated on or after this day. Moving it earlier releases records held as before-start-date.
- default_product_category (string): Numeral product category for taxable lines; must be a code from List Numeral Product Categories.
- shipping_product_category (string): Numeral product category for shipping and other charges.
- excluded_sales_channel_ids (array of integers): sales channels whose sales are not sent. Replaces the list.
- live_calculation_enabled (boolean, default false): calculate tax with Numeral for orders SKU.io computes tax for itself (manual and B2B portal orders, and orders from channels without their own tax). Those orders get their tax from a live Numeral calculation and are committed to Numeral as tax transactions (refunds as tax refunds) instead of being sent as manual line items; channel orders are unaffected. Independent of
push_enabled. Turning it on stampslive_calculation_enabled_atand moves records held asawaiting_live_calculationto their transaction records; turning it off re-queues those orders as manual line items.
Authentication: Requires a Bearer token. Requires the integrations.update permission.
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 Entity
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.