List statements for a facility

GET

/facilities/:facility_id/statements

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

GET

1 curl https://production.pier-finance.com/api/facilities/fac_18e5a3726b3943cda2635f40e1041ba4/statements \
2      -H "Authorization: Bearer <token>"

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         "transaction_type": "DEBIT",
19         "transaction_iso_timestamp": "2023-05-12T00:00:00.000Z"
20       },
21       {
22         "amount": 500000,
23         "net_amount": -500000,
24         "transaction_date": "2024-06-02",
25         "effective_date": "2024-06-02",
26         "description": "Principal Reduction",
27         "transaction_type": "CREDIT",
28         "transaction_iso_timestamp": "2023-05-12T00:00:00.000Z"
29       }
30     ],
31     "payments": [
32       {
33         "id": "pmt_18e5a3726b3943cda2635f40e1041ba4",
34         "amount": 100000,
35         "facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
36         "status": "settled",
37         "transfer_type": "standard",
38         "created_on": "2023-02-27T00:00:00Z",
39         "is_autopay": false
40       }
41     ],
42     "disbursements": [
43       {
44         "id": "dsb_18e5a3726b3943cda2635f40e1041ba4",
45         "facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
46         "amount": 100000,
47         "status": "pending",
48         "created_on": "2023-02-27T00:00:00Z",
49         "transfer_type": "standard",
50         "failure_reason": null,
51         "date": "2023-02-27"
52       }
53     ],
54     "facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
55     "url": "https://app.docspring.com/submissions/sub_gjX2LS7c6FjqZt12hQ/download",
56     "created_on": "2023-02-27T00:00:00Z"
57   }
58 ]

Built with

1	curl https://production.pier-finance.com/api/facilities/fac_18e5a3726b3943cda2635f40e1041ba4/statements \
2	-H "Authorization: Bearer <token>"

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	"transaction_type": "DEBIT",
19	"transaction_iso_timestamp": "2023-05-12T00:00:00.000Z"
20	},
21	{
22	"amount": 500000,
23	"net_amount": -500000,
24	"transaction_date": "2024-06-02",
25	"effective_date": "2024-06-02",
26	"description": "Principal Reduction",
27	"transaction_type": "CREDIT",
28	"transaction_iso_timestamp": "2023-05-12T00:00:00.000Z"
29	}
30	],
31	"payments": [
32	{
33	"id": "pmt_18e5a3726b3943cda2635f40e1041ba4",
34	"amount": 100000,
35	"facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
36	"status": "settled",
37	"transfer_type": "standard",
38	"created_on": "2023-02-27T00:00:00Z",
39	"is_autopay": false
40	}
41	],
42	"disbursements": [
43	{
44	"id": "dsb_18e5a3726b3943cda2635f40e1041ba4",
45	"facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
46	"amount": 100000,
47	"status": "pending",
48	"created_on": "2023-02-27T00:00:00Z",
49	"transfer_type": "standard",
50	"failure_reason": null,
51	"date": "2023-02-27"
52	}
53	],
54	"facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
55	"url": "https://app.docspring.com/submissions/sub_gjX2LS7c6FjqZt12hQ/download",
56	"created_on": "2023-02-27T00:00:00Z"
57	}
58	]