Create a one-time payment item

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

Create a one-time payment item for the cash forecast.

Request Body:

  • label: Short description (e.g. "Q2 estimated tax").
  • amount_cents: Positive = cash in, negative = cash out.
  • applies_on: ISO date the cash event lands on.
  • notes: Optional free-form notes.

Effect: The item appears in the forecast week whose Sunday window contains applies_on. The forecast's one_time_cents column on that week is incremented by amount_cents.

Operation ID: cfo_portal_create_one_time_item_api_v1_businesses__business_id__cfo_portal_cash_forecast_one_time_items_post · 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

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

Responses

201 Successful Response

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

detail array · ValidationError ValidationError
5 fields
loc array · string | integer required
msg string required
type string required
input object
ctx object