Statements Object

KeyTypeDescription
error_codestringSee Common Errors for more information
http_codestringSee Common Errors for more information
limitintegerNumber of statements per page
pageintegerPage number
page_countintegerNumber of pages
statements[ ]array of objectsList of statement objects
statements_countintegerTotal number of statements
successbooleanRequest success

Statement Object

KeyTypeDescription
_id stringThe Object ID of the statement.
client_id stringThe Client ID.
date_end integer (milliseconds since Unix epoch time)End date of statement period.
date_start integer (milliseconds since Unix epoch time)Start date of the statement period.
urlslist of objectsObject containing list of URLs to view statements in various formats.
urls.csvstring or array of stringsURL to view statement in CSV format.
urls.pdfstringURL to view statement in PDF format.
urls.jsonstring or array of stringsURL to view statement in JSON format.
node_id stringThe Node ID for the statement.
user_id stringThe User ID for the statement.
linkstringFor certain types of documents we will only provide a single link to the immutable PDF version. In these cases multiple document formats will not be provided in the urls field, and the type field will be returned. More details below.
type stringThe type of the statement. For instance, type will be 1099_INT_2019 for end-of-year 1099-INT tax forms generated for accounts that earn more than $10 in interest (click here for additional details).

Supported Node Types

  • CLEARING-US
  • CRYPTO-US
  • CUSTODY-US
  • DEPOSIT-US
  • IB-DEPOSIT-US
  • IB-SUBACCOUNT-US
  • LOAN-US
  • RESERVE-US
  • SUBACCOUNT-US

Statement Frequency

Except for revolving, statements are available on the 15th of every month for the previous month. For example, statements for the month of January will be available on February 15th.

Statements for revolving loans are available on the 7th of every month for the month prior.

Statement Formats

View an example statement. Statements will be available in three different formats: csv, pdf, and json.

The statement object's url fields may be returned as either strings or arrays of strings depending on the length of the statement. If it's large enough, it will be split into parts. The PDF will always be a string but the CSV and JSON can be a string or arrays of multiple strings.

Statements will list the following:

  • Starting and ending balance
  • Platform contact information
  • List of transactions
  • Error resolution information
Language