Facilities

List statements for a facility

GET
List statements for a facility

Path parameters

facility_idstringRequired

The facility_id of the facility you want to list statements for

Response

This endpoint returns a list of objects
id
string
The id of the statement
statement_date
string
The end date of the statement (YYYY-MM-DD)
statement_start_date
datetime
The start date of the statement (YYYY-MM-DD)
balance_due
integer
The balance due at the time of statement creation, in cents
current_principal_balance
integer
The principal balance of the statement, in cents
current_interest_balance
integer
The interest balance of the statement, in cents
interest_charged
integer
The interest balance of the statement, in cents
minimum_payment
integer
The minimum payment due, in cents
due_date
string
The due date of the statement (YYYY-MM-DD)
transactions
list of objects
An array of transactions made (scoped to the period of the statement)
payments
list of objects
An array of payments made (scoped to the period of the statement)
disbursements
list of objects
An array of disbursements made (scoped to the period of the statement)
facility_id
string
url
string
The url of the statement pdf
created_on
datetime
Timestamp the statement object is created on

Errors

Built with