v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Configuration Sources

Update a reconciliation source

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

patch/v1/contexts/{contextId}/sources/{sourceId}

Path parameters

contextIdstring required

The unique identifier of the reconciliation context.

sourceIdstring required

The unique identifier of the reconciliation source.

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'LEDGER' | 'BANK' | 'GATEWAY' | 'CUSTOM' | 'FETCHER'

Category of data source for reconciliation

side'LEFT' | 'RIGHT'

Side of the reconciliation this source feeds

configobject

Example request

{
  "name": "Secondary Bank Account",
  "side": "RIGHT"
}

Response

Successfully updated source.

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

contextIdstring