Get Cash Due Schedule
GET/api/vendor-deposits/cash-due-schedule
Cash due schedule for deposit obligations, combining existing deposits and projected payment-term milestones on open purchase orders. Rows are grouped into sections: due_now (triggered and due or overdue), due_within_30_days, upcoming_by_trigger (dated but trigger not yet reached), undated, late_shipments, and shortfalls.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Each section row describes the obligation: source_type (deposit or installment), deposit/PO references, milestone label, trigger event, due date, amounts in the deposit currency and the tenant currency, and flags (has_triggered, is_ready_to_pay, is_overdue).
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.