Saltar al contenido

Create a PO change order

Módulo Procurement

POST/po-change-orderspoChangeOrders.create

A change to an issued purchase order. Creates a PO change order. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad procurement.po.write.
  • Alcances de OAuth: procurement.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: PoChangeOrderCreate

poChangeOrders.create: PoChangeOrderCreate
CampoTipoObligatorioDescripción
purchase_order_idstring (uuid)SíIdentifier of the purchase order.
descriptionstringSíWhat changes.Restricciones: length 1 to 20000
amount_delta_minorinteger (int64) | nullNoChange amount; null when unpriced. Integer minor units of the resource currency; null means unpriced, never zero.
{
  "purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Add six deck sections.",
  "amount_delta_minor": 27000
}

Respuesta 201: PoChangeOrder

poChangeOrders.create: PoChangeOrder
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the po change order.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
purchase_order_idstring (uuid)SíIdentifier of the purchase order.
descriptionstringSíWhat changes.Restricciones: length 1 to 20000
amount_delta_minorinteger (int64) | nullSíChange amount; null when unpriced. Integer minor units of the resource currency; null means unpriced, never zero.
po_change_order_state"Proposed" | "Approved" | "Rejected" | "Canceled"SíPO change order state.
{
  "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",
  "description": "Add six deck sections.",
  "amount_delta_minor": 27000,
  "po_change_order_state": "Proposed"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/po-change-orders" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"purchase_order_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Add six deck sections.","amount_delta_minor":27000}'
const { data } = await xos.poChangeOrders.create({
    "purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "description": "Add six deck sections.",
    "amount_delta_minor": 27000
  });
response = xos.po_change_orders.create({"purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "description": "Add six deck sections.", "amount_delta_minor": 27000})
xos po-change-orders create --data '{"purchase_order_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Add six deck sections.","amount_delta_minor":27000}'