The Investment Order object
A customer-consented securities trade, exclusive cash or lot reservations, immutable instruction and actual signed execution/DVP settlement.
Attributes
accounting_plan_sha256stringOptionalaccounting_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 objectsRequired4 child attributes
amountintegerRequiredcurrency_codestringRequireddirectionstringRequiredledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
kindstringRequiredprotected_command_idstringRequiredreasonstringOptionalrelease_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
require_availablebooleanOptionalreversal_ofstringOptionalsource_refstringRequiredsource_servicestringRequiredjournal_keystringRequiredjournal_sha256stringRequiredsupersedes_sha256stringOptionalactorstringRequiredcash_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
created_atstring · date-timeRequiredcustody_accountobjectRequired9 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcustody_accountobject or nullOptional16 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
custodian_referencestringRequiredenabledbooleanRequiredexclusive_core_instructionsbooleanRequiredexternal_account_referencestringRequiredkey_idstringRequiredobserved_atstring · date-timeRequiredonboardingobjectRequiredDocument retains the actual external bytes, not a mutable reference alone.
3 child attributes
datastring · byteRequiredformatstringRequiredsha256stringRequiredopening_inventory_emptybooleanRequiredOriginal onboarding, never a claim that today's tracked lot book is empty
owner_idstringRequiredownershipobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredprogram_idstringRequiredprogram_sha256stringRequiredsignaturestringRequiredvalid_untilstring · date-timeRequiredversionstringRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredidstringRequiredinstrumentobject or nullOptional18 child attributes
currency_codestringRequiredcusipstringRequiredeligibilityobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredenabledbooleanRequiredface_value_amountintegerRequiredCents per whole bill unit; zero for shares
government_onlyboolean or nullOptionalissue_datestring · date or nullOptionalA business date, YYYY-MM-DD
kindstringRequiredTreasury_bill or government_mmf
maturity_datestring · date or nullOptionalA business date, YYYY-MM-DD
namestringRequiredno_loadboolean or nullOptionalprice_scaleintegerRequiredprogram_idstringRequiredprospectusobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredunit_basisstringRequiredFace_100_usd or share
unit_incrementintegerRequiredunit_scaleintegerRequiredzero_couponboolean or nullOptionalkindstringRequiredprogramobject or nullOptional22 child attributes
agency_agreementobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredauthorityobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredbank_remunerationstringRequiredNone; bank fee collection is a separate unsupported workflow
bridge_subjectstringRequiredbroker_namestringRequiredbroker_referencestringRequiredcash_roundingstringRequiredHalf_up_cent only
confirmation_agreementobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredconfirmation_providerstringRequiredBroker_custodian only
custodian_namestringRequiredcustodian_referencestringRequiredcustody_agreementobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredenabledbooleanRequiredevidence_keysobjectRequiredlegal_entitystringRequiredmax_order_amountintegerRequiredproviderstringRequiredrisk_disclosureobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredtax_reporterstringRequiredBroker_custodian only
tax_reporting_agreementobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredvalid_fromstring · dateRequiredA business date, YYYY-MM-DD
valid_throughstring · dateRequiredA business date, YYYY-MM-DD
customer_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
decisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredexceptionsarray of stringsRequiredexecutionobject or nullOptional29 child attributes
broker_referencestringRequiredconfirmationobjectRequiredDocument retains the actual external bytes, not a mutable reference alone.
3 child attributes
datastring · byteRequiredformatstringRequiredsha256stringRequiredconfirmation_deliveryobjectRequiredDocument retains the actual external bytes, not a mutable reference alone.
3 child attributes
datastring · byteRequiredformatstringRequiredsha256stringRequiredconfirmation_received_atstring · date-timeRequiredcounterpartystringRequiredcurrency_codestringRequiredcusipstringRequiredcustodian_referencestringRequireddelivered_atstring · date-timeRequireddelivery_methodstringRequireddelivery_recipient_idstringRequiredexecuted_atstring · date-timeRequiredexecution_referencestringRequiredexternal_account_referencestringRequiredfee_amountintegerRequiredinstruction_sha256stringRequiredkey_idstringRequirednet_cash_amountintegerRequiredobserved_atstring · date-timeRequiredorder_idstringRequiredowner_idstringRequiredpriceintegerRequiredprincipal_amountintegerRequiredsidestringRequiredsignaturestringRequiredstatusstringRequiredExecuted, cancelled, rejected; full fill only
trade_datestring · dateRequiredA business date, YYYY-MM-DD
unitsintegerRequiredversionstringRequiredidstringRequiredinstructionobject or nullOptionalInstruction is the bank's immutable, independently reviewed command. Signed execution and settlement evidence attest its exact digest; an ACK is no fill.
30 child attributes
broker_referencestringRequiredcash_limit_amountintegerRequiredcurrency_codestringRequiredcusipstringRequiredcustodian_referencestringRequiredcustody_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
custody_account_sha256stringRequiredexternal_account_referencestringRequiredidstringRequiredinstrument_idstringRequiredinstrument_sha256stringRequiredissued_atstring · date-timeRequiredlimit_priceintegerRequiredlot_idstringOptionallot_revisionintegerOptionalmax_fee_amountintegerRequiredorder_idstringRequiredowner_idstringRequiredprice_scaleintegerRequiredprogram_idstringRequiredprogram_sha256stringRequiredrequest_sha256stringRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
sha256stringRequiredsidestringRequiredtrade_datestring · dateRequiredA business date, YYYY-MM-DD
unit_basisstringRequiredunit_scaleintegerRequiredunitsintegerRequiredversionstringRequiredinstrumentobjectRequired9 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcustody_accountobject or nullOptional16 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
custodian_referencestringRequiredenabledbooleanRequiredexclusive_core_instructionsbooleanRequiredexternal_account_referencestringRequiredkey_idstringRequiredobserved_atstring · date-timeRequiredonboardingobjectRequiredDocument retains the actual external bytes, not a mutable reference alone.
3 child attributes
datastring · byteRequiredformatstringRequiredsha256stringRequiredopening_inventory_emptybooleanRequiredOriginal onboarding, never a claim that today's tracked lot book is empty
owner_idstringRequiredownershipobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredprogram_idstringRequiredprogram_sha256stringRequiredsignaturestringRequiredvalid_untilstring · date-timeRequiredversionstringRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredidstringRequiredinstrumentobject or nullOptional18 child attributes
currency_codestringRequiredcusipstringRequiredeligibilityobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredenabledbooleanRequiredface_value_amountintegerRequiredCents per whole bill unit; zero for shares
government_onlyboolean or nullOptionalissue_datestring · date or nullOptionalA business date, YYYY-MM-DD
kindstringRequiredTreasury_bill or government_mmf
maturity_datestring · date or nullOptionalA business date, YYYY-MM-DD
namestringRequiredno_loadboolean or nullOptionalprice_scaleintegerRequiredprogram_idstringRequiredprospectusobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredunit_basisstringRequiredFace_100_usd or share
unit_incrementintegerRequiredunit_scaleintegerRequiredzero_couponboolean or nullOptionalkindstringRequiredprogramobject or nullOptional22 child attributes
agency_agreementobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredauthorityobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredbank_remunerationstringRequiredNone; bank fee collection is a separate unsupported workflow
bridge_subjectstringRequiredbroker_namestringRequiredbroker_referencestringRequiredcash_roundingstringRequiredHalf_up_cent only
confirmation_agreementobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredconfirmation_providerstringRequiredBroker_custodian only
custodian_namestringRequiredcustodian_referencestringRequiredcustody_agreementobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredenabledbooleanRequiredevidence_keysobjectRequiredlegal_entitystringRequiredmax_order_amountintegerRequiredproviderstringRequiredrisk_disclosureobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredtax_reporterstringRequiredBroker_custodian only
tax_reporting_agreementobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredvalid_fromstring · dateRequiredA business date, YYYY-MM-DD
valid_throughstring · dateRequiredA business date, YYYY-MM-DD
journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
lot_idstringOptionallot_revisionintegerOptionalposting_datestring · date or nullOptionalA business date, YYYY-MM-DD
programobjectRequired9 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcustody_accountobject or nullOptional16 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
custodian_referencestringRequiredenabledbooleanRequiredexclusive_core_instructionsbooleanRequiredexternal_account_referencestringRequiredkey_idstringRequiredobserved_atstring · date-timeRequiredonboardingobjectRequiredDocument retains the actual external bytes, not a mutable reference alone.
3 child attributes
datastring · byteRequiredformatstringRequiredsha256stringRequiredopening_inventory_emptybooleanRequiredOriginal onboarding, never a claim that today's tracked lot book is empty
owner_idstringRequiredownershipobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredprogram_idstringRequiredprogram_sha256stringRequiredsignaturestringRequiredvalid_untilstring · date-timeRequiredversionstringRequireddecisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredidstringRequiredinstrumentobject or nullOptional18 child attributes
currency_codestringRequiredcusipstringRequiredeligibilityobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredenabledbooleanRequiredface_value_amountintegerRequiredCents per whole bill unit; zero for shares
government_onlyboolean or nullOptionalissue_datestring · date or nullOptionalA business date, YYYY-MM-DD
kindstringRequiredTreasury_bill or government_mmf
maturity_datestring · date or nullOptionalA business date, YYYY-MM-DD
namestringRequiredno_loadboolean or nullOptionalprice_scaleintegerRequiredprogram_idstringRequiredprospectusobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredunit_basisstringRequiredFace_100_usd or share
unit_incrementintegerRequiredunit_scaleintegerRequiredzero_couponboolean or nullOptionalkindstringRequiredprogramobject or nullOptional22 child attributes
agency_agreementobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredauthorityobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredbank_remunerationstringRequiredNone; bank fee collection is a separate unsupported workflow
bridge_subjectstringRequiredbroker_namestringRequiredbroker_referencestringRequiredcash_roundingstringRequiredHalf_up_cent only
confirmation_agreementobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredconfirmation_providerstringRequiredBroker_custodian only
custodian_namestringRequiredcustodian_referencestringRequiredcustody_agreementobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredenabledbooleanRequiredevidence_keysobjectRequiredlegal_entitystringRequiredmax_order_amountintegerRequiredproviderstringRequiredrisk_disclosureobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredtax_reporterstringRequiredBroker_custodian only
tax_reporting_agreementobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredvalid_fromstring · dateRequiredA business date, YYYY-MM-DD
valid_throughstring · dateRequiredA business date, YYYY-MM-DD
requestobjectRequired16 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
cash_limit_amountintegerRequiredBUY maximum total debit; SELL minimum net credit
currency_codestringRequiredcustody_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
disclosure_sha256stringRequiredinstrument_idstringRequiredinvestment_consentbooleanRequiredlimit_priceintegerRequiredlot_idstringOptionalmax_fee_amountintegerRequiredowner_idstringRequiredprogram_idstringRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
sidestringRequiredBUY or SELL
trade_datestring · dateRequiredA business date, YYYY-MM-DD
unitsintegerRequiredrequest_sha256stringRequiredresolutionsarray of objectsOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredscreening_atstring · date-time or nullOptionalscreening_idsarray of stringsOptionalsettlementobject or nullOptional25 child attributes
broker_referencestringRequiredcash_evidenceobjectRequiredDocument retains the actual external bytes, not a mutable reference alone.
3 child attributes
datastring · byteRequiredformatstringRequiredsha256stringRequiredcash_referencestringRequiredcurrency_codestringRequiredcusipstringRequiredcustodian_referencestringRequireddelivery_evidenceobjectRequiredDocument retains the actual external bytes, not a mutable reference alone.
3 child attributes
datastring · byteRequiredformatstringRequiredsha256stringRequireddelivery_referencestringRequiredexecution_sha256stringRequiredexternal_account_referencestringRequiredfee_amountintegerRequiredinstruction_sha256stringRequiredkey_idstringRequirednet_cash_amountintegerRequiredobserved_atstring · date-timeRequiredorder_idstringRequiredowner_idstringRequiredprincipal_amountintegerRequiredsettled_atstring · date-timeRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
settlement_referencestringRequiredsidestringRequiredsignaturestringRequiredunitsintegerRequiredversionstringRequiredsourceobjectRequired8 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
captured_atstring · date-timeRequiredcustody_ownershipobjectRequired2 child attributes
referencestringRequiredsha256stringRequiredexternal_account_referencestringRequiredledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
owner_idstringRequiredownership_revisionintegerRequiredownership_sha256stringRequiredstatusstringRequired