Skip to main content

Send Numeral Sales History

POST 

/api/numeral/instances/:instance/backfill

Starts a background send of every reportable sale dated on or after start_date (named "Numeral: send sales history (since YYYY-MM-DD)"). Live changes are always sent before history. Moves the connection start date earlier when needed. Cancelling the background job holds every not-yet-sent history record (reason backfill_cancelled); records already sent stay sent. Sending must be switched on first (422 push_disabled). Only one history send runs at a time (422 backfill_running with the running tracked_job_log_id).

Required scope: accounting:write

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

Body fields:

  • start_date (date, Y-m-d, required, not in the future).

Returns the background job id to track progress.

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

Request​

Responses​

OK

Response Headers
    Content-Type