The Journal object

A balanced set of debit and credit entries, append-only, with an idempotency key and an effective business date.

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