Get CFO 13-week cash forecast

GET/api/v1/businesses/{business_id}/cfo-portal/cash-forecast

Get the cash forecast section with optional budget selection.

Operation ID: cfo_portal_get_cash_forecast_api_v1_businesses__business_id__cfo_portal_cash_forecast_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

business_idstringrequired

Query

budget_idstring
apply_overridesbooleandefault: False

When true, the working override scope is folded into the computed cell values. Used by the Demand Planner tab. The live Cash Flow Forecast tab leaves this off so unsaved what-if values don't bleed across views.

include_projected_replenishmentbooleandefault: False

When true, projected (not-yet-placed) replenishment POs from the SKU demand-forecast engine are added to a separate Projected Inventory row so operators see the cash impact of reorders they'll need to make. Off by default to keep the live Forecast tab byte-identical.

Responses

200Successful Response

successboolean
messagestring
codestring
dataCfoPortalSectionResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject