Klineo/Docs
Open app ↗

API reference

Treasury reconciliation

Paths on this page are relative to /api/liquidity-studio/v2. Authentication and required headers vary by operation.

API reference overview · OpenAPI download

Operations on this page#

Method Path Operation
POST /treasury/reconciliation-preview previewTreasuryReconciliation
GET /treasury/reconciliations listTreasuryReconciliations
POST /treasury/reconciliations createTreasuryReconciliation
GET /treasury/reconciliations/{id} getTreasuryReconciliation
GET /treasury/reconciliations/{id}/versions listTreasuryReconciliationVersions
GET /treasury/reconciliations/{id}/versions/{sequence} getTreasuryReconciliationVersion
POST /treasury/reconciliations/{id}/acknowledge acknowledgeTreasuryReconciliation

previewTreasuryReconciliation#

POST /treasury/reconciliation-preview

Operation ID: previewTreasuryReconciliation

Authentication: __Host-klineo_session cookie (sessionCookie)

Read-only preview for an interactive owner or treasury administrator. The server resolves the complete active ledger at its cutoff and exact tenant custody evidence references. Request mappings are assertions for review; no mapping is admitted, no financial authority is granted, and spendability remains unestablished. Quote-valued reservations cannot be used as token cash. A block balance does not establish an end-of-day opening snapshot. There is no idempotency key because no artifact or financial mutation is persisted.

Parameters#

Name Location Required Type Description and constraints
x-klineo-organization-id header Yes string —

Request body#

Required: yes.

application/json

TreasuryReconciliationPreviewRequest

Responses#

Status Description Content type and schema
200 Source-bound reconciliation candidate and explicit limitations. application/json: object
400 Invalid closed reference request. application/json: object
401 Interactive session required. application/json: object
403 Current interactive treasury role required. application/json: object
404 Referenced private evidence unavailable. application/json: object
412 Referenced source version differs from selected immutable records. application/json: object
429 Request limit exceeded. application/json: object
503 Source verification or reconciliation unavailable. application/json: object

200 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —
ETag Yes string Pattern: ^"0x[0-9a-f]{64}"$

200 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
data Yes TreasuryLedgerReconciliation —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

400 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

400 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

401 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

401 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

403 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

403 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

404 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

404 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

412 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

412 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

429 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

429 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

503 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

503 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

listTreasuryReconciliations#

GET /treasury/reconciliations

Operation ID: listTreasuryReconciliations

Authentication: __Host-klineo_session cookie (sessionCookie)

Interactive workspace access required. Writes require current treasury authority and recent authentication. Draft creation resolves source records on the server. Acknowledgment retains the exact candidate, checks current ledger and custody authority under locks, and records the actor and time. It confirms a mapping assertion only: no financial permission, unrestricted cash, or independent legacy custody identity verification. Historical records do not establish current applicability. Different saved mappings must not be added together as separate funds.

Parameters#

Name Location Required Type Description and constraints
x-klineo-organization-id header Yes string —
cursor query No string Pattern: ^reconciliation_[a-f0-9]{32}$
limit query No integer Default: 20; Minimum: 1; Maximum: 20

Responses#

Status Description Content type and schema
200 Private saved mapping or immutable history. Does not establish spendability. application/json: object
400 Invalid closed request or pagination. application/json: object
401 Interactive session and recent authentication for writes required. application/json: object
403 Current workspace authority required. application/json: object
404 Saved record unavailable. application/json: object
429 Request limit exceeded. application/json: object
503 Storage or source verification unavailable. application/json: object

200 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

200 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
data Yes TreasuryReconciliationList —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

400 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

400 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

401 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

401 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

403 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

403 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

404 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

404 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

429 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

429 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

503 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

503 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

createTreasuryReconciliation#

POST /treasury/reconciliations

Operation ID: createTreasuryReconciliation

Authentication: __Host-klineo_session cookie (sessionCookie)

Interactive workspace access required. Writes require current treasury authority and recent authentication. Draft creation resolves source records on the server. Acknowledgment retains the exact candidate, checks current ledger and custody authority under locks, and records the actor and time. It confirms a mapping assertion only: no financial permission, unrestricted cash, or independent legacy custody identity verification. Historical records do not establish current applicability. Different saved mappings must not be added together as separate funds.

