Klineo/Docs
Open app ↗
Documentation/API schemas

API schemas

TreasuryAssumptionsList

API v2·View Markdown ↗

All API schemas

object — Additional properties rejected

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

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/TreasuryAssumptionsList in the OpenAPI contract.

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