Klineo/Docs
Open app ↗
Documentation/API schemas

API schemas

TreasuryReconciliationList

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-reconciliation-draft-v1 —
items[].organizationId Yes string Min length: 1
items[].id Yes string Pattern: ^reconciliation_[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[].state Yes string Allowed: DRAFT, ACKNOWLEDGED
items[].candidate Yes object Additional properties rejected
items[].candidate.schemaVersion Yes Constant treasury-ledger-custody-reconciliation-candidate-v1 —
items[].candidate.organizationId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
items[].candidate.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)))$
items[].candidate.status Yes Constant REVIEW_CANDIDATE —
items[].candidate.mappings Yes Array of object Min items: 1; Max items: 256
items[].candidate.mappings[].ledger Yes object Additional properties rejected
items[].candidate.mappings[].ledger.recordId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
items[].candidate.mappings[].ledger.resourceVersion Yes string Pattern: ^0x[0-9a-f]{64}$
items[].candidate.mappings[].ledger.artifactHash Yes string Pattern: ^0x[0-9a-f]{64}$
items[].candidate.mappings[].custody Yes object Additional properties rejected
items[].candidate.mappings[].custody.evidenceId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
items[].candidate.mappings[].custody.resourceVersion Yes string Pattern: ^0x[0-9a-f]{64}$
items[].candidate.mappings[].capitalContainerId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
items[].candidate.mappings[].declaredCustodyLocationId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
items[].candidate.mappings[].declaredSource Yes object Additional properties rejected
items[].candidate.mappings[].declaredSource.kind Yes string Allowed: SAFE, VAULT, EXTERNAL_MANAGER
items[].candidate.mappings[].declaredSource.id Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
items[].candidate.mappings[].unit Yes object Additional properties rejected
items[].candidate.mappings[].unit.chainId Yes integer Maximum: 9007199254740991; Exclusive minimum: 0
items[].candidate.mappings[].unit.genesisHash Yes string Pattern: ^0x[0-9a-f]{64}$
items[].candidate.mappings[].unit.asset Yes string Pattern: ^0x[0-9a-f]{40}$
items[].candidate.mappings[].unit.decimals Yes integer Minimum: 0; Maximum: 36
items[].candidate.mappings[].custodyAccount Yes string Pattern: ^0x[0-9a-f]{40}$
items[].candidate.mappings[].relationship Yes object Additional properties rejected
items[].candidate.mappings[].relationship.id Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
items[].candidate.mappings[].relationship.resourceVersion Yes string Pattern: ^0x[0-9a-f]{64}$
items[].candidate.mappings[].relationship.evidenceHash Yes string Pattern: ^0x[0-9a-f]{64}$
items[].candidate.mappings[].projectId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
items[].candidate.mappings[].block Yes object Additional properties rejected
items[].candidate.mappings[].block.number Yes string Pattern: ^(0|[1-9][0-9]{0,77})$
items[].candidate.mappings[].block.hash Yes string Pattern: ^0x[0-9a-f]{64}$
items[].candidate.mappings[].block.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)))$
items[].candidate.mappings[].ledgerAmountAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,77})$
items[].candidate.mappings[].observedCustodyAmountAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,77})$
items[].candidate.mappings[].unallocatedCustodySurplusAtomic Yes string Pattern: ^(0|[1-9][0-9]{0,77})$
items[].candidate.mappings[].ledgerState Yes string Allowed: AVAILABLE, DEPLOYED, LOCKED, AT_RISK, FEE_GENERATING
items[].candidate.mappings[].committedQuoteValuation Yes string Pattern: ^(0|[1-9][0-9]{0,77})$
items[].candidate.mappings[].obligationIds Yes Array of string Max items: 256
items[].candidate.mappings[].disposition Yes Constant PROPOSED_MAPPING_REQUIRES_ADMISSION —
items[].candidate.sourceBindings Yes object Additional properties rejected
items[].candidate.sourceBindings.ledger Yes Array of object Min items: 1; Max items: 256
items[].candidate.sourceBindings.ledger[].recordId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
items[].candidate.sourceBindings.ledger[].resourceVersion Yes string Pattern: ^0x[0-9a-f]{64}$
items[].candidate.sourceBindings.ledger[].artifactHash Yes string Pattern: ^0x[0-9a-f]{64}$
items[].candidate.sourceBindings.custody Yes Array of object Min items: 1; Max items: 256
items[].candidate.sourceBindings.custody[].evidenceId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
items[].candidate.sourceBindings.custody[].resourceVersion Yes string Pattern: ^0x[0-9a-f]{64}$
items[].candidate.sourceHash Yes string Pattern: ^0x[0-9a-f]{64}$
items[].candidate.candidateHash Yes string Pattern: ^0x[0-9a-f]{64}$
items[].candidate.ledgerConservation Yes object Additional properties rejected
items[].candidate.ledgerConservation.scope Yes Constant SUPPLIED_IMMUTABLE_ENTRIES_ONLY —
items[].candidate.ledgerConservation.ledgerVersion Yes string Allowed: treasury-ledger-v1, treasury-ledger-v2
items[].candidate.ledgerConservation.conserved Yes Constant true —
items[].candidate.ledgerConservation.commitment Yes string Pattern: ^0x[0-9a-f]{64}$
items[].candidate.omittedLedgerEntryIds Yes Array of string Max items: 256
items[].candidate.omittedCustodyEvidenceIds Yes Array of string Max items: 256
items[].candidate.limitations Yes Array of Not specified —
items[].candidate.spendability Yes Constant NOT_ESTABLISHED —
items[].candidate.expenseCoverage Yes Constant UNKNOWN —
items[].candidate.financialAuthority Yes Constant false —
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[].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[].acknowledgment Yes At least one of: object; null —
items[].acknowledgment.anyOf[1].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[].acknowledgment.anyOf[1].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/TreasuryReconciliationList in the OpenAPI contract.

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