Sign in

v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-012382333.4 MB

Sandbox: Create an Account Statement

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

post/simulations/account_statements

Request body

account_idstring required

The identifier of the Account the statement is for.

Example request

{
  "account_id": "account_in71c4amph0vgo2qllky"
}

Response

Account Statement

account_idstring required

The identifier for the Account this Account Statement belongs to.

created_atstring date-time required

The ISO 8601 time at which the Account Statement was created.

ending_balanceinteger required

The Account's balance at the end of its statement period.

file_idstring required

The identifier of the File containing a PDF of the statement.

idstring required

The Account Statement identifier.

starting_balanceinteger required

The Account's balance at the start of its statement period.

statement_period_endstring date-time required

The ISO 8601 time representing the end of the period the Account Statement covers.

statement_period_startstring date-time required

The ISO 8601 time representing the start of the period the Account Statement covers.

type'account_statement' required

A constant representing the object's type. For this resource it will always be account_statement.

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "created_at": "2020-01-31T23:59:59Z",
  "ending_balance": 100,
  "file_id": "file_makxrc67oh9l6sg7w9yc",
  "id": "account_statement_lkc03a4skm2k7f38vj15",
  "loan": null,
  "starting_balance": 0,
  "statement_period_end": "2020-01-31T23:59:59Z",
  "statement_period_start": "2020-01-31T23:59:59Z",
  "type": "account_statement"
}