Update a one-time payment item

PATCH /api/v1/businesses/{business_id}/cfo-portal/cash-forecast/one-time-items/{item_id}

Partially update a one-time payment item.

Any field omitted from the body is left unchanged.

Operation ID: cfo_portal_update_one_time_item_api_v1_businesses__business_id__cfo_portal_cash_forecast_one_time_items__item_id__patch · 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
item_id string required

Request body

Schema: CashForecastOneTimeItemUpdate

label string
amount_cents integer
applies_on string · date
notes string

Responses

200 Successful Response

Schema: CashForecastOneTimeItem

label string required
amount_cents integer required: Positive = cash in, negative = cash out. Integer cents.
applies_on string · date required: Date the cash event lands. The week index is derived from this date relative to the forecast's first Sunday.
notes string
id string required
business_id string required
created_by_user_id string
created_at string · date-time required
updated_at string · date-time required

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

PATCH /api/v1/businesses/{business_id}/cfo-portal/cash-forecast/one-time-items/{item_id}

bash

curl -X PATCH 'https://api.ondayzero.com/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/one-time-items/{item_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "label": "string",
  "amount_cents": 0,
  "applies_on": "2026-01-01",
  "notes": "string"
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/one-time-items/{item_id}', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "label": "string",
  "amount_cents": 0,
  "applies_on": "2026-01-01",
  "notes": "string"
}),
});
const data = await response.json();

python

import httpx

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

payload = {
  "label": "string",
  "amount_cents": 0,
  "applies_on": "2026-01-01",
  "notes": "string"
}

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