Parameters#

Name Location Required Type Description and constraints
x-klineo-organization-id header Yes string —
Idempotency-Key header Yes string Pattern: ^[\x21-\x7E]+$; Min length: 8; Max length: 200

Request body#

Required: yes.

application/json

TreasuryReconciliationPreviewRequest

Responses#

Status Description Content type and schema
200 Private saved mapping or immutable history. Does not establish spendability. application/json: object
201 Private saved mapping or immutable history. Does not establish spendability. application/json: object
400 Invalid closed request or pagination. application/json: object
401 Interactive session and recent authentication for writes required. application/json: object
403 Current workspace authority required. application/json: object
404 Saved record unavailable. application/json: object
409 Request key already binds another request. application/json: object
412 Ledger or custody source is no longer current. application/json: object
429 Request limit exceeded. application/json: object
503 Storage or source verification unavailable. application/json: object

200 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —
ETag Yes string Pattern: ^"0x[0-9a-f]{64}"$

200 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
data Yes TreasuryReconciliationWrite —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

201 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —
ETag Yes string Pattern: ^"0x[0-9a-f]{64}"$

201 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
data Yes TreasuryReconciliationWrite —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

400 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

400 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

401 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

401 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

403 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

403 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

404 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

404 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

409 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

409 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

412 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

412 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

429 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

429 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

503 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

503 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

getTreasuryReconciliation#

GET /treasury/reconciliations/{id}

Operation ID: getTreasuryReconciliation

Authentication: __Host-klineo_session cookie (sessionCookie)

Interactive workspace access required. Writes require current treasury authority and recent authentication. Draft creation resolves source records on the server. Acknowledgment retains the exact candidate, checks current ledger and custody authority under locks, and records the actor and time. It confirms a mapping assertion only: no financial permission, unrestricted cash, or independent legacy custody identity verification. Historical records do not establish current applicability. Different saved mappings must not be added together as separate funds.

Parameters#

Name Location Required Type Description and constraints
x-klineo-organization-id header Yes string —
id path Yes string Pattern: ^reconciliation_[a-f0-9]{32}$

Responses#

Status Description Content type and schema
200 Private saved mapping or immutable history. Does not establish spendability. application/json: object
400 Invalid closed request or pagination. application/json: object
401 Interactive session and recent authentication for writes required. application/json: object
403 Current workspace authority required. application/json: object
404 Saved record unavailable. application/json: object
429 Request limit exceeded. application/json: object
503 Storage or source verification unavailable. application/json: object

200 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —
ETag Yes string Pattern: ^"0x[0-9a-f]{64}"$

200 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
data Yes SavedTreasuryReconciliation —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

400 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

400 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

401 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

401 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

403 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

403 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

404 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

404 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

429 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

429 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

503 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

503 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

listTreasuryReconciliationVersions#

GET /treasury/reconciliations/{id}/versions

Operation ID: listTreasuryReconciliationVersions

Authentication: __Host-klineo_session cookie (sessionCookie)

Interactive workspace access required. Writes require current treasury authority and recent authentication. Draft creation resolves source records on the server. Acknowledgment retains the exact candidate, checks current ledger and custody authority under locks, and records the actor and time. It confirms a mapping assertion only: no financial permission, unrestricted cash, or independent legacy custody identity verification. Historical records do not establish current applicability. Different saved mappings must not be added together as separate funds.

Parameters#

Name Location Required Type Description and constraints
x-klineo-organization-id header Yes string —
id path Yes string Pattern: ^reconciliation_[a-f0-9]{32}$
cursor query No string Pattern: ^[1-9][0-9]{0,17}$
limit query No integer Default: 20; Minimum: 1; Maximum: 20

Responses#

Status Description Content type and schema
200 Private saved mapping or immutable history. Does not establish spendability. application/json: object
400 Invalid closed request or pagination. application/json: object
401 Interactive session and recent authentication for writes required. application/json: object
403 Current workspace authority required. application/json: object
404 Saved record unavailable. application/json: object
429 Request limit exceeded. application/json: object
503 Storage or source verification unavailable. application/json: object

