Get EnterpriseOpen Dashboard

Reconciliation

Start reconciliation

Start a batch reconciliation against an uploaded file.

POST/reconciliation/start

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

See also: Core API key.

Body

upload_idstringrequiredbody

Id of the file to reconcile, from Upload external records.

strategystringrequiredbody

How records are grouped before matching. See Strategies.

  • one_to_one: one external record against one ledger transaction.
  • one_to_many: one external record against a group of ledger transactions.
  • many_to_one: a group of external records against one ledger transaction.

Any other value is accepted, and the run completes with zero counts.

matching_rule_idsstring[]requiredbody

Ids of the rules to apply. A record matches when every criterion in any one of these rules matches. An empty list returns 400 with RECON_MATCHING_RULES_REQUIRED.

grouping_criteriastringbody

Field used to group the many side. Required for one_to_many and many_to_one. Leave it out for one_to_one. A value Core cannot group on does not fail this call, and the run finishes as failed. See Strategies.

dry_runbooleandefault falsebody

When true, the run stores the counts and does not write match rows or metadata on the ledger transactions. Defaults to false.

Response

The run is created and continues in the background. This response does not include status or match counts. Poll Get reconciliation with reconciliation_id.

reconciliation_idstringrequired

Id of the run.