Skip to content

Generate housekeeping tasks

POST
/v1/actions/hospitality.action.generate_housekeeping_tasks/apply
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.generate_housekeeping_tasks/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "business_date": "2026-04-15", "include_turndown": true }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

Derive the day’s housekeeping board from system truth: each occupied room due out on the business date gets a departure clean, other occupied rooms get stayover cleans (and turndown when include_turndown is set), vacant dirty / pickup rooms get vacant pickups, and rooms under an active out-of-order block covering the date are skipped (release decides their state). Rooms whose reservation is waiting in the room queue generate at urgent priority. Idempotent by construction: every derived task carries a generation_key, so re-running lands on the existing rows, and generated pending / blocked tasks the current state no longer calls for retire as skipped. Manually minted tasks are never touched. Each new task carries credits and standard_minutes from the property’s most specific active housekeeping credit rule (task type and room type over task type alone; none when the house prices none), and a re-run re-prices generated tasks still pending to the rules as they stand — work under way keeps its price. Every active public area of the house gets one public_area_clean for the date (2026-10-14), keyed hk:area:{area}:{date} and converging the same way: a retired area’s open generated clean is skipped, an active one’s skipped clean revives. Run it from a cron, an agent, or the desk — twice is safe.

Effects: create hospitality.housekeeping_task; modify hospitality.housekeeping_task; link hospitality.link.housekeeping_task_for_room; link hospitality.link.housekeeping_task_for_area.

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
business_date
required
Service date to generate for
string format: date
include_turndown
Also generate evening turndown tasks for stayover rooms
boolean
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.property

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.housekeeping_task_for_room hospitality.link.housekeeping_task_for_area
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.housekeeping_task
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.housekeeping_task_for_room"
}
],
"modified_objects": [
{
"kind": "created",
"object_type": "hospitality.housekeeping_task"
}
]
}

Conflict — concurrent modification or unique constraint violation.

Validation error — parameter validation or business-rule violation.