Generate a draft statement from the ledger

POST/accounts/{id}/statements/{period}/generations

Path parameters

idstringRequired

periodstringRequired

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Returns

200 OK

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

closing_amountintegerRequired

documentobject or nullOptional

26 child attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

account_number_last4stringRequired

addressstringRequired

apy_earned_percentstringRequired

average_daily_balance_amountintegerRequired

bankobjectRequired

5 child attributes

addressstringRequired

error_noticestringRequired

localbooleanRequired

namestringRequired

phonestringRequired

closing_amountintegerRequired

correctionobject or nullOptional

3 child attributes

replaces_idstringRequired

replaces_issued_atstring · date-timeRequired

summarystringRequired

currency_codestringRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

customer_namestringRequired

daysintegerRequired

feesarray of objectsRequired

4 child attributes

amountintegerRequired

datestring · dateRequired

A business date, YYYY-MM-DD

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired

final_statementbooleanOptional

fromstring · dateRequired

A business date, YYYY-MM-DD

generated_atstring · date-timeRequired

interest_earned_amountintegerRequired

interest_paid_amountintegerRequired

linesarray of objectsRequired

8 child attributes

balance_amountintegerRequired

credit_amountintegerRequired

datestring · dateRequired

A business date, YYYY-MM-DD

debit_amountintegerRequired

descriptionstringRequired

detailobject or nullOptional

5 child attributes

counterpartystringRequired

descriptionstringRequired

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

locationstringOptional

terminalbooleanRequired

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired

opening_amountintegerRequired

periodstringRequired

period_feesobjectRequired

2 child attributes

overdraft_amountintegerRequired

returned_item_amountintegerRequired

productstringRequired

throughstring · dateRequired

A business date, YYYY-MM-DD

versionintegerRequired

year_feesobjectRequired

2 child attributes

overdraft_amountintegerRequired

returned_item_amountintegerRequired

idstringRequired

Example stmt_2tVh8nqLxq4GbDe0K1F6S9zRcWm

linesobjectRequired

opening_amountintegerRequired

periodstringRequired

Errors

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

400401403404409412413422424429500503