Complete statement financial cut with sealed history or immutable final closure evidence
/ledger/accounts/{id}/statement-snapshotPath parameters
idstringRequiredQuery parameters
periodstringOptionalReturns
200 OK
carry_afterstringRequiredclosing_amountintegerRequiredcreditsarray of objectsRequired9 child attributes
earned_fromstring · dateRequiredA business date, YYYY-MM-DD
earned_periodstringRequiredearned_throughstring · dateRequiredA business date, YYYY-MM-DD
effective_datestring · dateRequiredA business date, YYYY-MM-DD
gross_amountintegerRequiredjournal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
posting_datestring · dateRequiredA business date, YYYY-MM-DD
recorded_atstring · date-timeRequiredsource_kindstringRequiredcurrency_codestringRequiredcut_idstringRequiredearned_exactstringRequiredentriesarray of objectsRequired13 child attributes
amountintegerRequireddirectionstringRequiredeffective_datestring · dateRequiredA business date, YYYY-MM-DD
journal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
kindstringRequiredoriginal_source_refstringOptionalposting_datestring · dateRequiredA business date, YYYY-MM-DD
recorded_atstring · date-timeRequiredreversal_ofstringOptionalrunning_amountintegerRequiredsequenceintegerRequiredsource_refstringRequiredsource_servicestringRequiredfinalbooleanRequiredfromstring · dateRequiredA business date, YYYY-MM-DD
interest_basisarray of objectsRequired2 child attributes
amountintegerRequireddatestring · dateRequiredA business date, YYYY-MM-DD
ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
opening_amountintegerRequiredperiodstringRequiredproofobjectRequired8 child attributes
closureobject or nullOptional18 child attributes
accrual_journal_idstringOptionalBrings the accrued liability to the interest paid
Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
closing_fee_amountintegerRequireddatestring · dateRequiredA business date, YYYY-MM-DD
fee_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
forgiven_intereststringOptionalForgiven 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_amountintegerRequiredinterest_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
keystringRequiredledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
payout_amountintegerRequiredpayout_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
payout_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
principal_amountintegerRequiredremittance_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
remitted_amountintegerRequiredrounding_adjustmentstringRequiredwithheld_amountintegerRequiredwithholding_journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
eod_proof_sha256stringRequiredhistory_fromstring · dateRequiredA business date, YYYY-MM-DD
interest_applicabilitystringRequiredkindstringRequiredmonthly_completion_sha256stringRequiredmonthly_result_sha256stringRequiredsealsarray of objectsRequired2 child attributes
periodstringRequiredsha256stringRequiredthroughstring · dateRequiredA business date, YYYY-MM-DD
versionintegerRequiredytd_feesarray of objectsRequired13 child attributes
amountintegerRequireddirectionstringRequiredeffective_datestring · dateRequiredA business date, YYYY-MM-DD
journal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
kindstringRequiredoriginal_source_refstringOptionalposting_datestring · dateRequiredA business date, YYYY-MM-DD
recorded_atstring · date-timeRequiredreversal_ofstringOptionalrunning_amountintegerRequiredsequenceintegerRequiredsource_refstringRequiredsource_servicestringRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503