The Physical Cash object

Actual vault, teller and ATM custody balances, independently reviewed movements, complete count evidence, armored carrier shipments and close blockers. Hardware dispensing/PIN certification is a separate provider contract. The armoredcarrier package is a local simulator, not a licensed carrier.

Attributes

account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

actorstringRequired

agent_ofstringOptional

Owner the conductor acts for as an agent

amountintegerRequired

business_datestring · dateRequired

A business date, YYYY-MM-DD

conductor_customer_idstringOptional

Identified natural-person customer physically conducting the movement for a different owner

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

conductor_non_customer_idstringOptional

Natural person without a customer record; exclusive of conductor_customer_id

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

count_idstringOptional

created_atstring · date-timeRequired

customer_idstringOptional

Identified owner conducting a customer cash movement, or the owner for whom the conductor acts

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

decisionobject or nullOptional

4 child attributes

actorstringRequired

approvebooleanRequired

evidencestringRequired

recorded_atstring · date-timeRequired

delivery_methodstringOptional

Armored_car, mail, night_deposit, shared_branch

evidencestringRequired

evidence_sha256stringRequired

executionobject or nullOptional

5 child attributes

actorstringRequired

credit_idstringOptional

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

movement_idstringRequired

recorded_atstring · date-timeRequired

foreign_amount_minorintegerOptional

foreign_countrystringOptional

foreign_currencystringOptional

ISO 4217 of counted foreign cash; AmountMinor is the USD equivalent

from_unit_idstringOptional

idstringRequired

journalobjectRequired

18 child attributes

adjusts_periodstringOptional

A sealed period this journal corrects, YYYY-MM

approved_bystringOptional

backdatedbooleanOptional

Effective_date is before posting_date (read only)

committed_atstring · date-timeOptional

effective_datestring · dateRequired

A business date, YYYY-MM-DD

entriesarray of objectsRequired

4 child attributes

amountintegerRequired

Minor units of the currency (cents for USD)

currency_codestringRequired

ISO 4217 code

directionstringRequired

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

fx_legsarray of objectsOptional

FXLegs is read only: the legs of a cross-currency journal the ledger's own conversion and close commands posted. A caller's posting never carries them.

7 child attributes

currency_codestringRequired

equivalent_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

native_amountintegerRequired

position_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

rate_sheet_idstringRequired

usd_equivalent_amountintegerRequired

usd_per_foreign_majorstringRequired

idstringOptional

kindstringRequired

posted_bystringOptional

posting_datestring · dateOptional

A business date, YYYY-MM-DD

protected_command_idstringOptional

reasonstringOptional

Required on a backdated journal

release_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

require_availablebooleanOptional

reversal_ofstringOptional

source_refstringRequired

source_servicestringRequired

kindstringRequired

Shipment_in, shipment_out, transfer, deposit, withdrawal, adjustment

referencestringRequired

to_unit_idstringOptional