Get Cash Flow Forecast
GET/api/vendor-deposits/cash-flow-forecast
Forecast of upcoming cash outflows from unpaid deposit obligations, bucketed by day, week, or month. Buckets include existing deposits and projected payment-term milestones on open purchase orders, keyed by due date.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Defaults: date_from = today, date_to = six months out, granularity = month. Undated obligations (no due date yet) are listed separately in undated_rows; coverage shortfalls appear in shortfall_rows.
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.