Create a BEO
Hospitality module
POST/beosbeos.create
A banquet event order. Creates a BEO. 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: BeoCreate
| Field | Type | Required | Description |
|---|---|---|---|
| project_id | string (uuid) | Yes | Identifier of the project. |
| fulfillment_id | string (uuid) | null | No | Identifier of the catering fulfillment. |
| event_at | string (date-time) | Yes | Service time. |
| guest_count | integer | null | No | Guaranteed count.Constraints: range 0 to any |
{
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"event_at": "2026-10-08T14:30:00Z",
"guest_count": 140
}Response 201: Beo
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the beo. |
| 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. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| fulfillment_id | string (uuid) | null | Yes | Identifier of the catering fulfillment. |
| event_at | string (date-time) | Yes | Service time. |
| guest_count | integer | null | Yes | Guaranteed count.Constraints: range 0 to any |
| beo_number | integer | Yes | Number within the project; the display key is {project_key}-{beo_number}.Constraints: range 1 to any |
| approved_at | string (date-time) | null | Yes | When the BEO was approved. |
| approved_by | string (uuid) | null | Yes | Identifier of the person who approved the BEO; never its author. |
{
"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",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"event_at": "2026-10-08T14:30:00Z",
"guest_count": 140,
"beo_number": 4,
"approved_at": "2026-10-08T14:30:00Z",
"approved_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/beos" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","fulfillment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","event_at":"2026-10-08T14:30:00Z","guest_count":140}'const { data } = await xos.beos.create({
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"event_at": "2026-10-08T14:30:00Z",
"guest_count": 140
});response = xos.beos.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "event_at": "2026-10-08T14:30:00Z", "guest_count": 140})xos beos create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","fulfillment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","event_at":"2026-10-08T14:30:00Z","guest_count":140}'