Get Upcoming Liability Report
GET/api/vendor-deposits/upcoming-liability
Upcoming deposit liabilities: every outstanding deposit obligation (existing deposits plus projected payment-term milestones on open purchase orders), sorted with overdue and ready-to-pay rows first. Rows with no due date are returned separately in undated_rows.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
The summary aggregates the tenant-currency exposure: total outstanding, overdue, due in the next 7 and 30 days, ready to pay, and blocked (trigger event not yet reached).
"Today" (used for the overdue and upcoming buckets) is the current date in the account's timezone.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.