Skip to main content
PATCH
/
v1
/
contexts
/
{contextId}
Update a reconciliation context
curl --request PATCH \
  --url https://matcher.sandbox.lerian.net/v1/contexts/{contextId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Bank Reconciliation Q2",
  "type": "1:N",
  "interval": "weekly",
  "status": "ACTIVE",
  "feeToleranceAbs": "0.01",
  "feeTolerancePct": "0.5",
  "feeNormalization": "NET",
  "autoMatchOnUpload": false
}
'
{
  "id": "019c96a0-10a0-72d2-9fb0-2b7de8093182",
  "tenantId": "019c96a0-0a98-7287-9a31-786e0809c769",
  "name": "Bank Reconciliation Q1",
  "type": "1:1",
  "interval": "daily",
  "status": "ACTIVE",
  "feeToleranceAbs": "0.50",
  "feeTolerancePct": "0.01",
  "feeNormalization": "NET",
  "autoMatchOnUpload": false,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Request-Id
string

A unique identifier for tracing the request across services.

​
X-Idempotency-Key
string

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Path Parameters

​
contextId
string
required

The unique identifier of the reconciliation context.

Body

application/json

Context updates

​
name
string
Maximum string length: 100
Example:

"Bank Reconciliation Q2"

​
type
enum<string>

Reconciliation topology (cardinality between sources)

Available options:
1:1,
1:N,
N:M
Example:

"1:N"

​
interval
string
Maximum string length: 100
Example:

"weekly"

​
status
enum<string>

Lifecycle status of a reconciliation context

Available options:
DRAFT,
ACTIVE,
PAUSED,
ARCHIVED
Example:

"ACTIVE"

​
feeToleranceAbs
string

Absolute fee tolerance amount

Example:

"0.01"

​
feeTolerancePct
string

Percentage fee tolerance

Example:

"0.5"

​
feeNormalization
enum<string>

Fee normalization mode

Available options:
NET,
GROSS
Example:

"NET"

​
autoMatchOnUpload
boolean

Whether to trigger matching automatically after file upload

Example:

false

Response

Successfully updated context.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

Configuration context for matching rules

​
id
string

Unique identifier for the context

Example:

"019c96a0-10a0-72d2-9fb0-2b7de8093182"

​
tenantId
string

Tenant ID this context belongs to

Example:

"019c96a0-0a98-7287-9a31-786e0809c769"

​
name
string

Name of the reconciliation context

Example:

"Bank Reconciliation Q1"

​
type
enum<string>

Reconciliation topology type

Available options:
1:1,
1:N,
N:M
Example:

"1:1"

​
interval
string

Execution interval

Example:

"daily"

​
status
enum<string>

Current status of the context

Available options:
DRAFT,
ACTIVE,
PAUSED,
ARCHIVED
Example:

"ACTIVE"

​
feeToleranceAbs
string

Absolute fee tolerance amount

Example:

"0.50"

​
feeTolerancePct
string

Percentage fee tolerance

Example:

"0.01"

​
feeNormalization
enum<string>

Fee normalization mode

Available options:
NET,
GROSS
Example:

"NET"

​
autoMatchOnUpload
boolean

Whether matching triggers automatically after file upload

Example:

false

​
createdAt
string

Creation timestamp in RFC3339 format

Example:

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

​
updatedAt
string

Last update timestamp in RFC3339 format

Example:

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