v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Configuration Contexts

Clone a reconciliation context

Use this endpoint to clone an existing reconciliation context with its associated sources, rules, and fee schedules. You can selectively include or exclude specific components.

post/v1/contexts/{contextId}/clone

Path parameters

contextIdstring required

The unique identifier of the reconciliation context to clone.

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 required

Name for the cloned context

includeSourcesboolean

Whether to clone associated sources

includeRulesboolean

Whether to clone associated match rules

Example request

{
  "name": "Q1 2025 Reconciliation (Copy)"
}

Response

Successfully cloned 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.

sourcesClonedinteger

Number of sources cloned

rulesClonedinteger

Number of match rules cloned

fieldMapsClonedinteger

Number of field maps cloned

feeRulesClonedinteger

Number of fee rules cloned

Example response

{
  "context": {
    "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"
  },
  "sourcesCloned": 3,
  "rulesCloned": 5,
  "fieldMapsCloned": 3,
  "feeRulesCloned": 2
}