Klineo/Docs
Open app ↗
Documentation/API schemas

API schemas

TreasuryAssumptions

API v2·View Markdown ↗

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
schemaVersion Yes Constant treasury-dated-assumptions-v1 —
organizationId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
id Yes string Pattern: ^treasury_assumptions_[0-9a-f]{32}$
sequence Yes string Pattern: ^[1-9][0-9]{0,17}$
resourceVersion Yes string Pattern: ^0x[0-9a-f]{64}$
reconciliation Yes object Additional properties rejected
reconciliation.id Yes string Pattern: ^reconciliation_[0-9a-f]{32}$
reconciliation.resourceVersion Yes string Pattern: ^0x[0-9a-f]{64}$
ledgerEntryIds Yes Array of string Min items: 1; Max items: 256
unit Yes object Additional properties rejected
unit.chainId Yes integer Maximum: 9007199254740991; Exclusive minimum: 0
unit.genesisHash Yes string Pattern: ^0x[0-9a-f]{64}$
unit.asset Yes string Pattern: ^0x[0-9a-f]{40}$
unit.decimals Yes integer Minimum: 0; Maximum: 36
assumptions Yes object Additional properties rejected
assumptions.title Yes string Min length: 1; Max length: 200
assumptions.obligations Yes Array of object Max items: 256
assumptions.obligations[].id Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
assumptions.obligations[].economicKey Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
assumptions.obligations[].label Yes string Min length: 1; Max length: 2000
assumptions.obligations[].totalAmountAtomic Yes string Pattern: ^[1-9][0-9]{0,77}$
assumptions.obligations[].installments Yes Array of object Min items: 1; Max items: 256
assumptions.obligations[].installments[].id Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
assumptions.obligations[].installments[].dueDay Yes string Pattern: ^20[0-9]{2}-[0-9]{2}-[0-9]{2}$
assumptions.obligations[].installments[].amountAtomic Yes string Pattern: ^[1-9][0-9]{0,77}$
assumptions.conditionalInflows Yes Array of object Max items: 256
assumptions.conditionalInflows[].id Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
assumptions.conditionalInflows[].economicKey Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
assumptions.conditionalInflows[].label Yes string Min length: 1; Max length: 2000
assumptions.conditionalInflows[].expectedDay Yes string Pattern: ^20[0-9]{2}-[0-9]{2}-[0-9]{2}$
assumptions.conditionalInflows[].amountAtomic Yes string Pattern: ^[1-9][0-9]{0,77}$
assumptions.conditionalInflows[].condition Yes string Min length: 1; Max length: 2000
assumptions.allocations Yes Array of object Max items: 256
assumptions.allocations[].id Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
assumptions.allocations[].economicKey Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
assumptions.allocations[].label Yes string Min length: 1; Max length: 2000
assumptions.allocations[].day Yes string Pattern: ^20[0-9]{2}-[0-9]{2}-[0-9]{2}$
assumptions.allocations[].amountAtomic Yes string Pattern: ^[1-9][0-9]{0,77}$
assumptions.ledgerObligationCoverage Yes Array of object Max items: 256
assumptions.ledgerObligationCoverage[].ledgerObligationId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
assumptions.ledgerObligationCoverage[].relation Yes string Allowed: SCHEDULED_HERE, DECLARED_ALREADY_DEDUCTED, UNRESOLVED
assumptions.ledgerObligationCoverage[].scheduleIds Yes Array of string Max items: 256
assumptions.ledgerObligationCoverage[].note Yes string Min length: 1; Max length: 2000
assumptions.expenseCoverage Yes object Additional properties rejected
assumptions.expenseCoverage.declaration Yes string Allowed: DECLARED_COMPLETE, DECLARED_PARTIAL, UNKNOWN
assumptions.expenseCoverage.omittedCategories Yes Array of string Max items: 64
assumptions.expenseCoverage.note Yes string Min length: 1; Max length: 2000
provenance Yes Constant ISSUER_DECLARED_UNVERIFIED —
verifiedExpenseCoverage Yes Constant UNKNOWN —
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)))$
recordedBy 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)$
recordedAt 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/TreasuryAssumptions in the OpenAPI contract.

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