Reconciliation

Start reconciliation

Start a batch reconciliation run with the TypeScript SDK.

POST/reconciliation/start

Use blnk.Reconciliation.run to start batch reconciliation.

Call the method

const response = await blnk.Reconciliation.run({
  upload_id: 'upload_8c700d1b-09c0-4ef4-9ab1-a0decf3d0aa3',
  strategy: 'one_to_one',
  dry_run: true,
  grouping_criteria: 'reference',
  matching_rule_ids: [
    'rule_890bdbc4-467f-4670-8424-5667e41daf29',
  ],
});

Field	Type	Description
`upload_id`	`string`	Upload ID returned by `blnk.Reconciliation.upload`.
`strategy`	`string`	Match strategy: `one_to_one`, `one_to_many`, or `many_to_one`.
`dry_run`	`boolean`	Set `true` to test without writing results to the ledger.
`grouping_criteria`	`string`	Field used to group records, for example `reference`.
`matching_rule_ids`	`string[]`	IDs of the matching rules to apply.

Save the reconciliation ID

Use response.data.reconciliation_id with blnk.Reconciliation.get to poll status and match counts.

Response

{
  "reconciliation_id": "rec_a8f2c91d-1234-4abc-9def-0123456789ab"
}

Field	Type	Description
`reconciliation_id`	`string`	ID of the reconciliation run. Use it with `blnk.Reconciliation.get` to check status.