Statement Object Details

Statement Schema

Key

Type

Required

Description

_id

String

N.A. Included in API response

Primary Key of the user object.

client.id

String

N.A. Included in API response

The Primary Key that denotes your client object in our system.

client.name

String

N.A. Included in API response

Your common name in our system.

ending_balance

Number

N.A. Included in API response

Ending balance of the node for this statement cycle.

opening_balance

String

N.A. Included in API response

Starting balance of the node for this statement cycle.

end_date

Number

Yes

Unix timestamp (in ms) value of the end date of cycle for this statement cycle.

start_date

Number

Yes

Unix timestamp (in ms) value of the start date of cycle for this statement cycle.

urls.csv

String

N.A. Included in API response

URL of the csv version of the statement.

urls.pdf

String

N.A. Included in API response

URL of the pdf version of the statement.

urls.json

String

N.A. Included in API response

URL of the json version of the statement.

type

String

N.A. Included in API response

Type of statement. Possible types:

  • On Demand Requests (ex:ONDEMAND_STATEMENT)

  • Monthly Statements (ex: JANUARY_2021_STATEMENT)

  • 1099-INT Tax Forms (ex: 1099_INT_2020)

Last updated