Skip to main content

List Numeral Sync Records for Sales Order

GET 

/api/sales-orders/:salesOrder/numeral

The Numeral records of one sales order: the order's own record (per-order invoicing) or its invoices' records, plus the records of its sales credits. Each record has the same fields as List Numeral Sync Records, including filed_period_warning. data is empty and meta.connected false when Numeral is not connected. meta.live_calculation reports live tax calculation for the order: enabled (the setting is on), active (a calculation can be requested now — on, connected and the key accepted), applies (SKU.io computes this order's tax itself, so live calculation is used for it) and calculation — the order's latest calculation or null: status calculated | fallback (Numeral refused the address; the order keeps its own tax) | failed (any other error), is_fallback, calculation_id, expires_at / is_expired (an uncommitted calculation expires and is recalculated before it is committed), calculated_at, currency_code, currency_exponent, total_amount_minor, total_tax_minor, error_type, error_message, the origin and ship_to addresses sent, and lines (each with reference, kind sol (order line) or fl (charge), source_id, amount_minor, quantity, tax_minor, product_category).

Required scope: orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires a Bearer token with the orders:read scope. Requires the sales_orders.index permission.

Request​

Responses​

OK

Response Headers
    Content-Type