Get balance report

GET

/reconciliation/balance-report/:date

GET

/api/reconciliation/balance-report/:date

1 curl https://production.pier-finance.com/api/reconciliation/balance-report/2024-10-01 \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "facility_balances": [
3     {
4       "facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
5       "borrower_id": "bor_a1d0c30d77104f35b4c842b99132624e",
6       "report_date": "2024-10-01",
7       "balance": 100000,
8       "payoff_balance": 100000,
9       "current_balance": 100000,
10       "interest_balance": 0,
11       "in_grace_period": true,
12       "in_introductory_promo_period": false
13     }
14   ],
15   "cadence": "daily",
16   "type": "balance",
17   "report_date": "2024-10-01",
18   "last_updated": "2024-10-02T00:00:00Z"
19 }

Get the balance report for all facilities for a Pier partner for a specific day. The report contains the balance EOD in Pacific Time.

Was this page helpful?

Get transaction reportGet transaction report

Built with

Get transaction report

Get the balance report for all facilities for a Pier partner for a specific day. The report contains the balance EOD in Pacific Time.

Authentication

AuthorizationBearer

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

Path parameters

datestringRequired

An ISO 8601 date string in the format YYYY-MM-DD

Response

This endpoint returns an object.

facility_balanceslist of objects

This is a list of balance reports for all the facilities for the given date.

cadenceenum

The cadence that the report is generated in. For now, "daily" cadence is the only one that exists.

Allowed values:

typeenum

The type of report that is being generated. For now, "balance" is the only type that exists.

Allowed values:

report_datestring

The date of the report - this is the same as the date in the path parameter.

last_updateddatetime

The timestamp when the report was last updated.

Errors

The date of the report - this is the same as the date in the path parameter.

An ISO 8601 date string in the format YYYY-MM-DD

1	curl https://production.pier-finance.com/api/reconciliation/balance-report/2024-10-01 \
2	-H "Authorization: Bearer <token>"

1	{
2	"facility_balances": [
3	{
4	"facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
5	"borrower_id": "bor_a1d0c30d77104f35b4c842b99132624e",
6	"report_date": "2024-10-01",
7	"balance": 100000,
8	"payoff_balance": 100000,
9	"current_balance": 100000,
10	"interest_balance": 0,
11	"in_grace_period": true,
12	"in_introductory_promo_period": false
13	}
14	],
15	"cadence": "daily",
16	"type": "balance",
17	"report_date": "2024-10-01",
18	"last_updated": "2024-10-02T00:00:00Z"
19	}