Corgi BankDocumentation
OpenAPI

The Bank Securities Lot object

Bank-owned AFS cost, contractual effective-interest schedule, custody, valuation, tax and credit evidence.

Attributes

accrued_to_datestring · date or nullOptional

Exclusive start boundary; closing D requires D+1

actual_proceeds_amountinteger or nullOptional
cash_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

disposal_cash_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

disposal_datestring · date or nullOptional

A business date, YYYY-MM-DD

disposal_execution_sha256stringOptional
disposal_order_idstringOptional
disposal_settlement_datestring · date or nullOptional

A business date, YYYY-MM-DD

disposal_settlement_sha256stringOptional
disposal_trade_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

exceptionsarray of stringsRequired
execution_sha256stringRequired
external_account_referencestringRequired
idstringRequired
instrumentobjectRequired
9 child attributes
actorstringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
custody_accountobject or nullOptional
18 child attributes
bank_ownedbooleanRequired
custodian_referencestringRequired
enabledbooleanRequired
exclusive_core_instructionsbooleanRequired
external_account_referencestringRequired
key_idstringRequired
legal_entitystringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

no_third_party_lienbooleanRequired
observed_atstring · date-timeRequired
onboardingobjectRequired
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
opening_inventory_emptybooleanRequired
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
16 child attributes
currency_codestringRequired
cusipstringRequired
eligibilityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
enabledbooleanRequired
face_value_amountintegerRequired

Cents per whole unit

issue_datestring · dateRequired

A business date, YYYY-MM-DD

kindstringRequired

Treasury_bill

maturity_datestring · dateRequired

A business date, YYYY-MM-DD

namestringRequired
price_scaleintegerRequired
program_idstringRequired
termsobjectRequired
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
unit_basisstringRequired

Face_100_usd

unit_incrementintegerRequired
unit_scaleintegerRequired
zero_couponboolean or nullOptional
kindstringRequired
programobject or nullOptional
20 child attributes
authorityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
bridge_subjectstringRequired
broker_namestringRequired
broker_referencestringRequired
custodian_namestringRequired
custodian_referencestringRequired
custody_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
dealersarray of objectsRequired
4 child attributes
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

external_referencestringRequired
identityobjectRequired
legal_namestringRequired
enabledbooleanRequired
evidence_keysobjectRequired
legal_entitystringRequired
master_cash_external_account_referencestringRequired
master_cash_identityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

max_order_amountintegerRequired
policyobjectRequired
10 child attributes
accounting_evidenceobjectRequired
accrual_conventionstringRequired
acquisition_feesstringRequired

Capitalize_direct_acquisition_fees

cash_roundingstringRequired

Half_up_cent

classificationstringRequired

AFS

credit_evidenceobjectRequired
credit_methodstringRequired

Reviewed_afs_credit_assessment

recognitionstringRequired

Trade_date

tax_evidenceobjectRequired
tax_methodstringRequired

Reviewed_external_tax_amounts

providerstringRequired
trading_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

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

A business date, YYYY-MM-DD

close_out_completebooleanRequired
currency_codestringRequired
cusipstringRequired
custodian_referencestringRequired
encumbered_unitsintegerRequired
evidenceobjectRequired
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
external_account_referencestringRequired
fair_value_amountinteger or nullOptional

Actual custody units at supplied price

key_idstringRequired
legal_entitystringRequired
lot_idstringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

observed_atstring · date-timeRequired
original_execution_sha256stringRequired
original_settlement_sha256stringOptional
priceinteger or nullOptional
price_basisstringOptional

Optional actual bid/ask/mid/last source; repo requires bid

signaturestringRequired
unitsintegerRequired

Actual custodian quantity, distinct from trade-date book quantity

valuation_basisstringOptional

Intraday uses start of AsOf; day_close uses start of AsOf+1

versionstringRequired
latest_valuationobject or nullOptional
9 child attributes
actorstringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
notestringRequired
idstringRequired
journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

posting_datestring · date or nullOptional

A business date, YYYY-MM-DD

requestobjectRequired
5 child attributes
inputsobjectRequired

AccountingInputs 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.

12 child attributes
credit_allowance_amountinteger or nullOptional
credit_evidenceobjectRequired
earnings_deferred_tax_asset_amountinteger or nullOptional
earnings_deferred_tax_liability_amountinteger or nullOptional
earnings_tax_valuation_allowance_amountinteger or nullOptional
intent_to_sellboolean or nullOptional
oci_deferred_tax_asset_amountinteger or nullOptional
oci_deferred_tax_liability_amountinteger or nullOptional
oci_tax_valuation_allowance_amountinteger or nullOptional
required_to_sell_before_recoveryboolean or nullOptional
tax_basis_amountinteger or nullOptional
tax_evidenceobjectRequired
lot_idstringRequired
lot_revisionintegerRequired
observationobjectRequired
23 child attributes
accrued_income_amountinteger or nullOptional
as_ofstring · dateRequired

