Skip to content

Record work order entry

POST
/v1/actions/hospitality.action.record_work_order_entry/apply
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.record_work_order_entry/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "delegated_to_role": "front_office_agent", "kind": "note", "materials": [ { "description": "example", "material_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "quantity": "example", "store_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "unit": "example" } ], "minutes_spent": 1, "recorded_at": "2026-04-15T12:00:00Z", "text": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.work_order" } }'

Add a line to a work order’s thread: a note, work (with minutes_spent), material (with the parts used), or a delegation (with the role the order is handed to). Any line may also carry time and parts. The author is the staff member behind the principal when there is one (a handset session), linked through work_order_entry_recorded_by; recorded_by names the principal either way. A delegation also stamps the role on the order (delegated_to_role, the board’s delegated filter) until complete_work_order or void_work_order clears it; one to the role the order already stands with writes the line and moves nothing (its event says role_changed: false, so nobody is nudged, 2026-10-17). Refused on a voided order; a completed order takes notes only. Postponement and resolution lines are written by postpone_work_order and complete_work_order, never here. Replay-safe under the apply route’s Idempotency-Key — the handset’s offline queue sends one per line. A part naming a catalogued material_id (2026-10-14) is consumed from its store_id — or the house’s default workshop — in the same transaction (a consumption movement on the order, stock_movement_for_work_order), refused when it would take the store below zero unless the store allows it; its description defaults to the material’s name and its unit is the material’s. A free-text part moves no stock. The part comes out of the acting role’s own stores, as on every stock verb (2026-10-17): an engineer’s session from a workshop, a housekeeping supervisor’s from any store but one — the default workshop included — else the line is refused (403).

Effects: create hospitality.work_order_entry; link hospitality.link.work_order_entry_for_work_order; link hospitality.link.work_order_entry_recorded_by; modify hospitality.work_order; create hospitality.stock_movement; create hospitality.stock_level; modify hospitality.stock_level; link hospitality.link.stock_movement_for_level; link hospitality.link.stock_level_for_material; link hospitality.link.stock_level_in_store; link hospitality.link.stock_movement_recorded_by; link hospitality.link.stock_movement_for_work_order.

Media typeapplication/json
object
branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid
params
required
object
delegated_to_role
The role the order is handed to (required for a delegation)
string
Allowed values: front_office_agent front_office_supervisor concierge bell housekeeper housekeeping_supervisor engineer food_beverage_server food_beverage_manager chef spa_therapist spa_manager reservations_agent revenue_manager sales_manager manager_on_duty general_manager owner other runner
kind
required
note, work, material, or delegation
string
Allowed values: note work material delegation
materials
Materials
Array<object>
object
description
string
material_id
string format: uuid
quantity
required
string format: decimal
store_id
string format: uuid
unit
string
minutes_spent
Time spent, in minutes (required for a work line; 0 to 10080)
integer
recorded_at
When the line was written (defaults to now; a handset queueing offline sends its own time; refused when more than five minutes ahead of the kernel's clock)
string format: date-time
text
The words on the line (required for a note)
string
return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean
target
required
object
id
required
string format: uuid
object_type
required
Allowed value: hospitality.work_order

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

Media typeapplication/json
ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object
correlation_id
required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid
modified_links
required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>
object
from_id
required
string format: uuid
from_type
required
string
kind
required
Allowed values: linked
link_type
required
Allowed values: hospitality.link.work_order_entry_for_work_order hospitality.link.work_order_entry_recorded_by hospitality.link.stock_movement_for_level hospitality.link.stock_level_for_material hospitality.link.stock_level_in_store hospitality.link.stock_movement_recorded_by hospitality.link.stock_movement_for_work_order
to_id
required
string format: uuid
to_type
required
string
modified_objects
required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>
object
id
required
string format: uuid
kind
required
Allowed values: created modified
object_type
required
Allowed values: hospitality.work_order_entry hospitality.work_order hospitality.stock_movement hospitality.stock_level
warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>
object
message
required

Human-readable summary, suitable for logging or operator-UI surfacing.

string
object_type
required

Object type the warning was raised against.

string
property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string
rule
required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string
Example
{
"modified_links": [
{
"kind": "linked",
"link_type": "hospitality.link.work_order_entry_for_work_order"
}
],
"modified_objects": [
{
"kind": "created",
"object_type": "hospitality.work_order_entry"
}
]
}

Conflict — concurrent modification or unique constraint violation.

Validation error — parameter validation or business-rule violation.