The Custody Position Snapshot object
Immutable dated customer securities and actual cash source, separate from bank assets and insured deposits.
Attributes
actorstringRequiredcaptured_atstring · date-timeRequiredcontent_sha256stringRequiredidstringRequiredsnapshotobjectRequired9 child attributes
blockersarray of stringsRequiredcaptured_atstring · date-timeRequireddistributionsarray of objectsRequired3 child attributes
blockersarray of stringsRequiredcashobject or nullOptionalCashObservation is a read of the actual ledger's immutable command digest and permanent claim, alongside its retained exact command. It is not broker cash.
6 child attributes
claim_keystringRequiredcommitted_atstring · date-timeRequiredjournalobjectRequiredJournal excludes ledger-assigned identity/time and separately authenticated actors. Entry order is part of the instruction, matching the ledger replay fingerprint.
journal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
journal_sha256stringRequiredposting_datestring · dateRequiredA business date, YYYY-MM-DD
distributionobjectRequired12 child attributes
accounting_plan_sha256stringOptionalaccounting_plansarray of objectsOptionalactorstringRequiredcreated_atstring · date-timeRequiredexceptionsarray of stringsRequiredidstringRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
posting_datestring · date or nullOptionalA business date, YYYY-MM-DD
receiptobjectRequiredDistribution is actual external cash evidence. Neither a forecast dividend nor a reached Treasury maturity date authorizes a customer credit.
request_sha256stringRequiredresolutionsarray of objectsOptionalstatusstringRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
observation_datestring · dateRequiredA business date, YYYY-MM-DD
ordersarray of objectsRequired4 child attributes
blockersarray of stringsRequiredcashobject or nullOptionalCashObservation is a read of the actual ledger's immutable command digest and permanent claim, alongside its retained exact command. It is not broker cash.
6 child attributes
claim_keystringRequiredcommitted_atstring · date-timeRequiredjournalobjectRequiredJournal excludes ledger-assigned identity/time and separately authenticated actors. Entry order is part of the instruction, matching the ledger replay fingerprint.
journal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
journal_sha256stringRequiredposting_datestring · dateRequiredA business date, YYYY-MM-DD
orderobjectRequired26 child attributes
accounting_plan_sha256stringOptionalaccounting_plansarray of objectsOptionalactorstringRequiredcash_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
created_atstring · date-timeRequiredcustody_accountobjectRequiredcustomer_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
decisionobject or nullOptionalexceptionsarray of stringsRequiredexecutionobject or nullOptionalidstringRequiredinstructionobject or nullOptionalInstruction is the bank's immutable, independently reviewed command. Signed execution and settlement evidence attest its exact digest; an ACK is no fill.
instrumentobjectRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
lot_idstringOptionallot_revisionintegerOptionalposting_datestring · date or nullOptionalA business date, YYYY-MM-DD
programobjectRequiredrequestobjectRequiredrequest_sha256stringRequiredresolutionsarray of objectsOptionalscreening_atstring · date-time or nullOptionalscreening_idsarray of stringsOptionalsettlementobject or nullOptionalsourceobjectRequiredstatusstringRequiredreserved_cash_amountintegerRequiredpositionsarray of objectsRequired7 child attributes
accrued_income_amountinteger or nullOptionalactual_unitsintegerRequiredblockersarray of stringsRequiredlotobjectRequired24 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
acquired_datestring · dateRequiredA business date, YYYY-MM-DD
actual_proceeds_amountinteger or nullOptionaldisposal_distribution_idstringOptionaldisposal_order_idstringOptionalexceptionsarray of stringsRequiredexternal_account_referencestringRequiredidstringRequiredinstrumentobjectRequiredinstrument_idstringRequiredjournal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
latest_observationobject or nullOptionaloriginal_cost_amountintegerRequiredActual BUY net cash, including fees
owner_idstringRequiredprogramobjectRequiredpurchase_order_idstringRequiredreservation_revisionintegerOptionalreserved_distribution_idstringOptionalreserved_order_idstringOptionalrevisionintegerRequiredsettlement_sha256stringRequiredstatusstringRequiredActive, selling, maturing, sold, matured, exception
tax_basis_amountinteger or nullOptionalUnknown unless actual custody source supplies it
unitsintegerRequiredOriginal whole-lot quantity; never mutated by a sale
market_value_amountinteger or nullOptionaltax_basis_amountinteger or nullOptionalvalues_as_ofstring · date or nullOptionalA business date, YYYY-MM-DD
readybooleanRequiredsource_sha256stringRequired