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 |
|---|---|---|
GET |
/treasury/projections |
listTreasuryProjections |
POST |
/treasury/projections |
createTreasuryProjection |
GET |
/treasury/projections/{id} |
getTreasuryProjection |
GET |
/treasury/summary |
getTreasurySummary |
listTreasuryProjections#
GET /treasury/projections
Operation ID: listTreasuryProjections
Authentication: __Host-klineo_session cookie (sessionCookie)
Uses exact saved assumption and acknowledged reconciliation versions. The server computes from a common block snapshot and declared restrictions; it never accepts caller balances or computed outputs. Snapshot-day unpaid schedules are included. Conditional funding stays separate. Historical source use does not claim current source applicability. Writes require recent interactive treasury authentication; reads require current workspace access.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
cursor |
query | No | string |
Pattern: ^treasury_projection_[a-f0-9]{32}$ |
limit |
query | No | integer |
Default: 20; Minimum: 1; Maximum: 20 |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Private immutable historical planning scenario. Does not establish current cash or spendability. | application/json: object |
400 |
Invalid or unsupported planning inputs. | application/json: object |
401 |
Interactive authentication required. | application/json: object |
403 |
Current workspace authority required. | application/json: object |
404 |
Saved source or scenario unavailable. | application/json: object |
429 |
Request limit exceeded. | application/json: object |
503 |
Storage or source integrity 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 | TreasuryProjectionList | — |
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.
createTreasuryProjection#
POST /treasury/projections
Operation ID: createTreasuryProjection
Authentication: __Host-klineo_session cookie (sessionCookie)
Uses exact saved assumption and acknowledged reconciliation versions. The server computes from a common block snapshot and declared restrictions; it never accepts caller balances or computed outputs. Snapshot-day unpaid schedules are included. Conditional funding stays separate. Historical source use does not claim current source applicability. Writes require recent interactive treasury authentication; reads require current workspace access.
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
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Private immutable historical planning scenario. Does not establish current cash or spendability. | application/json: object |
201 |
Private immutable historical planning scenario. Does not establish current cash or spendability. | application/json: object |
400 |
Invalid or unsupported planning inputs. | application/json: object |
401 |
Interactive authentication required. | application/json: object |
403 |
Current workspace authority required. | application/json: object |
404 |
Saved source or scenario unavailable. | application/json: object |
409 |
Request key already binds another scenario. | application/json: object |
412 |
Exact saved source binding differs. | application/json: object |
429 |
Request limit exceeded. | application/json: object |
503 |
Storage or source integrity 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 | TreasuryProjectionWrite | — |
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 | TreasuryProjectionWrite | — |
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.
getTreasuryProjection#
GET /treasury/projections/{id}
Operation ID: getTreasuryProjection
Authentication: __Host-klineo_session cookie (sessionCookie)
Uses exact saved assumption and acknowledged reconciliation versions. The server computes from a common block snapshot and declared restrictions; it never accepts caller balances or computed outputs. Snapshot-day unpaid schedules are included. Conditional funding stays separate. Historical source use does not claim current source applicability. Writes require recent interactive treasury authentication; reads require current workspace access.
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
id |
path | Yes | string |
Pattern: ^treasury_projection_[a-f0-9]{32}$ |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Private immutable historical planning scenario. Does not establish current cash or spendability. | application/json: object |
400 |
Invalid or unsupported planning inputs. | application/json: object |
401 |
Interactive authentication required. | application/json: object |
403 |
Current workspace authority required. | application/json: object |
404 |
Saved source or scenario unavailable. | application/json: object |
429 |
Request limit exceeded. | application/json: object |
503 |
Storage or source integrity 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 | TreasuryProjection | — |
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.
Get reconciled treasury ledger summary#
GET /treasury/summary
Operation ID: getTreasurySummary
Authentication: __Host-klineo_session cookie (sessionCookie)
Parameters#
| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
x-klineo-organization-id |
header | Yes | string |
— |
Responses#
| Status | Description | Content type and schema |
|---|---|---|
200 |
Conserved treasury summary | application/json: object |
200 application/json body
object — Additional properties rejected
| Field | Required at this level | Type | Description and constraints |
|---|---|---|---|
data |
Yes | TreasurySummary | — |
Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.