Corgi BankDocumentation
OpenAPI

Complete statement financial cut with sealed history or immutable final closure evidence

GET/ledger/accounts/{id}/statement-snapshot

Path parameters

idstringRequired

Query parameters

periodstringOptional

Returns

200 OK

carry_afterstringRequired
closing_amountintegerRequired
creditsarray of objectsRequired
9 child attributes
earned_fromstring · dateRequired

A business date, YYYY-MM-DD

earned_periodstringRequired
earned_throughstring · dateRequired

A business date, YYYY-MM-DD

effective_datestring · dateRequired

A business date, YYYY-MM-DD

gross_amountintegerRequired
journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

posting_datestring · dateRequired

A business date, YYYY-MM-DD

recorded_atstring · date-timeRequired
source_kindstringRequired
currency_codestringRequired
cut_idstringRequired
earned_exactstringRequired
entriesarray of objectsRequired
13 child attributes
amountintegerRequired
directionstringRequired
effective_datestring · dateRequired

A business date, YYYY-MM-DD

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired
original_source_refstringOptional
posting_datestring · dateRequired

A business date, YYYY-MM-DD

recorded_atstring · date-timeRequired
reversal_ofstringOptional
running_amountintegerRequired
sequenceintegerRequired
source_refstringRequired
source_servicestringRequired
finalbooleanRequired
fromstring · dateRequired

A business date, YYYY-MM-DD

interest_basisarray of objectsRequired
2 child attributes
amountintegerRequired
datestring · dateRequired

A business date, YYYY-MM-DD

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

opening_amountintegerRequired
periodstringRequired
proofobjectRequired
8 child attributes
closureobject or nullOptional
18 child attributes
accrual_journal_idstringOptional

Brings the accrued liability to the interest paid

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

closing_fee_amountintegerRequired
datestring · dateRequired

A business date, YYYY-MM-DD

fee_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

forgiven_intereststringOptional

Forgiven is interest the customer was overpaid (a correction left the plan's accrual negative) and the closure wrote off, as a positive decimal: the ledger never debits a customer for interest, so the bank bears it and the liability returns to zero.

interest_amountintegerRequired
interest_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

keystringRequired
ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payout_amountintegerRequired
payout_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payout_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

principal_amountintegerRequired
remittance_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

remitted_amountintegerRequired
rounding_adjustmentstringRequired
withheld_amountintegerRequired
withholding_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

eod_proof_sha256stringRequired
history_fromstring · dateRequired

A business date, YYYY-MM-DD

interest_applicabilitystringRequired
kindstringRequired
monthly_completion_sha256stringRequired
monthly_result_sha256stringRequired
sealsarray of objectsRequired
2 child attributes
periodstringRequired
sha256stringRequired
throughstring · dateRequired

A business date, YYYY-MM-DD

versionintegerRequired
ytd_feesarray of objectsRequired
13 child attributes
amountintegerRequired
directionstringRequired
effective_datestring · dateRequired

A business date, YYYY-MM-DD

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired
original_source_refstringOptional
posting_datestring · dateRequired

A business date, YYYY-MM-DD

recorded_atstring · date-timeRequired
reversal_ofstringOptional
running_amountintegerRequired
sequenceintegerRequired
source_refstringRequired
source_servicestringRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close