Reconciliation
Create matching rule
Create a matching rule for reconciliation.
POST
/
reconciliation
/
matching-rules
{
"name": "Default matcher",
"description": "Amount with 1% drift matcher",
"criteria": [
{
"field": "amount",
"operator": "equals",
"allowable_drift": 0.01
},
{
"field": "currency",
"operator": "equals"
},
{
"field": "date",
"operator": "equals",
"allowable_drift": 1800
},
{
"field": "reference",
"operator": "contains"
}
]
}
{
"error": "invalid operator",
"error_detail": {
"code": "RECON_RULE_INVALID",
"message": "invalid operator"
}
}
If you’re using the auto-provisioned
Enterprise Core instance included with your Production License deployment, set the base URL to: https://ENTERPRISE_PUBLIC_URL/core.If you’re connecting to a different Core instance, use the publicly accessible base URL for that instance instead.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: Scoped API keys and Secure your Blnk server.
Body
string
required
Name of the matching rule.
string
A brief description of what the matching rule does.
array
required
An array of criteria that defines the rule. Each criteria is defined by 3 attributes -
field, operator, allowable_drift.Show child attributes
Show child attributes
string
required
Fields to match. It can be
"amount", "currency", "reference", "description", or "date".string
required
Defines how the selected field should be compared with internal records. Depending on the field, this can be
"equals" or "contains".equals: The field in the external record must exactly match the corresponding field in your Blnk Ledger.contains: Parts of the external field’s value must be found in your Blnk Ledger.
integer
Helps to accomodate small variations in transaction amounts between both records. Only applicable to amount and date fields.
- Amount drift: Measured in percentages, e.g., 1% is
"allowable_drift": 0.01 - Date drift: Measured in seconds, e.g., 1 hour is
"allowable_drift": 3600
{
"name": "Default matcher",
"description": "Amount with 1% drift matcher",
"criteria": [
{
"field": "amount",
"operator": "equals",
"allowable_drift": 0.01
},
{
"field": "currency",
"operator": "equals"
},
{
"field": "date",
"operator": "equals",
"allowable_drift": 1800
},
{
"field": "reference",
"operator": "contains"
}
]
}
{
"error": "invalid operator",
"error_detail": {
"code": "RECON_RULE_INVALID",
"message": "invalid operator"
}
}
Need help?
We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.Was this page helpful?
⌘I
{
"name": "Default matcher",
"description": "Amount with 1% drift matcher",
"criteria": [
{
"field": "amount",
"operator": "equals",
"allowable_drift": 0.01
},
{
"field": "currency",
"operator": "equals"
},
{
"field": "date",
"operator": "equals",
"allowable_drift": 1800
},
{
"field": "reference",
"operator": "contains"
}
]
}
{
"error": "invalid operator",
"error_detail": {
"code": "RECON_RULE_INVALID",
"message": "invalid operator"
}
}