200 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

200 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
data Yes TreasuryReconciliationHistory —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

400 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

400 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

401 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

401 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

403 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

403 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

404 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

404 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

429 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

429 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

503 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

503 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

getTreasuryReconciliationVersion#

GET /treasury/reconciliations/{id}/versions/{sequence}

Operation ID: getTreasuryReconciliationVersion

Authentication: __Host-klineo_session cookie (sessionCookie)

Interactive workspace access required. Writes require current treasury authority and recent authentication. Draft creation resolves source records on the server. Acknowledgment retains the exact candidate, checks current ledger and custody authority under locks, and records the actor and time. It confirms a mapping assertion only: no financial permission, unrestricted cash, or independent legacy custody identity verification. Historical records do not establish current applicability. Different saved mappings must not be added together as separate funds.

Parameters#

Name Location Required Type Description and constraints
x-klineo-organization-id header Yes string —
id path Yes string Pattern: ^reconciliation_[a-f0-9]{32}$
sequence path Yes string Pattern: ^[1-9][0-9]{0,17}$

Responses#

Status Description Content type and schema
200 Private saved mapping or immutable history. Does not establish spendability. application/json: object
400 Invalid closed request or pagination. application/json: object
401 Interactive session and recent authentication for writes required. application/json: object
403 Current workspace authority required. application/json: object
404 Saved record unavailable. application/json: object
429 Request limit exceeded. application/json: object
503 Storage or source verification unavailable. application/json: object

200 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —
ETag Yes string Pattern: ^"0x[0-9a-f]{64}"$

200 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
data Yes SavedTreasuryReconciliation —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

400 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

400 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

401 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

401 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

403 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

403 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

404 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

404 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

429 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

429 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

503 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

503 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

acknowledgeTreasuryReconciliation#

POST /treasury/reconciliations/{id}/acknowledge

Operation ID: acknowledgeTreasuryReconciliation

Authentication: __Host-klineo_session cookie (sessionCookie)

Interactive workspace access required. Writes require current treasury authority and recent authentication. Draft creation resolves source records on the server. Acknowledgment retains the exact candidate, checks current ledger and custody authority under locks, and records the actor and time. It confirms a mapping assertion only: no financial permission, unrestricted cash, or independent legacy custody identity verification. Historical records do not establish current applicability. Different saved mappings must not be added together as separate funds.

Parameters#

Name Location Required Type Description and constraints
x-klineo-organization-id header Yes string —
id path Yes string Pattern: ^reconciliation_[a-f0-9]{32}$
Idempotency-Key header Yes string Pattern: ^[\x21-\x7E]+$; Min length: 8; Max length: 200
If-Match header Yes string Pattern: ^"0x[0-9a-f]{64}"$

Request body#

Required: yes.

application/json

object — Additional properties rejected

Field Required at this level Type Description and constraints
confirmation Yes Constant CONFIRM_LEDGER_CUSTODY_MAPPING —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Responses#

Status Description Content type and schema
200 Private saved mapping or immutable history. Does not establish spendability. application/json: object
400 Invalid closed request or pagination. application/json: object
401 Interactive session and recent authentication for writes required. application/json: object
403 Current workspace authority required. application/json: object
404 Saved record unavailable. application/json: object
409 Request identity conflict or mapping already acknowledged. application/json: object
412 Reviewed version or source authority changed. application/json: object
428 Strong exact If-Match required. application/json: object
429 Request limit exceeded. application/json: object
503 Storage or source verification unavailable. application/json: object

200 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —
ETag Yes string Pattern: ^"0x[0-9a-f]{64}"$

200 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
data Yes TreasuryReconciliationWrite —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

400 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

400 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

401 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

401 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

403 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

403 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

404 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

404 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

409 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

409 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

412 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

412 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

428 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

428 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

429 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

429 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

503 response headers

Header Required Type Description and constraints
Cache-Control Yes Constant private, no-store —

503 application/json body

object — Additional properties rejected

Field Required at this level Type Description and constraints
error Yes ApiError —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.