Klineo/Docs
Open app ↗
Documentation/API schemas

API schemas

TreasuryProjection

API v2·View Markdown ↗

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
schemaVersion Yes Constant treasury-declared-projection-v1 —
organizationId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
id Yes string Pattern: ^treasury_projection_[0-9a-f]{32}$
resourceVersion Yes string Pattern: ^0x[0-9a-f]{64}$
request Yes object Additional properties rejected
request.assumptions Yes object Additional properties rejected
request.assumptions.id Yes string Pattern: ^treasury_assumptions_[0-9a-f]{32}$
request.assumptions.resourceVersion Yes string Pattern: ^0x[0-9a-f]{64}$
request.throughDay Yes string Pattern: ^20[0-9]{2}-[0-9]{2}-[0-9]{2}$
request.restrictions Yes Array of object Min items: 1; Max items: 256
request.restrictions[].ledgerEntryId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
request.restrictions[].restrictedAmountAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,77})$
request.restrictions[].reason Yes string Min length: 1; Max length: 2000
request.confirmation Yes Constant UNPAID_SCHEDULES_AND_RESTRICTIONS_EXCLUDE_THEM —
result Yes object Additional properties rejected
result.schemaVersion Yes Constant treasury-snapshot-projection-model-v1 —
result.organizationId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
result.assumptions Yes object Additional properties rejected
result.assumptions.id Yes string Pattern: ^treasury_assumptions_[0-9a-f]{32}$
result.assumptions.resourceVersion Yes string Pattern: ^0x[0-9a-f]{64}$
result.reconciliation Yes object Additional properties rejected
result.reconciliation.id Yes string Pattern: ^reconciliation_[0-9a-f]{32}$
result.reconciliation.resourceVersion Yes string Pattern: ^0x[0-9a-f]{64}$
result.request Yes object Additional properties rejected
result.request.assumptions Yes object Additional properties rejected
result.request.assumptions.id Yes string Pattern: ^treasury_assumptions_[0-9a-f]{32}$
result.request.assumptions.resourceVersion Yes string Pattern: ^0x[0-9a-f]{64}$
result.request.throughDay Yes string Pattern: ^20[0-9]{2}-[0-9]{2}-[0-9]{2}$
result.request.restrictions Yes Array of object Min items: 1; Max items: 256
result.request.restrictions[].ledgerEntryId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
result.request.restrictions[].restrictedAmountAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,77})$
result.request.restrictions[].reason Yes string Min length: 1; Max length: 2000
result.request.confirmation Yes Constant UNPAID_SCHEDULES_AND_RESTRICTIONS_EXCLUDE_THEM —
result.sourceBlock Yes object Additional properties rejected
result.sourceBlock.number Yes string Pattern: ^(0|[1-9][0-9]{0,77})$
result.sourceBlock.hash Yes string Pattern: ^0x[0-9a-f]{64}$
result.sourceBlock.timestamp Yes string Format: date-time; Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
result.sourceCutoff Yes string Format: date-time; Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
result.unit Yes object Additional properties rejected
result.unit.chainId Yes integer Maximum: 9007199254740991; Exclusive minimum: 0
result.unit.genesisHash Yes string Pattern: ^0x[0-9a-f]{64}$
result.unit.asset Yes string Pattern: ^0x[0-9a-f]{40}$
result.unit.decimals Yes integer Minimum: 0; Maximum: 36
result.openingDay Yes string Pattern: ^20[0-9]{2}-[0-9]{2}-[0-9]{2}$
result.throughDay Yes string Pattern: ^20[0-9]{2}-[0-9]{2}-[0-9]{2}$
result.opening Yes object Additional properties rejected
result.opening.availableMappedAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,80})$
result.opening.declaredRestrictedAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,80})$
result.opening.scenarioBalanceAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,80})$
result.selectedMappings Yes Array of object Min items: 1; Max items: 256
result.selectedMappings[].ledgerEntryId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
result.selectedMappings[].ledgerResourceVersion Yes string Pattern: ^0x[0-9a-f]{64}$
result.selectedMappings[].custodyEvidenceId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
result.selectedMappings[].custodyResourceVersion Yes string Pattern: ^0x[0-9a-f]{64}$
result.selectedMappings[].ledgerState Yes string Allowed: AVAILABLE, DEPLOYED, LOCKED, AT_RISK, FEE_GENERATING
result.selectedMappings[].ledgerAmountAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,77})$
result.selectedMappings[].declaredRestrictedAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,77})$
result.selectedMappings[].restrictionReason Yes string Min length: 1; Max length: 2000
result.selectedMappings[].includedInOpening Yes boolean —
result.selectedMappings[].disposition Yes string Allowed: AVAILABLE_DECLARED_SCENARIO, NON_AVAILABLE_EXCLUDED
result.timeline Yes Array of object Min items: 1; Max items: 365
result.timeline[].day Yes string Pattern: ^20[0-9]{2}-[0-9]{2}-[0-9]{2}$
result.timeline[].actualInflowsAtomic Yes Constant 0 —
result.timeline[].obligationsAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,80})$
result.timeline[].allocationsAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,80})$
result.timeline[].conditionalInflowsAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,80})$
result.timeline[].closingBaselineAtomic Yes string Pattern: ^(0|-?[1-9][0-9]{0,80})$
result.timeline[].cumulativeConditionalAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,80})$
result.timeline[].closingConditionalScenarioAtomic Yes string Pattern: ^(0|-?[1-9][0-9]{0,80})$
result.excludedEvents Yes Array of object Max items: 256
result.excludedEvents[].id Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
result.excludedEvents[].kind Yes string Allowed: OBLIGATION, ALLOCATION, CONDITIONAL_INFLOW
result.excludedEvents[].day Yes string Pattern: ^20[0-9]{2}-[0-9]{2}-[0-9]{2}$
result.excludedEvents[].amountAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,77})$
result.excludedEvents[].reason Yes Constant AFTER_HORIZON —
result.firstShortfallDay Yes At least one of: string; null —
result.minimumBaselineAtomic Yes string Pattern: ^(0|-?[1-9][0-9]{0,80})$
result.closingBaselineAtomic Yes string Pattern: ^(0|-?[1-9][0-9]{0,80})$
result.conditionalInflowsAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,80})$
result.closingConditionalScenarioAtomic Yes string Pattern: ^(0|-?[1-9][0-9]{0,80})$
result.declaredExpenseCoverage Yes object Additional properties rejected
result.declaredExpenseCoverage.declaration Yes string Allowed: DECLARED_COMPLETE, DECLARED_PARTIAL, UNKNOWN
result.declaredExpenseCoverage.omittedCategories Yes Array of string Max items: 64
result.declaredExpenseCoverage.note Yes string Min length: 1; Max length: 2000
result.provenance Yes Constant DECLARED_SCENARIO —
result.verifiedExpenseCoverage Yes Constant UNKNOWN —
result.spendability Yes Constant NOT_ESTABLISHED —
result.financialAuthority Yes Constant false —
result.limitations Yes Array of string Min items: 9; Max items: 9
result.modelHash Yes string Pattern: ^0x[0-9a-f]{64}$
sourceHash Yes string Pattern: ^0x[0-9a-f]{64}$
createdBy Yes string Format: uuid; Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
createdAt Yes string Format: date-time; Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
spendability Yes Constant NOT_ESTABLISHED —
financialAuthority Yes Constant false —

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

Exact definition: #/components/schemas/TreasuryProjection in the OpenAPI contract.

↑ ↓ to navigate · Enter to open · Esc to close