Corgi BankDocumentation
OpenAPI

The Investment Lot object

An externally held customer securities lot with actual acquisition cash cost, explicit unknown tax basis and signed custody reconciliation.

Attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

acquired_datestring · dateRequired

A business date, YYYY-MM-DD

actual_proceeds_amountinteger or nullOptional
disposal_distribution_idstringOptional
disposal_order_idstringOptional
exceptionsarray of stringsRequired
external_account_referencestringRequired
idstringRequired
instrumentobjectRequired
9 child attributes
actorstringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
custody_accountobject or nullOptional
16 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

custodian_referencestringRequired
enabledbooleanRequired
exclusive_core_instructionsbooleanRequired
external_account_referencestringRequired
key_idstringRequired
observed_atstring · date-timeRequired
onboardingobjectRequired

Document retains the actual external bytes, not a mutable reference alone.

3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
opening_inventory_emptybooleanRequired

Original onboarding, never a claim that today's tracked lot book is empty

owner_idstringRequired
ownershipobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
program_idstringRequired
program_sha256stringRequired
signaturestringRequired
valid_untilstring · date-timeRequired
versionstringRequired
decisionobject or nullOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
notestringRequired
idstringRequired
instrumentobject or nullOptional
18 child attributes
currency_codestringRequired
cusipstringRequired
eligibilityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
enabledbooleanRequired
face_value_amountintegerRequired

Cents per whole bill unit; zero for shares

government_onlyboolean or nullOptional
issue_datestring · date or nullOptional

A business date, YYYY-MM-DD

kindstringRequired

Treasury_bill or government_mmf

maturity_datestring · date or nullOptional

A business date, YYYY-MM-DD

namestringRequired
no_loadboolean or nullOptional
price_scaleintegerRequired
program_idstringRequired
prospectusobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
unit_basisstringRequired

Face_100_usd or share

unit_incrementintegerRequired
unit_scaleintegerRequired
zero_couponboolean or nullOptional
kindstringRequired
programobject or nullOptional
22 child attributes
agency_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
authorityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
bank_remunerationstringRequired

None; bank fee collection is a separate unsupported workflow

bridge_subjectstringRequired
broker_namestringRequired
broker_referencestringRequired
cash_roundingstringRequired

Half_up_cent only

confirmation_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
confirmation_providerstringRequired

Broker_custodian only

custodian_namestringRequired
custodian_referencestringRequired
custody_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
enabledbooleanRequired
evidence_keysobjectRequired
legal_entitystringRequired
max_order_amountintegerRequired
providerstringRequired
risk_disclosureobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
tax_reporterstringRequired

Broker_custodian only

tax_reporting_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

instrument_idstringRequired
journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

latest_observationobject or nullOptional
19 child attributes
accrued_income_amountinteger or nullOptional
as_ofstring · dateRequired

A business date, YYYY-MM-DD

close_out_completebooleanRequired
currency_codestringRequired
cusipstringRequired
custodian_referencestringRequired
evidenceobjectRequired

Document retains the actual external bytes, not a mutable reference alone.

3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
external_account_referencestringRequired
key_idstringRequired
lot_idstringRequired
market_value_amountinteger or nullOptional
observed_atstring · date-timeRequired
original_settlement_sha256stringRequired
owner_idstringRequired
priceinteger or nullOptional
signaturestringRequired
tax_basis_amountinteger or nullOptional
unitsintegerRequired
versionstringRequired
original_cost_amountintegerRequired

Actual BUY net cash, including fees

owner_idstringRequired
programobjectRequired
9 child attributes
actorstringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
custody_accountobject or nullOptional
16 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

custodian_referencestringRequired
enabledbooleanRequired
exclusive_core_instructionsbooleanRequired
external_account_referencestringRequired
key_idstringRequired
observed_atstring · date-timeRequired
onboardingobjectRequired

Document retains the actual external bytes, not a mutable reference alone.

3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
opening_inventory_emptybooleanRequired

Original onboarding, never a claim that today's tracked lot book is empty

owner_idstringRequired
ownershipobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
program_idstringRequired
program_sha256stringRequired
signaturestringRequired
valid_untilstring · date-timeRequired
versionstringRequired
decisionobject or nullOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
notestringRequired
idstringRequired
instrumentobject or nullOptional
18 child attributes
currency_codestringRequired
cusipstringRequired
eligibilityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
enabledbooleanRequired
face_value_amountintegerRequired

Cents per whole bill unit; zero for shares

government_onlyboolean or nullOptional
issue_datestring · date or nullOptional

A business date, YYYY-MM-DD

kindstringRequired

Treasury_bill or government_mmf

maturity_datestring · date or nullOptional

A business date, YYYY-MM-DD

namestringRequired
no_loadboolean or nullOptional
price_scaleintegerRequired
program_idstringRequired
prospectusobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
unit_basisstringRequired

Face_100_usd or share

unit_incrementintegerRequired
unit_scaleintegerRequired
zero_couponboolean or nullOptional
kindstringRequired
programobject or nullOptional
22 child attributes
agency_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
authorityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
bank_remunerationstringRequired

None; bank fee collection is a separate unsupported workflow

bridge_subjectstringRequired
broker_namestringRequired
broker_referencestringRequired
cash_roundingstringRequired

Half_up_cent only

confirmation_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
confirmation_providerstringRequired

Broker_custodian only

custodian_namestringRequired
custodian_referencestringRequired
custody_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
enabledbooleanRequired
evidence_keysobjectRequired
legal_entitystringRequired
max_order_amountintegerRequired
providerstringRequired
risk_disclosureobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
tax_reporterstringRequired

Broker_custodian only

tax_reporting_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

purchase_order_idstringRequired
reservation_revisionintegerOptional
reserved_distribution_idstringOptional
reserved_order_idstringOptional
revisionintegerRequired
settlement_sha256stringRequired
statusstringRequired

Active, selling, maturing, sold, matured, exception

tax_basis_amountinteger or nullOptional

Unknown unless actual custody source supplies it

unitsintegerRequired

Original whole-lot quantity; never mutated by a sale

to move to open esc to close