Get a reconciliation context

Use this endpoint to retrieve the details of a specific reconciliation context by its identifier.

GET /v1/contexts/{contextId}

Get a reconciliation context

cURL

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/contexts/{contextId} \
  --header 'Authorization: Bearer <token>'

200

{
  "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"
}

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.

Path Parameters

contextId · string · required

The unique identifier of the reconciliation context.

Response

200

application/json

Successfully retrieved context

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"