Skip to main content

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.

Required scope: accounting:write

Grant 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 a channels list) 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 stamps live_calculation_enabled_at and moves records held as awaiting_live_calculation to 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​

OK

Response Headers
    Content-Type