FoyerDevelopers

Generated · Live registry

housekeeping tools

16 tools in this domain, generated from the running registry.

All tool domains

housekeeping.assignTask

writes

Assign a housekeeping task to a staff member.

Input parameters

FieldTypeRequiredNotes
taskIdstringyes
userIdstring · nullableyes

Output fields

FieldTypeRequiredNotes
idstringyes

housekeeping.completeTask

writes

Mark a housekeeping task complete.

Input parameters

FieldTypeRequiredNotes
taskIdstringyes
actualDurationMinutesintegerno
notesstringno

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
roomIdstringyes
stayIdstring · nullableyes
datestringyes
taskTypeenumyesOne of: checkout, midstay, deep_clean, manual, checkup
statusenumyesOne of: pending, in_progress, completed, skipped
estimatedDurationMinutesinteger · nullableyes
actualDurationMinutesinteger · nullableyes
assignedToUserIdstring · nullableyes
startedAtstring · nullableyes
completedAtstring · nullableyes
skippedAtstring · nullableyes
skipReasonstring · nullableyes
notesstring · nullableyes
isManualbooleanyes
createdAtstringyes
updatedAtstringyes

housekeeping.createManualTask

writes

Create an ad-hoc housekeeping task outside the normal schedule.

Input parameters

FieldTypeRequiredNotes
roomIdstringyes
datestringno
taskTypeenumnoOne of: checkout, midstay, deep_clean, manual, checkup
notesstringno

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
roomIdstringyes
stayIdstring · nullableyes
datestringyes
taskTypeenumyesOne of: checkout, midstay, deep_clean, manual, checkup
statusenumyesOne of: pending, in_progress, completed, skipped
estimatedDurationMinutesinteger · nullableyes
actualDurationMinutesinteger · nullableyes
assignedToUserIdstring · nullableyes
startedAtstring · nullableyes
completedAtstring · nullableyes
skippedAtstring · nullableyes
skipReasonstring · nullableyes
notesstring · nullableyes
isManualbooleanyes
createdAtstringyes
updatedAtstringyes

housekeeping.createRoom

writes

Creates a room (name, optional type, floor, defaultCheckoutTime, estimatedCleaningMinutes, priority, specialNotes). Owner only. Changes data; a room name that is already taken results in CONFLICT. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
namestringyes
typestringno
floorintegerno
defaultCheckoutTimestringno
estimatedCleaningMinutesintegerno
priorityintegerno
specialNotesstringno

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
typestring · nullableyes
anzeigenamestring · nullableyes
floorinteger · nullableyes
seiteenum · nullableyesOne of: links, rechts
defaultCheckoutTimestringyes
estimatedCleaningMinutesintegeryes
priorityintegeryes
specialNotesstring · nullableyes
maintenanceStatusenumyesOne of: active, maintenance, out_of_order
isActivebooleanyes
createdAtstringyes
updatedAtstringyes

housekeeping.deleteTask

writesconfirm

Delete a housekeeping task.

Input parameters

FieldTypeRequiredNotes
taskIdstringyes

Output fields

FieldTypeRequiredNotes
idstringno

housekeeping.importRoomsFromStays

writes

One-shot import: pull distinct `stays.room` values that don't yet have a corresponding row in `rooms`, and create them with sensible defaults. Lets a fresh tenant skip manual seeding if they already have stays. Mutation — changes data.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
createdintegeryes

housekeeping.listRooms

read-only

Lists the property's rooms (name, type, floor, corridor side, default checkout time, cleaning duration, priority, special note) by floor and name; when mapped, with room image and unit UUID. Any signed-in role. Read-only.

Input parameters

Returns object.

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
typestring · nullableyes
anzeigenamestring · nullableyes
floorinteger · nullableyes
seiteenum · nullableyesOne of: links, rechts
defaultCheckoutTimestringyes
estimatedCleaningMinutesintegeryes
priorityintegeryes
specialNotesstring · nullableyes
maintenanceStatusenumyesOne of: active, maintenance, out_of_order
isActivebooleanyes
createdAtstringyes
updatedAtstringyes
imageUrlstring · nullableyes
propertyUuidstring · nullableyes

housekeeping.setRoomMaintenance

writes

Flag or clear maintenance state on a room.

