Skip to main content

Get Numeral Summary

GET 

/api/numeral/instances/:instance/summary

Overview of what has reached Numeral. All amounts are integer minor units of the account's base currency (currency_code), converted per document with its exchange rate. Includes record counts by status, the last accepted document, problem groups (held / needs action / failed, grouped by reason, largest value first — sales_minor is the documents' net sales in minor units, province_codes the six most common states, examples the two largest records), sent vs not-sent value per state for the current calendar month, and the latest history send (backfill.status running | completed | cancelled | failed | null).

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.

Request​

Responses​

OK

Response Headers
    Content-Type