increase-test
POST/simulations/account_statements

Sandbox: Create an Account Statement

Simulates an Account Statement being created for an account. In production, Account Statements are generated once per month.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field
account_idstringrequired
The identifier of the Account the statement is for.

3 status codes
200Account Statement
account_idstringrequired
The identifier for the Account this Account Statement belongs to.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account Statement was created.
ending_balanceintegerrequired
The Account's balance at the end of its statement period.
file_idstringrequired
The identifier of the File containing a PDF of the statement.
idstringrequired
The Account Statement identifier.
loanobjectrequired
The loan balances.
starting_balanceintegerrequired
The Account's balance at the start of its statement period.
statement_period_endstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end of the period the Account Statement covers.
statement_period_startstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the start of the period the Account Statement covers.
typestringrequired
A constant representing the object's type. For this resource it will always be `account_statement`.
Allowed:account_statement
4XXError
5XXError