Skip to main content

Get Numeral Reconciliation

GET 

/api/numeral/instances/:instance/reconciliation

What SKU.io sent to Numeral, aggregated per month × ship-to state, next to what Numeral itself reports for the same cells.

Required scope: accounting:read

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

Each row covers one month and one country_code / province_code. period_start / period_end are the row's slice of the requested range (use them as filter[date_from] / filter[date_to] on List Numeral Sync Records to see the row's documents). Sent amounts are integer minor units of the base currency (currency_code, currency_exponent): sales_sent_minor and tax_sent_minor for orders and invoices, credits_sent_minor and credit_tax_sent_minor for sales credits (negative), net_sales_sent_minor = sales + credits. orders_pushed / credits_pushed count documents, record_count all records, status_counts records by status (pending, synced, held, needs_action, failed, skipped); issue_count / has_issues cover needs_action + failed + held.

numeral_reported holds Numeral's own figures for the cell — transaction_count, net_sales and tax_collected as decimal major units in currency_code (Numeral's reporting currency for the cell; MIXED when it reported several) — and variance the difference Numeral minus SKU.io: sales, sales_percent (null when nothing was sent), tax (against order + credit tax), tax_percent (null when no tax was sent), count (against orders + credits pushed) and highlight (true when the counts differ, or sales or tax differ by more than 0.5% — any tax difference when no tax was sent). variance_unavailable_reason is currency when the cell's currency differs from the base currency (or is mixed): the money fields of variance (sales, sales_percent, tax, tax_percent) are then null but count and highlight still compare transactions; otherwise it is null. Once Numeral reports anything for the range, a cell Numeral has no figures for is a reported zero.

Both are null on every row when Numeral cannot be asked; numeral_reported_status says why: available, reason (disconnected, unavailable, auth, rate_limited, error, or empty when Numeral reported no sales for the range), message, stale (true when a previously fetched answer is served because Numeral could not be reached) and fetched_at. numeral_reported_available is true when Numeral's figures are shown. totals sums the sent columns; totals.numeral_reported is always null.

Query parameters: filter[date_from], filter[date_to] (Y-m-d; default the last 12 calendar months through today), group_by (month_state only).

Authentication: Requires a Bearer token. Requires the report_access.sales-tax permission.

Request​

Responses​

OK

Response Headers
    Content-Type