v4

OpenAPI 3.1.02026-08-012402353.8 MB

List Account Statements

get/account_statements

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

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

account_idstring

Filter Account Statements to those belonging to the specified Account.

statement_period_start.afterstring date-time

Return results after this ISO 8601 timestamp.

statement_period_start.beforestring date-time

Return results before this ISO 8601 timestamp.

statement_period_start.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

statement_period_start.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

Response

Account Statement List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": "v57w5d"
}