Reconciliation

Create matching rule

Create a rule that decides when an external record matches the ledger.

POST/reconciliation/matching-rules

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

namestringrequiredbody

Name of the rule. An empty name is rejected.

descriptionstringbody

What the rule is for.

criteriaobject[]requiredbody

Comparisons that must all match. At least one is required.

Response

rule_idstringrequired

Id of the rule. Pass it in matching_rule_ids when you start a run.

namestringrequired

Name of the rule.

descriptionstring

What the rule is for.

criteriaobject[]required

The criteria that were stored. Each criterion also includes value and pattern. Matching does not read them.

created_atstringrequired

When the rule was created.

updated_atstringrequired

When the rule was last changed. Same as created_at on create.