Sandbox: Create an Account Statement

Changed on

Simulates an Account Statement being created for an account. In production, Account Statements are generated once per month. As in production, the simulated statement covers the previous calendar month.

post/simulations/account_statements

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/simulations/account_statements
  • Auth
    HTTP bearer

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. The statement covers all transactions up to, but not including this timestamp. Statement periods are measured in UTC days, so this is usually midnight UTC on the first day of the following month.

statement_period_startstring date-time required

The ISO 8601 time representing the start of the period the Account Statement covers. This is the first moment of the statement period and is inclusive. Statement periods are measured in UTC days, so this is usually midnight UTC on the first day of the month this 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"
}

Changes

  • 64a92a8cc343Revision changes
    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status