API Reference — Increase

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.

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",
  "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.

created_at

string

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

ending_balance

integer

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

file_id

string

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

string

The Account Statement identifier.

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

Parameters

cursor

string

Return the page of entries after this one.

limit

integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id

string

Filter Account Statements to those belonging to the specified Account.

statement_period_start.after

string

Return results after this ISO 8601 timestamp.

statement_period_start.before

string

Return results before this ISO 8601 timestamp.

statement_period_start.on_or_after

string

Return results on or after this ISO 8601 timestamp.

statement_period_start.on_or_before

string

Return results on or before this ISO 8601 timestamp.

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.

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.