Skip to main content
GET
Get a statement

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

statement_id
string<uuid>
required

The unique identifier of a statement

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Response

statement

A statement for a depository account

saving_summary
Saving Summary · object
required

A summary of the accrued interest for the saving account in the current period

statement_type
enum<string>
required

The type of statement

Available options:
DEPOSIT,
LINE_OF_CREDIT,
CHARGE_SECURED,
CHARGE_UNSECURED,
CREDIT_CARD
exclude_jit_transactions
boolean
default:false
required

Ignore "JIT funding" transactions when generating a statement

Example:

false

include_child_transactions
boolean
default:false
required

Include transactions from sub-accounts when generating a statement

Example:

false

account_id
string<uuid>
read-only

The unique identifier of the account the statement belongs to

billing_period_id
string<uuid>
read-only

The billing period this statement corresponds to

credit_summary
Credit Summary · object

A summary of the accrued interest for the credit account in the current period.

end_date
string<date>
read-only

The date indicating the ending of the time interval covered by the statement

id
string<uuid>
read-only

statement ID

issue_date
string<date>
read-only

The date when the statement has been issued

security_account_summary
Security Account Summary · object

A summary for the security account backing the credit account.

start_date
string<date>
read-only

The date indicating the beginning of the time interval covered by the statement

account_summary
Account Summary · object
authorized_signers
Person · object[]
read-only
closing_balance
integer<int64>

The account balance at the end of the statement period, in ISO 4217 minor currency units.

customer_service_details
Customer Service Details · object

The customer service details of the fintech partner, e.g. phone number, email address, etc.

disclosure
string
joint_account_holders
Person · object[]
read-only
opening_balance
integer<int64>

The account balance at the start of the statement period, in ISO 4217 minor currency units.

pdf_document_id
string<uuid>
read-only

The ID of the uploaded PDF document in docstore

primary_account_holder_business
object

Represents a business customer.

primary_account_holder_personal
Person · object
total_transactions
integer<int64>

The total number of transactions for this statement period.