Update Cash Forecast configuration

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

Save Cash Forecast settings (excluded budget ledgers).

Operation ID: cfo_portal_update_cash_forecast_settings_api_v1_businesses__business_id__cfo_portal_cash_forecast_settings_put · 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_id string required

Request body

Schema: CashForecastSettingsUpdateRequest

excluded_budget_ledger_ids array · string: List of ledger IDs to exclude from budget projections

Responses

200 Successful Response

Schema: CfoPortalSectionResponse

business_id string required

section string required

generated_at string · date-time required

start_date string · date

end_date string · date

sources array · CfoPortalSource CfoPortalSource

4 fields

key string required
label string required
status string: available, empty, partial, or unavailable
message string

data object

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

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

bash

curl -X PUT 'https://api.ondayzero.com/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/settings' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "excluded_budget_ledger_ids": []
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/settings', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "excluded_budget_ledger_ids": []
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "excluded_budget_ledger_ids": []
}

response = httpx.put("https://api.ondayzero.com/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/settings", headers=headers, json=payload)
data = response.json()