Input parameters

FieldTypeRequiredNotes
roomIdstringyes
statusenumyesOne of: active, maintenance, out_of_order

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
typestring · nullableyes
anzeigenamestring · nullableyes
floorinteger · nullableyes
seiteenum · nullableyesOne of: links, rechts
defaultCheckoutTimestringyes
estimatedCleaningMinutesintegeryes
priorityintegeryes
specialNotesstring · nullableyes
maintenanceStatusenumyesOne of: active, maintenance, out_of_order
isActivebooleanyes
createdAtstringyes
updatedAtstringyes

housekeeping.skipTask

writes

Skip a task with required reason. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
taskIdstringyes
reasonstringyes

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
roomIdstringyes
stayIdstring · nullableyes
datestringyes
taskTypeenumyesOne of: checkout, midstay, deep_clean, manual, checkup
statusenumyesOne of: pending, in_progress, completed, skipped
estimatedDurationMinutesinteger · nullableyes
actualDurationMinutesinteger · nullableyes
assignedToUserIdstring · nullableyes
startedAtstring · nullableyes
completedAtstring · nullableyes
skippedAtstring · nullableyes
skipReasonstring · nullableyes
notesstring · nullableyes
isManualbooleanyes
createdAtstringyes
updatedAtstringyes

housekeeping.startTask

writes

Mark a housekeeping task as started (in progress).

Input parameters

FieldTypeRequiredNotes
taskIdstringyes

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
roomIdstringyes
stayIdstring · nullableyes
datestringyes
taskTypeenumyesOne of: checkout, midstay, deep_clean, manual, checkup
statusenumyesOne of: pending, in_progress, completed, skipped
estimatedDurationMinutesinteger · nullableyes
actualDurationMinutesinteger · nullableyes
assignedToUserIdstring · nullableyes
startedAtstring · nullableyes
completedAtstring · nullableyes
skippedAtstring · nullableyes
skipReasonstring · nullableyes
notesstring · nullableyes
isManualbooleanyes
createdAtstringyes
updatedAtstringyes

housekeeping.tasks-window

read-only

Cleaning tasks across a date window for the calendar Tasks-view. Returns id, roomName (unit code), floor, date, taskType (checkout/midstay/deep_clean/manual), and status (pending/in_progress/completed/skipped). Read-only.

Input parameters

FieldTypeRequiredNotes
fromstringyes
tostringyes

Output fields

FieldTypeRequiredNotes
tasksarray of objectyes
tasks.idstringyes
tasks.roomNamestringyes
tasks.floorinteger · nullableyes
tasks.datestringyes
tasks.taskTypestringyes
tasks.statusstringyes
tasks.assignedToUserIdstring · nullableyes

housekeeping.tasksForDate

read-only

Tasks for a specific date. Lazy-creates only when date is today. Read-only query.

Input parameters

FieldTypeRequiredNotes
datestringno

Output fields

FieldTypeRequiredNotes
datestringyes
statsobjectyes
stats.totalintegeryes
stats.pendingintegeryes
stats.in_progressintegeryes
stats.completedintegeryes
stats.skippedintegeryes
tasksarray of objectyes
tasks.idstringyes
tasks.roomIdstringyes
tasks.roomNamestringyes
tasks.roomTypestring · nullableyes
tasks.floorinteger · nullableyes
tasks.datestringyes
tasks.taskTypeenumyesOne of: checkout, midstay, deep_clean, manual, checkup
tasks.statusenumyesOne of: pending, in_progress, completed, skipped
tasks.estimatedDurationMinutesinteger · nullableyes
tasks.actualDurationMinutesinteger · nullableyes
tasks.startedAtstring · nullableyes
tasks.completedAtstring · nullableyes
tasks.assignedToUserIdstring · nullableyes
tasks.notesstring · nullableyes
tasks.skipReasonstring · nullableyes
tasks.isManualbooleanyes
tasks.stayIdstring · nullableyes

housekeeping.tasksForWindow

read-only

