The Bank Securities Snapshot object
Snapshot is a complete internal source digest, not a substitute for checking the signed external evidence and actual journals that every position retains.
Attributes
blockersarray of stringsRequiredbusiness_datestring · dateRequiredA business date, YYYY-MM-DD
captured_atstring · date-timeRequiredcash_evidencearray of objectsRequired8 child attributes
actual_datestring · dateRequiredA business date, YYYY-MM-DD
journal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
kindstringRequiredproofobjectRequired7 child attributes
journalobjectRequired6 child attributes
delta_amountintegerRequiredeffective_datestring · dateRequiredA business date, YYYY-MM-DD
idstringRequiredsha256stringRequiredsource_referencestringRequiredsource_servicestringRequiredline_keystringRequiredmatch_idstringRequiredreadybooleanRequiredstatement_datestring · dateRequiredA business date, YYYY-MM-DD
statement_idstringRequiredstatement_sha256stringRequiredreadybooleanRequiredreceipt_sha256stringRequiredsigned_delta_amountintegerRequiredsource_idstringRequiredcontent_sha256stringRequireddealer_checksarray of objectsRequired4 child attributes
external_dealer_referencestringRequiredobservationobjectRequiredRegistryObservation is a current read of the latest independently reviewed classification and the customer's unchanged authoritative identity source. It is an observation, not a distributed fence on later ownership changes.
4 child attributes
content_sha256stringRequiredcustomer_sha256stringRequiredobserved_atstring · date-timeRequiredrecordobjectRequired13 child attributes
collateralobject or nullOptionalCollateralAdjustmentRequest adds cash to an existing commitment's collateral. Amount is the additional pledge, not a replacement for the original pledge.
content_sha256stringRequiredcustomer_sha256stringOptionalcustomer_snapshotobjectOptionaldecisionobject or nullOptionalidstringRequiredkindstringRequiredplanobject or nullOptionalpolicyobject or nullOptionalproposed_atstring · date-timeRequiredproposed_bystringRequiredregistryobject or nullOptionalreleaseobject or nullOptionalorder_idstringRequiredstagestringRequiredencumbrancesarray of objectsRequired5 child attributes
content_sha256stringRequireddocumentobjectRequiredkindstringRequiredlot_idstringRequiredsource_idstringRequiredidstringRequiredjournalsarray of objectsRequired8 child attributes
approved_bystringRequiredcommitted_atstring · date-timeRequiredidstringRequiredidempotency_keystringRequiredjournalobjectRequiredJournal excludes ledger-assigned identity/time and separately authenticated actors. Entry order is part of the instruction, matching the ledger replay fingerprint.
11 child attributes
adjusts_periodstringOptionaleffective_datestring · dateRequiredA business date, YYYY-MM-DD
entriesarray of objectsRequired4 child attributes
amountintegerRequiredcurrency_codestringRequireddirectionstringRequiredledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
kindstringRequiredprotected_command_idstringRequiredreasonstringOptionalrelease_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
require_availablebooleanOptionalreversal_ofstringOptionalsource_refstringRequiredsource_servicestringRequiredjournal_sha256stringRequiredposted_bystringRequiredposting_datestring · dateRequiredA business date, YYYY-MM-DD
legal_entitystringRequiredlotsarray of objectsRequired33 child attributes
accrued_to_datestring · date or nullOptionalExclusive start boundary; closing D requires D+1
actual_proceeds_amountinteger or nullOptionalcash_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
disposal_cash_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
disposal_datestring · date or nullOptionalA business date, YYYY-MM-DD
disposal_execution_sha256stringOptionaldisposal_order_idstringOptionaldisposal_settlement_datestring · date or nullOptionalA business date, YYYY-MM-DD
disposal_settlement_sha256stringOptionaldisposal_trade_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
exceptionsarray of stringsRequiredexecution_sha256stringRequiredexternal_account_referencestringRequiredidstringRequiredinstrumentobjectRequired9 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcustody_accountobject or nullOptional18 child attributes
bank_ownedbooleanRequiredcustodian_referencestringRequiredenabledbooleanRequiredexclusive_core_instructionsbooleanRequiredexternal_account_referencestringRequiredkey_idstringRequiredlegal_entitystringRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
no_third_party_lienbooleanRequiredobserved_atstring · date-timeRequiredonboardingobjectRequiredopening_inventory_emptybooleanRequiredownershipobjectRequiredprogram_idstringRequiredprogram_sha256stringRequiredsignaturestringRequiredvalid_untilstring · date-timeRequiredversionstringRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredidstringRequiredinstrumentobject or nullOptional16 child attributes
currency_codestringRequiredcusipstringRequiredeligibilityobjectRequiredenabledbooleanRequiredface_value_amountintegerRequiredCents per whole unit
issue_datestring · dateRequiredA business date, YYYY-MM-DD
kindstringRequiredTreasury_bill
maturity_datestring · dateRequiredA business date, YYYY-MM-DD
namestringRequiredprice_scaleintegerRequiredprogram_idstringRequiredtermsobjectRequiredunit_basisstringRequiredFace_100_usd
unit_incrementintegerRequiredunit_scaleintegerRequiredzero_couponboolean or nullOptionalkindstringRequiredprogramobject or nullOptional20 child attributes
authorityobjectRequiredbridge_subjectstringRequiredbroker_namestringRequiredbroker_referencestringRequiredcustodian_namestringRequiredcustodian_referencestringRequiredcustody_agreementobjectRequireddealersarray of objectsRequiredenabledbooleanRequiredevidence_keysobjectRequiredlegal_entitystringRequiredmaster_cash_external_account_referencestringRequiredmaster_cash_identityobjectRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
max_order_amountintegerRequiredpolicyobjectRequiredproviderstringRequiredtrading_agreementobjectRequiredvalid_fromstring · dateRequiredA business date, YYYY-MM-DD
valid_throughstring · dateRequiredA business date, YYYY-MM-DD
latest_observationobject or nullOptional23 child attributes
accrued_income_amountinteger or nullOptionalas_ofstring · dateRequiredA business date, YYYY-MM-DD
close_out_completebooleanRequiredcurrency_codestringRequiredcusipstringRequiredcustodian_referencestringRequiredencumbered_unitsintegerRequiredevidenceobjectRequired3 child attributes
datastring · byteRequiredformatstringRequiredsha256stringRequiredexternal_account_referencestringRequiredfair_value_amountinteger or nullOptionalActual custody units at supplied price
key_idstringRequiredlegal_entitystringRequiredlot_idstringRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
observed_atstring · date-timeRequiredoriginal_execution_sha256stringRequiredoriginal_settlement_sha256stringOptionalpriceinteger or nullOptionalprice_basisstringOptionalOptional actual bid/ask/mid/last source; repo requires bid
signaturestringRequiredunitsintegerRequiredActual custodian quantity, distinct from trade-date book quantity
valuation_basisstringOptionalIntraday uses start of AsOf; day_close uses start of AsOf+1
versionstringRequiredlatest_valuationobject or nullOptional9 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredidstringRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
posting_datestring · date or nullOptionalA business date, YYYY-MM-DD
requestobjectRequired5 child attributes
inputsobjectRequiredAccountingInputs are explicit controller-supplied assessments, not inferred tax rates or a tax engine. Deferred tax effects are allocated separately to this lot's AFS OCI and earnings; current income tax is a separate tax source.
lot_idstringRequiredlot_revisionintegerRequiredobservationobjectRequiredrationalestringRequiredresultobjectRequired12 child attributes
accrual_to_datestring · dateRequiredA business date, YYYY-MM-DD
amortized_cost_amountintegerRequiredas_ofstring · dateRequiredA business date, YYYY-MM-DD
credit_allowance_amountintegerRequireddeferred_tax_asset_amountintegerRequiredNet of reviewed valuation allowances
deferred_tax_liability_amountintegerRequiredfair_value_adjustment_amountintegerRequiredfair_value_amountintegerRequirednet_oci_amountintegerRequiredpretax_oci_amountintegerRequiredtax_earnings_amountintegerRequiredPositive cumulative benefit, negative expense
tax_oci_amountintegerRequiredlegal_entitystringRequiredoriginal_cost_amountintegerRequiredprogramobjectRequired9 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcustody_accountobject or nullOptional18 child attributes
bank_ownedbooleanRequiredcustodian_referencestringRequiredenabledbooleanRequiredexclusive_core_instructionsbooleanRequiredexternal_account_referencestringRequiredkey_idstringRequiredlegal_entitystringRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
no_third_party_lienbooleanRequiredobserved_atstring · date-timeRequiredonboardingobjectRequiredopening_inventory_emptybooleanRequiredownershipobjectRequiredprogram_idstringRequiredprogram_sha256stringRequiredsignaturestringRequiredvalid_untilstring · date-timeRequiredversionstringRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredidstringRequiredinstrumentobject or nullOptional16 child attributes
currency_codestringRequiredcusipstringRequiredeligibilityobjectRequiredenabledbooleanRequiredface_value_amountintegerRequiredCents per whole unit
issue_datestring · dateRequiredA business date, YYYY-MM-DD
kindstringRequiredTreasury_bill
maturity_datestring · dateRequiredA business date, YYYY-MM-DD
namestringRequiredprice_scaleintegerRequiredprogram_idstringRequiredtermsobjectRequiredunit_basisstringRequiredFace_100_usd
unit_incrementintegerRequiredunit_scaleintegerRequiredzero_couponboolean or nullOptionalkindstringRequiredprogramobject or nullOptional20 child attributes
authorityobjectRequiredbridge_subjectstringRequiredbroker_namestringRequiredbroker_referencestringRequiredcustodian_namestringRequiredcustodian_referencestringRequiredcustody_agreementobjectRequireddealersarray of objectsRequiredenabledbooleanRequiredevidence_keysobjectRequiredlegal_entitystringRequiredmaster_cash_external_account_referencestringRequiredmaster_cash_identityobjectRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
max_order_amountintegerRequiredpolicyobjectRequiredproviderstringRequiredtrading_agreementobjectRequiredvalid_fromstring · dateRequiredA business date, YYYY-MM-DD
valid_throughstring · dateRequiredA business date, YYYY-MM-DD
purchase_order_idstringRequiredredemption_idstringOptionalreservation_revisionintegerOptionalreserved_order_idstringOptionalreserved_redemption_idstringOptionalrevisionintegerRequiredscheduleobjectRequired5 child attributes
conventionstringRequiredcost_amountintegerRequiredface_amountintegerRequiredmaturity_datestring · dateRequiredA business date, YYYY-MM-DD
start_datestring · dateRequiredA business date, YYYY-MM-DD
settlement_datestring · date or nullOptionalA business date, YYYY-MM-DD
settlement_sha256stringOptionalstatusstringRequiredUnsettled, active, selling, sold_unsettled, sold, redeeming, redeemed, exception
trade_datestring · dateRequiredA business date, YYYY-MM-DD
trade_journal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
unitsintegerRequiredOriginal full quantity; disposition never rewrites it
managed_accountsarray of objectsRequired7 child attributes
gl_codestringRequiredheld_amountintegerRequiredledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
normal_balancestringRequiredposted_amountintegerRequiredpurposestringRequiredsource_idstringRequiredobservation_datestring · dateRequiredA business date, YYYY-MM-DD
ordersarray of objectsRequired24 child attributes
accounting_plansarray of objectsOptional7 child attributes
correction_reasonstringOptionalcreated_atstring · date-timeRequiredevidence_sha256stringRequiredjournalobjectRequiredJournal excludes ledger-assigned identity/time and separately authenticated actors. Entry order is part of the instruction, matching the ledger replay fingerprint.
11 child attributes
adjusts_periodstringOptionaleffective_datestring · dateRequiredA business date, YYYY-MM-DD
entriesarray of objectsRequiredkindstringRequiredprotected_command_idstringRequiredreasonstringOptionalrelease_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
require_availablebooleanOptionalreversal_ofstringOptionalsource_refstringRequiredsource_servicestringRequiredjournal_keystringRequiredjournal_sha256stringRequiredsupersedes_sha256stringOptionalactorstringRequiredcash_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
cash_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
cash_posting_datestring · date or nullOptionalA business date, YYYY-MM-DD
created_atstring · date-timeRequiredcustody_accountobjectRequired9 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcustody_accountobject or nullOptional18 child attributes
bank_ownedbooleanRequiredcustodian_referencestringRequiredenabledbooleanRequiredexclusive_core_instructionsbooleanRequiredexternal_account_referencestringRequiredkey_idstringRequiredlegal_entitystringRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
no_third_party_lienbooleanRequiredobserved_atstring · date-timeRequiredonboardingobjectRequiredopening_inventory_emptybooleanRequiredownershipobjectRequiredprogram_idstringRequiredprogram_sha256stringRequiredsignaturestringRequiredvalid_untilstring · date-timeRequiredversionstringRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredidstringRequiredinstrumentobject or nullOptional16 child attributes
currency_codestringRequiredcusipstringRequiredeligibilityobjectRequiredenabledbooleanRequiredface_value_amountintegerRequiredCents per whole unit
issue_datestring · dateRequiredA business date, YYYY-MM-DD
kindstringRequiredTreasury_bill
maturity_datestring · dateRequiredA business date, YYYY-MM-DD
namestringRequiredprice_scaleintegerRequiredprogram_idstringRequiredtermsobjectRequiredunit_basisstringRequiredFace_100_usd
unit_incrementintegerRequiredunit_scaleintegerRequiredzero_couponboolean or nullOptionalkindstringRequiredprogramobject or nullOptional20 child attributes
authorityobjectRequiredbridge_subjectstringRequiredbroker_namestringRequiredbroker_referencestringRequiredcustodian_namestringRequiredcustodian_referencestringRequiredcustody_agreementobjectRequireddealersarray of objectsRequiredenabledbooleanRequiredevidence_keysobjectRequiredlegal_entitystringRequiredmaster_cash_external_account_referencestringRequiredmaster_cash_identityobjectRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
max_order_amountintegerRequiredpolicyobjectRequiredproviderstringRequiredtrading_agreementobjectRequiredvalid_fromstring · dateRequiredA business date, YYYY-MM-DD
valid_throughstring · dateRequiredA business date, YYYY-MM-DD
decisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredexceptionsarray of stringsRequiredexecutionobject or nullOptional27 child attributes
broker_referencestringRequiredconfirmationobjectRequired3 child attributes
datastring · byteRequiredformatstringRequiredsha256stringRequiredcounterpartystringRequiredcurrency_codestringRequiredcusipstringRequiredcustodian_referencestringRequireddealer_customer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
dealer_referencestringRequiredexecuted_atstring · date-timeRequiredexecution_referencestringRequiredexternal_account_referencestringRequiredfee_amountintegerRequiredinstruction_sha256stringRequiredkey_idstringRequiredlegal_entitystringRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
net_cash_amountintegerRequiredobserved_atstring · date-timeRequiredorder_idstringRequiredpriceintegerRequiredprincipal_amountintegerRequiredsidestringRequiredsignaturestringRequiredstatusstringRequiredExecuted, cancelled or rejected (no fill)
trade_datestring · dateRequiredA business date, YYYY-MM-DD
unitsintegerRequiredversionstringRequiredidstringRequiredinstructionobject or nullOptional31 child attributes
broker_referencestringRequiredcash_limit_amountintegerRequiredcurrency_codestringRequiredcusipstringRequiredcustodian_referencestringRequiredcustody_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
custody_account_sha256stringRequireddealer_customer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
dealer_referencestringRequiredexternal_account_referencestringRequiredidstringRequiredinstrument_idstringRequiredinstrument_sha256stringRequiredissued_atstring · date-timeRequiredlegal_entitystringRequiredlimit_priceintegerRequiredlot_idstringRequiredAllocated BUY lot or exclusively reserved SELL lot
lot_revisionintegerOptionalmaster_cash_external_account_referencestringRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
max_fee_amountintegerRequiredorder_idstringRequiredprogram_idstringRequiredprogram_sha256stringRequiredrequest_sha256stringRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
sha256stringRequiredsidestringRequiredtrade_datestring · dateRequiredA business date, YYYY-MM-DD
unitsintegerRequiredversionstringRequiredinstrumentobjectRequired9 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcustody_accountobject or nullOptional18 child attributes
bank_ownedbooleanRequiredcustodian_referencestringRequiredenabledbooleanRequiredexclusive_core_instructionsbooleanRequiredexternal_account_referencestringRequiredkey_idstringRequiredlegal_entitystringRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
no_third_party_lienbooleanRequiredobserved_atstring · date-timeRequiredonboardingobjectRequiredopening_inventory_emptybooleanRequiredownershipobjectRequiredprogram_idstringRequiredprogram_sha256stringRequiredsignaturestringRequiredvalid_untilstring · date-timeRequiredversionstringRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredidstringRequiredinstrumentobject or nullOptional16 child attributes
currency_codestringRequiredcusipstringRequiredeligibilityobjectRequiredenabledbooleanRequiredface_value_amountintegerRequiredCents per whole unit
issue_datestring · dateRequiredA business date, YYYY-MM-DD
kindstringRequiredTreasury_bill
maturity_datestring · dateRequiredA business date, YYYY-MM-DD
namestringRequiredprice_scaleintegerRequiredprogram_idstringRequiredtermsobjectRequiredunit_basisstringRequiredFace_100_usd
unit_incrementintegerRequiredunit_scaleintegerRequiredzero_couponboolean or nullOptionalkindstringRequiredprogramobject or nullOptional20 child attributes
authorityobjectRequiredbridge_subjectstringRequiredbroker_namestringRequiredbroker_referencestringRequiredcustodian_namestringRequiredcustodian_referencestringRequiredcustody_agreementobjectRequireddealersarray of objectsRequiredenabledbooleanRequiredevidence_keysobjectRequiredlegal_entitystringRequiredmaster_cash_external_account_referencestringRequiredmaster_cash_identityobjectRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
max_order_amountintegerRequiredpolicyobjectRequiredproviderstringRequiredtrading_agreementobjectRequiredvalid_fromstring · dateRequiredA business date, YYYY-MM-DD
valid_throughstring · dateRequiredA business date, YYYY-MM-DD
lot_idstringRequiredlot_revisionintegerOptionalprogramobjectRequired9 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcustody_accountobject or nullOptional18 child attributes
bank_ownedbooleanRequiredcustodian_referencestringRequiredenabledbooleanRequiredexclusive_core_instructionsbooleanRequiredexternal_account_referencestringRequiredkey_idstringRequiredlegal_entitystringRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
no_third_party_lienbooleanRequiredobserved_atstring · date-timeRequiredonboardingobjectRequiredopening_inventory_emptybooleanRequiredownershipobjectRequiredprogram_idstringRequiredprogram_sha256stringRequiredsignaturestringRequiredvalid_untilstring · date-timeRequiredversionstringRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredidstringRequiredinstrumentobject or nullOptional16 child attributes
currency_codestringRequiredcusipstringRequiredeligibilityobjectRequiredenabledbooleanRequiredface_value_amountintegerRequiredCents per whole unit
issue_datestring · dateRequiredA business date, YYYY-MM-DD
kindstringRequiredTreasury_bill
maturity_datestring · dateRequiredA business date, YYYY-MM-DD
namestringRequiredprice_scaleintegerRequiredprogram_idstringRequiredtermsobjectRequiredunit_basisstringRequiredFace_100_usd
unit_incrementintegerRequiredunit_scaleintegerRequiredzero_couponboolean or nullOptionalkindstringRequiredprogramobject or nullOptional20 child attributes
authorityobjectRequiredbridge_subjectstringRequiredbroker_namestringRequiredbroker_referencestringRequiredcustodian_namestringRequiredcustodian_referencestringRequiredcustody_agreementobjectRequireddealersarray of objectsRequiredenabledbooleanRequiredevidence_keysobjectRequiredlegal_entitystringRequiredmaster_cash_external_account_referencestringRequiredmaster_cash_identityobjectRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
max_order_amountintegerRequiredpolicyobjectRequiredproviderstringRequiredtrading_agreementobjectRequiredvalid_fromstring · dateRequiredA business date, YYYY-MM-DD
valid_throughstring · dateRequiredA business date, YYYY-MM-DD
requestobjectRequired15 child attributes
cash_limit_amountintegerRequiredcurrency_codestringRequiredcustody_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
dealer_customer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
dealer_referencestringRequiredinstrument_idstringRequiredlimit_priceintegerRequiredlot_idstringOptionalmax_fee_amountintegerRequiredprogram_idstringRequiredrationalestringRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
sidestringRequiredtrade_datestring · dateRequiredA business date, YYYY-MM-DD
unitsintegerRequiredrequest_sha256stringRequiredresolutionsarray of objectsOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredsettlementobject or nullOptional29 child attributes
broker_referencestringRequiredcash_evidenceobjectRequired3 child attributes
datastring · byteRequiredformatstringRequiredsha256stringRequiredcash_referencestringRequiredcurrency_codestringRequiredcusipstringRequiredcustodian_referencestringRequireddelivery_evidenceobjectRequired3 child attributes
datastring · byteRequiredformatstringRequiredsha256stringRequireddelivery_referencestringRequiredexecution_sha256stringRequiredexternal_account_referencestringRequiredfee_amountintegerRequiredinstruction_sha256stringRequiredkey_idstringRequiredlegal_entitystringRequiredmaster_cash_external_account_referencestringRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
master_cash_statement_line_referencestringRequiredmaster_cash_statement_referencestringRequirednet_cash_amountintegerRequiredobserved_atstring · date-timeRequiredorder_idstringRequiredprincipal_amountintegerRequiredsettled_atstring · date-timeRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
settlement_referencestringRequiredsidestringRequiredsignaturestringRequiredunitsintegerRequiredversionstringRequiredsourceobjectRequired5 child attributes
captured_atstring · date-timeRequiredcash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
external_account_referencestringRequiredlegal_entitystringRequiredmaster_cash_external_account_referencestringRequiredstatusstringRequiredtrade_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
trade_posting_datestring · date or nullOptionalA business date, YYYY-MM-DD
readybooleanRequiredredemptionsarray of objectsRequired11 child attributes
accounting_plansarray of objectsOptional7 child attributes
correction_reasonstringOptionalcreated_atstring · date-timeRequiredevidence_sha256stringRequiredjournalobjectRequiredJournal excludes ledger-assigned identity/time and separately authenticated actors. Entry order is part of the instruction, matching the ledger replay fingerprint.
11 child attributes
adjusts_periodstringOptionaleffective_datestring · dateRequiredA business date, YYYY-MM-DD
entriesarray of objectsRequiredkindstringRequiredprotected_command_idstringRequiredreasonstringOptionalrelease_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
require_availablebooleanOptionalreversal_ofstringOptionalsource_refstringRequiredsource_servicestringRequiredjournal_keystringRequiredjournal_sha256stringRequiredsupersedes_sha256stringOptionalactorstringRequiredcreated_atstring · date-timeRequiredexceptionsarray of stringsRequiredidstringRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
posting_datestring · date or nullOptionalA business date, YYYY-MM-DD
receiptobjectRequired28 child attributes
cash_evidenceobjectRequired3 child attributes
datastring · byteRequiredformatstringRequiredsha256stringRequiredcash_referencestringRequiredcurrency_codestringRequiredcusipstringRequiredcustodian_referencestringRequiredcustody_evidenceobjectRequired3 child attributes
datastring · byteRequiredformatstringRequiredsha256stringRequiredexternal_account_referencestringRequiredface_amountintegerRequiredfee_amountintegerRequiredidstringRequiredkey_idstringRequiredlegal_entitystringRequiredlot_idstringRequiredlot_revisionintegerRequiredmaster_cash_external_account_referencestringRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
master_cash_statement_line_referencestringRequiredmaster_cash_statement_referencestringRequirednet_cash_amountintegerRequiredobserved_atstring · date-timeRequiredoriginal_settlement_sha256stringRequiredpayment_datestring · dateRequiredA business date, YYYY-MM-DD
payment_referencestringRequiredsignaturestringRequiredtax_evidenceobjectRequired3 child attributes
datastring · byteRequiredformatstringRequiredsha256stringRequiredunitsintegerRequiredversionstringRequiredwithholding_amountintegerRequiredrequest_sha256stringRequiredresolutionsarray of objectsOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredstatusstringRequiredversionstringRequired