Run a reconciliation

Changed on

Starts a batch run of the matching engine over the reconciliation's unmatched records and active rules, the same run as Run in the app. The run works in the background: poll GET /reconciliations/{id}, whose current_run is this run while it is pending or running and whose last_run is it once it has completed or failed. Only batch reconciliations can be run on demand; continuous reconciliations match each record as it arrives. A reconciliation has at most one run in progress.

post/reconciliations/{id}/run

Request

  • Base URL
    https://api.endclose.com/v1
  • Auth
    API key in header X-API-KEY

Path parameters

idstring required

The reconciliation ID

Headers

Idempotency-Keystring

Optional. Send the same key when retrying a write you are not sure landed: the first response is returned again (with Idempotent-Replayed: true) instead of writing twice. A key used for a different request is refused with 422; one whose first request is still running gets 409. A refused or failed request does not use up its key. Keys are per environment and kept for 7 days.

Response

Run queued

reconciliation_idstring

Changes