Start free trial

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_idstringrequired

Request body

Schema: CashForecastOneTimeItemCreate

labelstringrequired
amount_centsintegerrequired

Positive = cash in, negative = cash out. Integer cents.

applies_onstring · daterequired

Date the cash event lands. The week index is derived from this date relative to the forecast's first Sunday.

notesstring

Responses

201Successful Response

Schema: SuccessEnvelope_CashForecastOneTimeItem_

successboolean
messagestring
codestring
dataCashForecastOneTimeItem

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

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