API ReferenceFacilities

List statements for a facility

List statements for a facility

Path parameters

facility_idstringRequired

The facility_id of the facility you want to list statements for

Headers

AuthorizationstringRequired

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

Response

This endpoint returns a list of objects.
idstring
The id of the statement
statement_datestring

The end date of the statement (YYYY-MM-DD)

statement_start_datedatetime

The start date of the statement (YYYY-MM-DD)

balance_dueinteger
The balance due at the time of statement creation, in cents
current_principal_balanceinteger
The principal balance of the statement, in cents
current_interest_balanceinteger
The interest balance of the statement, in cents
interest_chargedinteger
The interest balance of the statement, in cents
due_datestring

The due date of the statement (YYYY-MM-DD)

transactionslist of objects

An array of transactions made (scoped to the period of the statement)

paymentslist of objects

An array of payments made (scoped to the period of the statement)

disbursementslist of objects

An array of disbursements made (scoped to the period of the statement)

facility_idstring
urlstring
The url of the statement pdf
created_ondatetime
Timestamp the statement object is created on

Errors