Facilities

List statements for a facility

get/facilities/{facility_id}/statements

Request

Base URL
https://production.pier-finance.com/api
Auth
HTTP bearer

Path parameters

facility_idstring required

The facility_id of the facility you want to list statements for

Response

idstring required

The id of the statement

statement_datestring required

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

statement_start_datestring date-time required

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

balance_dueinteger required

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

current_principal_balanceinteger required

The principal balance of the statement, in cents

current_interest_balanceinteger required

The interest balance of the statement, in cents

interest_chargedinteger required

The interest balance of the statement, in cents

due_datestring required

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

facility_idstring required

urlstring required

The url of the statement pdf

created_onstring date-time required

Timestamp the statement object is created on

Example response

[
  {
    "id": "stmt_deb6aba913d84feb987934f50c32bf03",
    "statement_date": "2023-03-17",
    "statement_start_date": "2024-06-17T00:00:00.000Z",
    "balance_due": 500000,
    "current_principal_balance": 500000,
    "current_interest_balance": 10000,
    "due_date": "2023-03-17",
    "payments": [
      {
        "amount": 100000,
        "facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
        "created_on": "2023-02-27T00:00:00Z"
      }
    ],
    "disbursements": [
      {
        "id": "dsb_18e5a3726b3943cda2635f40e1041ba4",
        "amount": 100000,
        "created_on": "2023-02-27T00:00:00Z"
      }
    ],
    "url": "https://app.docspring.com/submissions/sub_gjX2LS7c6FjqZt12hQ/download",
    "created_on": "2023-02-27T00:00:00Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.