Update order

PUT/api/v1/orders/{order_id}

Update a draft or sent order (optionally replacing all lines).

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

order_idstringrequired

Request body

Schema: OrderUpdate

customer_idstring
project_idstring
order_descriptionstring
order_start_datestring
first_invoice_datestring
term_monthsinteger
discount_centsinteger
tax_treatmentstring
linesarray · OrderLineInput: Replace all lines when provided.

Responses

200Successful Response

Schema: app__core__success__SuccessEnvelope_OrderResponse___1

successboolean
messagestring
codestring
dataapp__api__v1__schemas__orders__OrderResponse

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

Code samples

PUT/api/v1/orders/{order_id}

bash

curl -X PUT 'https://api.ondayzero.com/api/v1/orders/{order_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "customer_id": "string",
  "project_id": "string",
  "order_description": "string",
  "order_start_date": "string",
  "first_invoice_date": "string",
  "term_months": 0
}'