Skip to content

Update a change order line

Finance module

PATCH/change-order-lines/{id}changeOrderLines.update

A line of a change order. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability finance.change_order.price.
  • OAuth scopes: finance.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

changeOrderLines.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the change order line.

Request body: ChangeOrderLineUpdate

changeOrderLines.update: ChangeOrderLineUpdate
FieldTypeRequiredDescription
budget_line_idstring (uuid) | nullNoIdentifier of the affected budget line.
uridUridAtAnyGrainNoURID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Constraints: pattern ^[0-9]000(\.[0-9]{2}){1,2}$
descriptionstringNoLine description.Constraints: length 1 to 300
quantitynumberNoQuantity; defaults to 1.
unit_price_minorinteger (int64) | nullNoUnit price; null when unpriced. Integer minor units of the resource currency; null means unpriced, never zero.
is_no_costbooleanNoWhether the line is deliberately free of charge.
{
  "budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Bar build and dressing",
  "quantity": 24,
  "unit_price_minor": 1200000,
  "is_no_cost": false
}

Response 200: ChangeOrderLine

changeOrderLines.update: ChangeOrderLine
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the change order line.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
change_order_idstring (uuid)YesIdentifier of the change order.
budget_line_idstring (uuid) | nullYesIdentifier of the affected budget line.
uridUridAtAnyGrainYesURID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Constraints: pattern ^[0-9]000(\.[0-9]{2}){1,2}$
descriptionstringYesLine description.Constraints: length 1 to 300
quantitynumberYesQuantity; defaults to 1.
unit_price_minorinteger (int64) | nullYesUnit price; null when unpriced. Integer minor units of the resource currency; null means unpriced, never zero.
is_no_costbooleanYesWhether the line is deliberately free of charge.
account_codeGlAccountCode | nullYes
cost_center_idstring (uuid) | nullYesIdentifier of the cost center (dimension 1) of the budget line the change revises.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "change_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "urid": "4000.01",
  "description": "Bar build and dressing",
  "quantity": 24,
  "unit_price_minor": 1200000,
  "is_no_cost": false,
  "account_code": "5400",
  "cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/change-order-lines/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"budget_line_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Bar build and dressing","quantity":24,"unit_price_minor":1200000,"is_no_cost":false}'
const { data, etag } = await xos.changeOrderLines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "description": "Bar build and dressing",
    "quantity": 24,
    "unit_price_minor": 1200000,
    "is_no_cost": false
  }, { ifMatch: etag });
response = xos.change_order_lines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "description": "Bar build and dressing", "quantity": 24, "unit_price_minor": 1200000, "is_no_cost": False}, if_match=etag)
xos change-order-lines update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"budget_line_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Bar build and dressing","quantity":24,"unit_price_minor":1200000,"is_no_cost":false}' --if-match auto