Get balance 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.
Path parameters
date
An ISO 8601 date string in the format YYYY-MM-DD
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Response
This endpoint returns an object.
facility_balances
This is a list of balance reports for all the facilities for the given date.
cadence
The cadence that the report is generated in. For now, “daily” cadence is the only one that exists.
Allowed values:daily
type
The type of report that is being generated. For now, “balance” is the only type that exists.
Allowed values:transaction balance
report_date
The date of the report - this is the same as the date in the path parameter.
last_updated
The timestamp when the report was last updated.
Errors
400
Invalid Input Error
401
Unauthorized Error
409
Unable to Acquire Lock Error
412
Reconciliation Report Not yet Available Error
422
Reconciliation Report Invalid Date Error
429
Rate Limit Error
500
Server Error