A business date, YYYY-MM-DD

close_out_completebooleanRequired
currency_codestringRequired
cusipstringRequired
custodian_referencestringRequired
encumbered_unitsintegerRequired
evidenceobjectRequired
external_account_referencestringRequired
fair_value_amountinteger or nullOptional

Actual custody units at supplied price

key_idstringRequired
legal_entitystringRequired
lot_idstringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

observed_atstring · date-timeRequired
original_execution_sha256stringRequired
original_settlement_sha256stringOptional
priceinteger or nullOptional
price_basisstringOptional

Optional actual bid/ask/mid/last source; repo requires bid

signaturestringRequired
unitsintegerRequired

Actual custodian quantity, distinct from trade-date book quantity

valuation_basisstringOptional

Intraday uses start of AsOf; day_close uses start of AsOf+1

versionstringRequired
rationalestringRequired
resultobjectRequired
12 child attributes
accrual_to_datestring · dateRequired

A business date, YYYY-MM-DD

amortized_cost_amountintegerRequired
as_ofstring · dateRequired

A business date, YYYY-MM-DD

credit_allowance_amountintegerRequired
deferred_tax_asset_amountintegerRequired

Net of reviewed valuation allowances

deferred_tax_liability_amountintegerRequired
fair_value_adjustment_amountintegerRequired
fair_value_amountintegerRequired
net_oci_amountintegerRequired
pretax_oci_amountintegerRequired
tax_earnings_amountintegerRequired

Positive cumulative benefit, negative expense

tax_oci_amountintegerRequired
legal_entitystringRequired
original_cost_amountintegerRequired
programobjectRequired
9 child attributes
actorstringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
custody_accountobject or nullOptional
18 child attributes
bank_ownedbooleanRequired
custodian_referencestringRequired
enabledbooleanRequired
exclusive_core_instructionsbooleanRequired
external_account_referencestringRequired
key_idstringRequired
legal_entitystringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

no_third_party_lienbooleanRequired
observed_atstring · date-timeRequired
onboardingobjectRequired
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
opening_inventory_emptybooleanRequired
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
16 child attributes
currency_codestringRequired
cusipstringRequired
eligibilityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
enabledbooleanRequired
face_value_amountintegerRequired

Cents per whole unit

issue_datestring · dateRequired

A business date, YYYY-MM-DD

kindstringRequired

Treasury_bill

maturity_datestring · dateRequired

A business date, YYYY-MM-DD

namestringRequired
price_scaleintegerRequired
program_idstringRequired
termsobjectRequired
3 child attributes
datastring · byteRequired
formatstringRequired
sha256stringRequired
unit_basisstringRequired

Face_100_usd

unit_incrementintegerRequired
unit_scaleintegerRequired
zero_couponboolean or nullOptional
kindstringRequired
programobject or nullOptional
20 child attributes
authorityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
bridge_subjectstringRequired
broker_namestringRequired
broker_referencestringRequired
custodian_namestringRequired
custodian_referencestringRequired
custody_agreementobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
dealersarray of objectsRequired
4 child attributes
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

external_referencestringRequired
identityobjectRequired
legal_namestringRequired
enabledbooleanRequired
evidence_keysobjectRequired
legal_entitystringRequired
master_cash_external_account_referencestringRequired
master_cash_identityobjectRequired
2 child attributes
referencestringRequired
sha256stringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

max_order_amountintegerRequired
policyobjectRequired
10 child attributes
accounting_evidenceobjectRequired
accrual_conventionstringRequired
acquisition_feesstringRequired

Capitalize_direct_acquisition_fees

cash_roundingstringRequired

Half_up_cent

classificationstringRequired

AFS

credit_evidenceobjectRequired
credit_methodstringRequired

Reviewed_afs_credit_assessment

recognitionstringRequired

Trade_date

tax_evidenceobjectRequired
tax_methodstringRequired

Reviewed_external_tax_amounts

providerstringRequired
trading_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
redemption_idstringOptional
reservation_revisionintegerOptional
reserved_order_idstringOptional
reserved_redemption_idstringOptional
revisionintegerRequired
scheduleobjectRequired
5 child attributes
conventionstringRequired
cost_amountintegerRequired
face_amountintegerRequired
maturity_datestring · dateRequired

A business date, YYYY-MM-DD

start_datestring · dateRequired

A business date, YYYY-MM-DD

settlement_datestring · date or nullOptional

A business date, YYYY-MM-DD

settlement_sha256stringOptional
statusstringRequired

Unsettled, active, selling, sold_unsettled, sold, redeeming, redeemed, exception

trade_datestring · dateRequired

A business date, YYYY-MM-DD

trade_journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

unitsintegerRequired

Original full quantity; disposition never rewrites it

to move to open esc to close