GuidesAPI ReferenceChangelogDiscussions
Log In
API Reference

[BETA] SII bulk ingest batch completed

wbhk
siiBatchFinished

[BETA] — staging only. Fired when an SII bulk ingest batch (submitted to POST /accounts/{account}/tax_report_batches) finishes processing. The payload carries the batch id, final status and summary counts; fetch the full per-record results from status_url (GET /accounts/{account}/tax_report_batches/{id}). This event is currently available on the staging environment only; it is not yet enabled in production.

Payload

Notification that an SII bulk ingest batch has reached a terminal state. Fetch the full per-record results from the status_url.

string
required
Defaults to sii_batch.finished

Code that describes the event.

integer
required

Unix timestamp indicating when the event was triggered.

data
object
required

Batch identity, final status and summary counts. The full per-record results stay behind status_url to keep the body bounded for large batches.

Headers
string
required

Contains a signature to verify the authenticity and integrity of the request. The signature is generated using the HMAC-SHA256 algorithm with a payload composed of the timestamp and the JSON data. Format: t={timestamp},s={signature}.

Responses
200

Return a 200 status to indicate that the data was received successfully

404

The webhook URL could not be reached. Ensure the URL is correct and reachable.

Updated about 4 hours ago 

LoadingLoading…

Updated about 4 hours ago