Request Sandbox KeysSee a Demo
  • Overview
    • Quickstart
    • Payments and Disbursements
    • Errors
    • Webhooks
  • Guides
    • Compliance
    • Starter Mode
    • KYC
    • Line of Credit program
    • Buy Now Pay Later program
  • API Reference
LogoLogo
Request Sandbox KeysSee a Demo
API ReferenceFacilities

List statements for a facility

GET
/facilities/:facility_id/statements
GET
/api/facilities/:facility_id/statements
1curl https://production.pier-finance.com/api/facilities/fac_18e5a3726b3943cda2635f40e1041ba4/statements \
2     -H "Authorization: Bearer <token>"
Try it
200Retrieved
1[
2  {
3    "id": "stmt_deb6aba913d84feb987934f50c32bf03",
4    "statement_date": "2023-03-17",
5    "statement_start_date": "2024-06-17T00:00:00.000Z",
6    "balance_due": 500000,
7    "current_principal_balance": 500000,
8    "current_interest_balance": 10000,
9    "interest_charged": 0,
10    "due_date": "2023-03-17",
11    "transactions": [
12      {
13        "amount": 100000,
14        "net_amount": 100000,
15        "transaction_date": "2023-05-12",
16        "effective_date": "2023-05-12",
17        "description": "Disbursement",
18        "category": "DISBURSEMENT",
19        "transaction_type": "DEBIT",
20        "transaction_iso_timestamp": "2023-05-12T00:00:00.000Z"
21      },
22      {
23        "amount": 500000,
24        "net_amount": -500000,
25        "transaction_date": "2024-06-02",
26        "effective_date": "2024-06-02",
27        "description": "Principal Reduction",
28        "category": "PRINCIPAL_REDUCTION",
29        "transaction_type": "CREDIT",
30        "transaction_iso_timestamp": "2023-05-12T00:00:00.000Z"
31      }
32    ],
33    "payments": [
34      {
35        "id": "pmt_18e5a3726b3943cda2635f40e1041ba4",
36        "amount": 100000,
37        "facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
38        "status": "settled",
39        "transfer_type": "standard",
40        "created_on": "2023-02-27T00:00:00Z",
41        "is_autopay": false
42      }
43    ],
44    "disbursements": [
45      {
46        "id": "dsb_18e5a3726b3943cda2635f40e1041ba4",
47        "facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
48        "amount": 100000,
49        "status": "pending",
50        "created_on": "2023-02-27T00:00:00Z",
51        "transfer_type": "standard",
52        "failure_reason": null,
53        "date": "2023-02-27"
54      }
55    ],
56    "facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
57    "url": "https://app.docspring.com/submissions/sub_gjX2LS7c6FjqZt12hQ/download",
58    "created_on": "2023-02-27T00:00:00Z"
59  }
60]
List statements for a facility
Was this page helpful?
Previous

Retrieve a disbursement by its id

Next
Built with
Retrieve a disbursement by its id
List statements for a facility

Authentication

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

Path parameters

facility_idstringRequired
The facility_id of the facility you want to list statements for

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

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

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

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

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

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

The facility_id of the facility you want to list statements for