Skip to main content

Get Numeral Sync Record

GET 

/api/numeral/records/:record

One record's detail: the list fields plus the last attempted request and Numeral's response, the last request Numeral accepted, every line id ever sent (lines removed later are re-sent as zero), the SKU.io document (customer, channel, ship-to), the lines Numeral holds mapped back to SKU.io products and charges, the tax_context (responsibility, customer exemption, whether the wholesale flag was sent), numeral ids (order_id, mli_id, and for a live-calculation record transaction_id, calculation_id — the calculation it was committed from — and refund_id, plus is_live_calculation), which actions apply (permissions) and the activity-log count. Amounts are integer minor units. filed_period_warning is set when a change was re-sent into a period Numeral has already filed (see List Numeral Sync Records); it is null otherwise. A sales credit record (syncable_type sales_credit) links to the credit and carries negative amounts. The request body never contains the API key.

Required scope: accounting:read

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

Authentication: Requires a Bearer token. Requires the integrations.sync permission.

related lists the sync records linked to this one — for a credit refund, the sale transaction it refunds; for a sale transaction, its refunds. Each entry has id, type, type_label, reference (document number), status and link_route.

Request​

Responses​

OK

Response Headers
    Content-Type