Account Statements

Account Statements are generated monthly for every active Account. You can access the statement’s data via the API or retrieve a PDF with its details via its associated File.

Events

Your application can listen to webhooks about this resource. All of the events about Account Statements will have the category "account_statement.created" .

The Account Statement object

{
  "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"
}

Attributes

account_id

string

The identifier for the Account this Account Statement belongs to.

More about Accounts.

created_at

string

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

ending_balance

integer

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

file_id

string

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

More about Files.

string

The Account Statement identifier.

loan

dictionary

Nullable

The loan balances.

starting_balance

integer

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

statement_period_end

string

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

statement_period_start

string

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

type

string

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

List Account Statements

curl \
  --url "${INCREASE_URL}/account_statements?account_id=account_in71c4amph0vgo2qllky" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Account Statement object */ },
    { /* Account Statement object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

account_id

string

Filter Account Statements to those belonging to the specified Account.

More about Accounts.

cursor

string

limit

integer

statement_period_start.after

string

statement_period_start.before

string

statement_period_start.on_or_after

string

statement_period_start.on_or_before

string

Retrieve an Account Statement

curl \
  --url "${INCREASE_URL}/account_statements/account_statement_lkc03a4skm2k7f38vj15" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

account_statement_id

string

Required

The identifier of the Account Statement to retrieve.

More about 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.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/account_statements" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky"
  }'

Parameters

account_id

string

Required

The identifier of the Account the statement is for.

More about Accounts.