Weekly cash-inflow forecast

GET/api/v1/contracts/cash-flow-forecast

Forward-looking weekly cash-inflow forecast projected from each live contract's order-line billing rules, bucketed into calendar weeks from the current week.

Operation ID: contract_cash_flow_forecast_api_v1_contracts_cash_flow_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

Query

weeksintegerdefault: 13: Number of weeks to project.

Responses

200Successful Response

Schema: SuccessEnvelope_CashFlowForecastResponse_

successboolean
messagestring
codestring
dataCashFlowForecastResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/contracts/cash-flow-forecast

bash

curl -X GET 'https://api.ondayzero.com/api/v1/contracts/cash-flow-forecast' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'