Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Configuration Contexts

Update a reconciliation context

Use this endpoint to update the fields of a specific reconciliation context by its identifier.

patch/v1/contexts/{contextId}

Path parameters

contextIdstring required

The unique identifier of the reconciliation context.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

X-Idempotency-Keystring

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.

Request body

namestring
type'1:1' | '1:N' | 'N:M'

Reconciliation topology (cardinality between sources)

intervalstring
status'DRAFT' | 'ACTIVE' | 'PAUSED' | 'ARCHIVED'

Lifecycle status of a reconciliation context

feeToleranceAbsstring

Absolute fee tolerance amount

feeTolerancePctstring

Percentage fee tolerance

feeNormalization'NET' | 'GROSS'

Fee normalization mode

autoMatchOnUploadboolean

Whether to trigger matching automatically after file upload

Example request

{
  "name": "Bank Reconciliation Q2",
  "interval": "weekly",
  "feeToleranceAbs": "0.01",
  "feeTolerancePct": "0.5",
  "feeNormalization": "NET"
}

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.

idstring

Unique identifier for the context

tenantIdstring

Tenant ID this context belongs to

namestring

Name of the reconciliation context

type'1:1' | '1:N' | 'N:M'

Reconciliation topology type

intervalstring

Execution interval

status'DRAFT' | 'ACTIVE' | 'PAUSED' | 'ARCHIVED'

Current status of the context

feeToleranceAbsstring

Absolute fee tolerance amount

feeTolerancePctstring

Percentage fee tolerance

feeNormalization'NET' | 'GROSS'

Fee normalization mode

autoMatchOnUploadboolean

Whether matching triggers automatically after file upload

createdAtstring

Creation timestamp in RFC3339 format

updatedAtstring

Last update timestamp in RFC3339 format

Example response

{
  "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",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}