Get the cash-flow projection

GET 
/cash-flow

Returns the cash-flow projection for the workspace tied to the token: a series of time buckets (realised + projected income/expenses, running balance) plus current_balance, the today_bucket seam and retroactive_overdue. Requires scope finance.cash_flow. Read-only.

Request

Responses

200

The cash-flow projection.

400

Malformed query (missing/invalid from/to, bad granularity, non-uuid scope id, unknown param).

401

Missing / invalid / expired / revoked token.

403

Token lacks the finance.cash_flow scope, or sub does not match any workspace.

404

The company_id or account_id is not in the tenant.

429

Rate limit exceeded for this token. Reads and writes have separate budgets, both on a 1-hour sliding window. The response carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and Retry-After — wait out Retry-After rather than retrying immediately.

500

Unhandled server error.