Cleaning tasks across a date window, for the calendar Tasks-view. One row per task; `roomName` matches rooms.name (and the timeline's unit rows). Read-only — task lifecycle stays on the housekeeping page.

Input parameters

FieldTypeRequiredNotes
fromstringyes
tostringyes

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
roomNamestringyes
floorinteger · nullableyes
datestringyes
taskTypeenumyesOne of: checkout, midstay, deep_clean, manual, checkup
statusenumyesOne of: pending, in_progress, completed, skipped
assignedToUserIdstring · nullableyes

housekeeping.todayOverview

read-only

Daily overview: today's arrivals, departures, and stayovers. Pure read-only — no lazy task creation. Uses Berlin timezone for "today".

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
datestringyes
timezonestringyes
departuresarray of objectyes
departures.idstringyes
departures.guestNamestring · nullableyes
departures.roomstring · nullableyes
departures.checkInstring · nullableyes
departures.checkOutstring · nullableyes
departures.statusenumyesOne of: pending, confirmed, checked_in, checked_out, cancelled, hold
departures.expectedArrivalAtstring · nullableyes
departures.expectedArrivalQuellestring · nullableyes
departures.expectedDepartureAtstring · nullableyes
arrivalsarray of objectyes
arrivals.idstringyes
arrivals.guestNamestring · nullableyes
arrivals.roomstring · nullableyes
arrivals.checkInstring · nullableyes
arrivals.checkOutstring · nullableyes
arrivals.statusenumyesOne of: pending, confirmed, checked_in, checked_out, cancelled, hold
arrivals.expectedArrivalAtstring · nullableyes
arrivals.expectedArrivalQuellestring · nullableyes
arrivals.expectedDepartureAtstring · nullableyes
stayoversarray of objectyes
stayovers.idstringyes
stayovers.guestNamestring · nullableyes
stayovers.roomstring · nullableyes
stayovers.checkInstring · nullableyes
stayovers.checkOutstring · nullableyes
stayovers.statusenumyesOne of: pending, confirmed, checked_in, checked_out, cancelled, hold
stayovers.expectedArrivalAtstring · nullableyes
stayovers.expectedArrivalQuellestring · nullableyes
stayovers.expectedDepartureAtstring · nullableyes

housekeeping.todayTasks

read-only

Today's task queue. Lazy-creates checkout tasks for stays leaving today. Read-only query.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
datestringyes
statsobjectyes
stats.totalintegeryes
stats.pendingintegeryes
stats.in_progressintegeryes
stats.completedintegeryes
stats.skippedintegeryes
tasksarray of objectyes
tasks.idstringyes
tasks.roomIdstringyes
tasks.roomNamestringyes
tasks.roomTypestring · nullableyes
tasks.floorinteger · nullableyes
tasks.datestringyes
tasks.taskTypeenumyesOne of: checkout, midstay, deep_clean, manual, checkup
tasks.statusenumyesOne of: pending, in_progress, completed, skipped
tasks.estimatedDurationMinutesinteger · nullableyes
tasks.actualDurationMinutesinteger · nullableyes
tasks.startedAtstring · nullableyes
tasks.completedAtstring · nullableyes
tasks.assignedToUserIdstring · nullableyes
tasks.notesstring · nullableyes
tasks.skipReasonstring · nullableyes
tasks.isManualbooleanyes
tasks.stayIdstring · nullableyes

housekeeping.updateRoom

writes

Change an existing room's master data — type (e.g. double/triple), guest-facing display name (`anzeigename`, max 80 chars; empty/null = derive it again), floor, cleaning minutes, priority, note. The display name is what guests see on the booking page, room page, room choice and in messages. The room NAME cannot be changed here: bookings, calendar days and the channel mapping all key off it.

Input parameters

FieldTypeRequiredNotes
roomIdstringyes
typestring · nullableno
anzeigenamestring · nullableno
floorinteger · nullableno
seiteenum · nullablenoOne of: links, rechts
defaultCheckoutTimestringno
estimatedCleaningMinutesintegerno
priorityintegerno
specialNotesstring · nullableno

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
typestring · nullableyes
anzeigenamestring · nullableyes
floorinteger · nullableyes
seiteenum · nullableyesOne of: links, rechts
defaultCheckoutTimestringyes
estimatedCleaningMinutesintegeryes
priorityintegeryes
specialNotesstring · nullableyes
maintenanceStatusenumyesOne of: active, maintenance, out_of_order
isActivebooleanyes
createdAtstringyes
updatedAtstringyes