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).
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires a Bearer token. Requires the integrations.sync permission.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.