Skip to main content

List Numeral Filings

GET 

/api/numeral/instances/:instance/filings

Numeral's sales-tax filings per state and period, newest period first. Served from a cache refreshed by the registration sync; refresh=1 re-reads Numeral now.

Required scope: accounting:write

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

Each row: id, country_code, region_code, status (Numeral's status), period_start, period_end, due_date, amount_due (decimal, may be null), currency_code, dashboard_url and display_status — filed (submitted or being submitted), due, overdue (past due_date, not filed) or canceled. counts totals the rows per display_status.

The endpoint does not fail when Numeral cannot be reached: available is false with a reason (disconnected, unavailable, auth, rate_limited, error) and message, or the last fetched list is served with stale true. fetched_at is when the list was read from Numeral.

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

Request​

Responses​

OK

Response Headers
    Content-Type