Skip to main content

Get Cash Flow Month

GET 

/api/v2/cash-flow/month

"What you owe this month": the month's projection row (summary, with sales_in_actual / sales_in_estimated / sales_in_basis) plus every PO, supplier invoice or bill with a payable due that month, and sales_in_estimate (the estimate's inputs).

Required scope: purchase-orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Sales cash-in splits at the tenant's today (app timezone): days before today are ACTUAL booked line-financial revenue (an order-revenue proxy, not bank settlement); today onward is an ESTIMATED payout — the same estimate cash-constrained buying's headroom uses: average daily booked revenue over the trailing 90 days × payout_haircut_pct, landing from today + payout_lag_days. Each row carries sales_in = sales_in_actual + sales_in_estimated and sales_in_basis (actual for a past month, estimated for a future month, mixed for the current month). Before this split, future months showed $0. The calendar always shows the estimate; the include_sales_inflows setting governs only whether headroom spends against it.

Permission: cash_buying.index. Token scope: purchase-orders (read).

Request​

Responses​

OK

Response Headers
    Content-Type