Create a change order line
Finance module
POST/change-order-lineschangeOrderLines.create
A line of a change order. Creates a change order line. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability finance.change_order.price.
- OAuth scopes: finance.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: ChangeOrderLineCreate
| Field | Type | Required | Description |
|---|---|---|---|
| change_order_id | string (uuid) | Yes | Identifier of the change order. |
| budget_line_id | string (uuid) | null | No | Identifier of the affected budget line. |
| urid | UridAtAnyGrain | Yes | URID 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}$ |
| description | string | Yes | Line description.Constraints: length 1 to 300 |
| quantity | number | No | Quantity; defaults to 1. |
| unit_price_minor | integer (int64) | null | No | Unit price; null when unpriced. Integer minor units of the resource currency; null means unpriced, never zero. |
| is_no_cost | boolean | No | Whether the line is deliberately free of charge. |
{
"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
}Response 201: ChangeOrderLine
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the change order line. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| change_order_id | string (uuid) | Yes | Identifier of the change order. |
| budget_line_id | string (uuid) | null | Yes | Identifier of the affected budget line. |
| urid | UridAtAnyGrain | Yes | URID 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}$ |
| description | string | Yes | Line description.Constraints: length 1 to 300 |
| quantity | number | Yes | Quantity; defaults to 1. |
| unit_price_minor | integer (int64) | null | Yes | Unit price; null when unpriced. Integer minor units of the resource currency; null means unpriced, never zero. |
| is_no_cost | boolean | Yes | Whether the line is deliberately free of charge. |
| account_code | GlAccountCode | null | Yes | |
| cost_center_id | string (uuid) | null | Yes | Identifier 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 POST "$XOS_BASE_URL/change-order-lines" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"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}'const { data } = await xos.changeOrderLines.create({
"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
});response = xos.change_order_lines.create({"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})xos change-order-lines create --data '{"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}'