List statements for a facility

get https://production.pier-finance.com/api/facilities/{facility_id}/statements

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

array of objects

object

string

required

The id of the statement

statement_date

string

required

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

statement_start_date

date-time

required

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

balance_due

integer

required

The balance due at the time of statement creation, in cents

current_principal_balance

integer

required

The principal balance of the statement, in cents

current_interest_balance

integer

required

The interest balance of the statement, in cents

interest_charged

integer

required

The interest balance of the statement, in cents

due_date

string

required

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

transactions

array of objects

required

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

FacilityTransactionItems*

object

amount

integer

required

The amount of the transaction, in cents (e.g. 1000 = $10.00)

net_amount

integer

required

The net amount of the transaction, meaning positive or negative depending on the effect on the ledger, in cents (e.g. 1000 = $10.00)

transaction_date

string

required

The date of the transaction (YYYY-MM-DD)

effective_date

string

required

The effective date of the transaction (YYYY-MM-DD)

description

string

required

A description of the transaction

transaction_type

string

required

The type of transaction relative to the effect on the balance (CREDIT = balance decrease; DEBIT = balance increase; NONE = no balance change)

NONE CREDIT DEBIT

transaction_iso_timestamp

date-time

required

The ISO timestamp of the transaction

payments

array of objects

required

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

payments*

object

string

required

amount

integer

required

The amount of the payment, in cents

facility_id

string

required

The facility_id of the credit facility to make a payment for

status

string

required

The status of the payment

pending processing processed settled failed cancelled

transfer_type

string

required

The type of ACH transfer

standard none refund credit cancellation suspense_credit

created_on

date-time

required

Timestamp the payment is created on

failure_reason

string | null

A reason for the failure if one exists

is_autopay

boolean | null

If the payment was a result of an autopay

disbursements

array of objects

required

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

disbursements*

object

string

required

The id of the disbursement

facility_id

string

required

amount

integer

required

The amount of the disbursement, in cents (e.g. 1000 = $10.00)

status

string

required

The status of the disbursement

pending processing processed settled failed cancelled

failure_reason

string | null

A reason for the failure if any exists

date

string | null

The date of the disbursement (YYYY-MM-DD)

created_on

date-time

required

Timestamp the disbursement object is created on

transfer_type

string

required

The type of transfer that the disbursement was (ACH, ledger only, or special cases like refunds)

standard none refund cancellation suspense_refund

facility_id

string

required

url

string

required

The url of the statement pdf

created_on

date-time

required

Timestamp the statement object is created on

429

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://production.pier-finance.com/api/facilities/facility_id/statements \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

400

401

404

500