Skip to content

Update a PO line

Procurement module

PATCH/po-lines/{id}poLines.update

A purchase order line. 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 procurement.po.write.
  • OAuth scopes: procurement.
  • 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

poLines.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the po line.

Request body: PoLineUpdate

poLines.update: PoLineUpdate
FieldTypeRequiredDescription
budget_line_idstring (uuid) | nullNoIdentifier of the budget line.
element_idItemIdNoCatalog item identifier `{URID}-{ORG}-{SEQ}` (Section 3.6).Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}-[A-Z0-9]+-[0-9]+$
descriptionstringNoLine description.Constraints: length 1 to 300
quantitynumberNoQuantity ordered.
unit_basisUnitCode | nullNo
unit_price_minorinteger (int64) | nullNoUnit price. Integer minor units of the resource currency; null means unpriced, never zero.
line_numberintegerNoOrder of the line within the purchase order.Constraints: range 1 to any
{
  "budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Stage deck rental",
  "quantity": 24,
  "unit_price_minor": 4500,
  "line_number": 1
}

Response 200: PoLine

poLines.update: PoLine
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the po 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.
purchase_order_idstring (uuid)YesIdentifier of the purchase order.
budget_line_idstring (uuid) | nullYesIdentifier of the budget line.
element_idItemIdYesCatalog item identifier `{URID}-{ORG}-{SEQ}` (Section 3.6).Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}-[A-Z0-9]+-[0-9]+$
descriptionstringYesLine description.Constraints: length 1 to 300
quantitynumberYesQuantity ordered.
unit_basisUnitCode | nullYes
unit_price_minorinteger (int64) | nullYesUnit price. Integer minor units of the resource currency; null means unpriced, never zero.
line_numberintegerYesOrder of the line within the purchase order.Constraints: range 1 to any
{
  "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",
  "purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "element_id": "4000.01.01-XPMS-001",
  "description": "Stage deck rental",
  "quantity": 24,
  "unit_basis": "each",
  "unit_price_minor": 4500,
  "line_number": 1
}

Code samples

curl -X PATCH "$XOS_BASE_URL/po-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":"Stage deck rental","quantity":24,"unit_price_minor":4500,"line_number":1}'
const { data, etag } = await xos.poLines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "description": "Stage deck rental",
    "quantity": 24,
    "unit_price_minor": 4500,
    "line_number": 1
  }, { ifMatch: etag });
response = xos.po_lines.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "description": "Stage deck rental", "quantity": 24, "unit_price_minor": 4500, "line_number": 1}, if_match=etag)
xos po-lines update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"budget_line_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Stage deck rental","quantity":24,"unit_price_minor":4500,"line_number":1}' --if-match auto