Create a BEO line

Hospitality module

POST/beo-linesbeoLines.create

A line of a banquet event order. Creates a BEO 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 hospitality.beo.write.
OAuth scopes: hospitality.
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: BeoLineCreate

beoLines.create: BeoLineCreate
Field	Type	Required	Description
beo_id	string (uuid)	Yes	Identifier of the BEO.
description	string	Yes	Menu item or service.Constraints: length 1 to 300
quantity	number	No	Quantity.
unit_price_minor	integer (int64) \| null	No	Unit price. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string \| null	No	ISO 4217 currency of the price; required when the line is priced.Constraints: pattern ^[A-Z]{3}$

{
  "beo_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Grilled vegetable wraps",
  "quantity": 140,
  "unit_price_minor": 1450,
  "currency_code": "USD"
}

Response 201: BeoLine

beoLines.create: BeoLine
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the beo 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.
beo_id	string (uuid)	Yes	Identifier of the BEO.
description	string	Yes	Menu item or service.Constraints: length 1 to 300
quantity	number	Yes	Quantity.
unit_price_minor	integer (int64) \| null	Yes	Unit price. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string \| null	Yes	ISO 4217 currency of the price; required when the line is priced.Constraints: pattern ^[A-Z]{3}$

{
  "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",
  "beo_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Grilled vegetable wraps",
  "quantity": 140,
  "unit_price_minor": 1450,
  "currency_code": "USD"
}

Code samples

curl -X POST "$XOS_BASE_URL/beo-lines" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"beo_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Grilled vegetable wraps","quantity":140,"unit_price_minor":1450,"currency_code":"USD"}'

const { data } = await xos.beoLines.create({
    "beo_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "description": "Grilled vegetable wraps",
    "quantity": 140,
    "unit_price_minor": 1450,
    "currency_code": "USD"
  });

response = xos.beo_lines.create({"beo_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "description": "Grilled vegetable wraps", "quantity": 140, "unit_price_minor": 1450, "currency_code": "USD"})

xos beo-lines create --data '{"beo_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Grilled vegetable wraps","quantity":140,"unit_price_minor":1450,"currency_code":"USD"}'