Update a match rule

Use this endpoint to update the fields of a specific match rule by its identifier.

PATCH /v1/contexts/{contextId}/rules/{ruleId}

Update a match rule

cURL

curl --request PATCH \
  --url https://matcher.sandbox.lerian.net/v1/contexts/{contextId}/rules/{ruleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {},
  "priority": 2,
  "type": "TOLERANCE"
}
'

200

Example

{
  "config": {},
  "contextId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2025-01-15T10:30:00Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "priority": 1,
  "type": "EXACT",
  "updatedAt": "2025-01-15T10:30:00Z"
}

Autorizaciones

Authorization · string · header · requerido

Bearer token authentication (format: "Bearer {token}")

Encabezados

X-Request-Id · string

A unique identifier for tracing the request across services.

X-Idempotency · string

Optional idempotency key for safe retries. Matcher reads the key only from this header, and only when you send one. A request that carries a key only in X-Idempotency-Key or Idempotency-Key is refused with 400 (MTCH-0015), and nothing is processed. If the same key is sent again and the original request was already processed, the stored response is returned with X-Idempotency-Replayed: true. A malformed key returns 400, a key whose first request is still in progress returns 409 (MTCH-0018), a key whose earlier attempt already ran but whose answer cannot be replayed returns 409 (MTCH-0022), and an idempotency storage failure returns 500. POST, PUT, PATCH and DELETE requests accept the header. These refusals are problem documents.

Parámetros de ruta

contextId · string<uuid> · requerido

The unique identifier of the reconciliation context. Context ID

ruleId · string<uuid> · requerido

The unique identifier of the match rule. Rule ID

Cuerpo

application/json

Match rule updates

config · object

Rule-specific configuration object. Includes the built-in toggles (matchAmount, matchCurrency, matchDate, matchReference) and tolerance/lag parameters, plus an optional composite-key array matchFields: [{ field, mode, tolerance? }] where mode is one of required, conditional, or off, and tolerance is an optional per-field relaxation ({ absTolerance?, percentTolerance? } for numeric or { stringMode: exact|fold } for text). Optional date keys (opt-in; default behavior is raw UTC days): timezone (an IANA zone name, e.g. America/Sao_Paulo, buckets dates by local sales-day before the date window/lag is applied), calendar (a vendored business-day calendar name, US_FED or BR_ANBIMA — on TOLERANCE it makes dateWindowDays count business days; on DATE_LAG it pairs with businessDayMode), and businessDayMode (DATE_LAG only; makes minDays/maxDays count business days under calendar). Optional signMode key (one of same, opposite, ignore; default same) selects the axis used when the rule compares amounts: same matches signed amounts (legacy behavior); opposite matches a value against its negation (a -100 refund reconciles against a +100 charge); ignore compares magnitudes only. It is consulted only when the rule actually compares amounts (matchAmount on EXACT/FUZZY, the tolerance band on TOLERANCE); on a rule that does not compare amounts it is accepted but inert.

Show child attributes

priority · integer<int64>

Execution priority; lower numbers run first. Must remain unique within the context.

Rango requerido: 1 <= x <= 1000

Ejemplo:

2

type · enum<string>

Matching strategy. EXACT requires identical field values; TOLERANCE allows configured numeric slack; DATE_LAG allows a configured date offset between sides; FUZZY matches on normalized/similarity-scored references (free-text memos, truncated refs) and always proposes for review (never auto-confirms).

Opciones disponibles: EXACT, TOLERANCE, DATE_LAG, FUZZY

Ejemplo:

"TOLERANCE"

Respuesta

200

application/json

Successfully updated match rule.

config · object · requerido

Rule-specific configuration object (matched fields and tolerance/lag parameters).

Show child attributes

contextId · string · requerido

Identifier of the context this rule belongs to.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

createdAt · string · requerido

Creation timestamp in RFC 3339 format.

Ejemplo:

"2025-01-15T10:30:00Z"

id · string · requerido

Unique identifier of the rule.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

priority · integer<int64> · requerido

Execution priority; lower numbers run first.

Rango requerido: 1 <= x <= 1000

Ejemplo:

1

type · enum<string> · requerido

Matching strategy. EXACT requires identical field values; TOLERANCE allows configured numeric slack; DATE_LAG allows a configured date offset between sides; FUZZY matches on normalized/similarity-scored references and always proposes for review.

Opciones disponibles: EXACT, TOLERANCE, DATE_LAG, FUZZY

Ejemplo:

"EXACT"

updatedAt · string · requerido

Last update timestamp in RFC 3339 format.

Ejemplo:

"2025-01-15T10:30:00Z"