housekeeping.assignTask
Assign a housekeeping task to a staff member.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
taskId | string | yes | |
userId | string · nullable | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
housekeeping.completeTask
Mark a housekeeping task complete.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
taskId | string | yes | |
actualDurationMinutes | integer | no | |
notes | string | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
roomId | string | yes | |
stayId | string · nullable | yes | |
date | string | yes | |
taskType | enum | yes | One of: checkout, midstay, deep_clean, manual, checkup |
status | enum | yes | One of: pending, in_progress, completed, skipped |
estimatedDurationMinutes | integer · nullable | yes | |
actualDurationMinutes | integer · nullable | yes | |
assignedToUserId | string · nullable | yes | |
startedAt | string · nullable | yes | |
completedAt | string · nullable | yes | |
skippedAt | string · nullable | yes | |
skipReason | string · nullable | yes | |
notes | string · nullable | yes | |
isManual | boolean | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
housekeeping.createManualTask
Create an ad-hoc housekeeping task outside the normal schedule.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
roomId | string | yes | |
date | string | no | |
taskType | enum | no | One of: checkout, midstay, deep_clean, manual, checkup |
notes | string | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
roomId | string | yes | |
stayId | string · nullable | yes | |
date | string | yes | |
taskType | enum | yes | One of: checkout, midstay, deep_clean, manual, checkup |
status | enum | yes | One of: pending, in_progress, completed, skipped |
estimatedDurationMinutes | integer · nullable | yes | |
actualDurationMinutes | integer · nullable | yes | |
assignedToUserId | string · nullable | yes | |
startedAt | string · nullable | yes | |
completedAt | string · nullable | yes | |
skippedAt | string · nullable | yes | |
skipReason | string · nullable | yes | |
notes | string · nullable | yes | |
isManual | boolean | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
housekeeping.createRoom
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
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | yes | |
type | string | no | |
floor | integer | no | |
defaultCheckoutTime | string | no | |
estimatedCleaningMinutes | integer | no | |
priority | integer | no | |
specialNotes | string | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
type | string · nullable | yes | |
anzeigename | string · nullable | yes | |
floor | integer · nullable | yes | |
seite | enum · nullable | yes | One of: links, rechts |
defaultCheckoutTime | string | yes | |
estimatedCleaningMinutes | integer | yes | |
priority | integer | yes | |
specialNotes | string · nullable | yes | |
maintenanceStatus | enum | yes | One of: active, maintenance, out_of_order |
isActive | boolean | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
housekeeping.deleteTask
Delete a housekeeping task.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
taskId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | no |
housekeeping.importRoomsFromStays
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
| Field | Type | Required | Notes |
|---|---|---|---|
created | integer | yes |
housekeeping.listRooms
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:
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
type | string · nullable | yes | |
anzeigename | string · nullable | yes | |
floor | integer · nullable | yes | |
seite | enum · nullable | yes | One of: links, rechts |
defaultCheckoutTime | string | yes | |
estimatedCleaningMinutes | integer | yes | |
priority | integer | yes | |
specialNotes | string · nullable | yes | |
maintenanceStatus | enum | yes | One of: active, maintenance, out_of_order |
isActive | boolean | yes | |
createdAt | string | yes | |
updatedAt | string | yes | |
imageUrl | string · nullable | yes | |
propertyUuid | string · nullable | yes |
housekeeping.setRoomMaintenance
Flag or clear maintenance state on a room.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
roomId | string | yes | |
status | enum | yes | One of: active, maintenance, out_of_order |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
type | string · nullable | yes | |
anzeigename | string · nullable | yes | |
floor | integer · nullable | yes | |
seite | enum · nullable | yes | One of: links, rechts |
defaultCheckoutTime | string | yes | |
estimatedCleaningMinutes | integer | yes | |
priority | integer | yes | |
specialNotes | string · nullable | yes | |
maintenanceStatus | enum | yes | One of: active, maintenance, out_of_order |
isActive | boolean | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
housekeeping.skipTask
Skip a task with required reason. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
taskId | string | yes | |
reason | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
roomId | string | yes | |
stayId | string · nullable | yes | |
date | string | yes | |
taskType | enum | yes | One of: checkout, midstay, deep_clean, manual, checkup |
status | enum | yes | One of: pending, in_progress, completed, skipped |
estimatedDurationMinutes | integer · nullable | yes | |
actualDurationMinutes | integer · nullable | yes | |
assignedToUserId | string · nullable | yes | |
startedAt | string · nullable | yes | |
completedAt | string · nullable | yes | |
skippedAt | string · nullable | yes | |
skipReason | string · nullable | yes | |
notes | string · nullable | yes | |
isManual | boolean | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
housekeeping.startTask
Mark a housekeeping task as started (in progress).
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
taskId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
roomId | string | yes | |
stayId | string · nullable | yes | |
date | string | yes | |
taskType | enum | yes | One of: checkout, midstay, deep_clean, manual, checkup |
status | enum | yes | One of: pending, in_progress, completed, skipped |
estimatedDurationMinutes | integer · nullable | yes | |
actualDurationMinutes | integer · nullable | yes | |
assignedToUserId | string · nullable | yes | |
startedAt | string · nullable | yes | |
completedAt | string · nullable | yes | |
skippedAt | string · nullable | yes | |
skipReason | string · nullable | yes | |
notes | string · nullable | yes | |
isManual | boolean | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
housekeeping.tasks-window
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
| Field | Type | Required | Notes |
|---|---|---|---|
from | string | yes | |
to | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
tasks | array of object | yes | |
tasks.id | string | yes | |
tasks.roomName | string | yes | |
tasks.floor | integer · nullable | yes | |
tasks.date | string | yes | |
tasks.taskType | string | yes | |
tasks.status | string | yes | |
tasks.assignedToUserId | string · nullable | yes |
housekeeping.tasksForDate
Tasks for a specific date. Lazy-creates only when date is today. Read-only query.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
date | string | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
date | string | yes | |
stats | object | yes | |
stats.total | integer | yes | |
stats.pending | integer | yes | |
stats.in_progress | integer | yes | |
stats.completed | integer | yes | |
stats.skipped | integer | yes | |
tasks | array of object | yes | |
tasks.id | string | yes | |
tasks.roomId | string | yes | |
tasks.roomName | string | yes | |
tasks.roomType | string · nullable | yes | |
tasks.floor | integer · nullable | yes | |
tasks.date | string | yes | |
tasks.taskType | enum | yes | One of: checkout, midstay, deep_clean, manual, checkup |
tasks.status | enum | yes | One of: pending, in_progress, completed, skipped |
tasks.estimatedDurationMinutes | integer · nullable | yes | |
tasks.actualDurationMinutes | integer · nullable | yes | |
tasks.startedAt | string · nullable | yes | |
tasks.completedAt | string · nullable | yes | |
tasks.assignedToUserId | string · nullable | yes | |
tasks.notes | string · nullable | yes | |
tasks.skipReason | string · nullable | yes | |
tasks.isManual | boolean | yes | |
tasks.stayId | string · nullable | yes |
housekeeping.tasksForWindow
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
| Field | Type | Required | Notes |
|---|---|---|---|
from | string | yes | |
to | string | yes |
Output fields
Returns array of object. Fields of each element:
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
roomName | string | yes | |
floor | integer · nullable | yes | |
date | string | yes | |
taskType | enum | yes | One of: checkout, midstay, deep_clean, manual, checkup |
status | enum | yes | One of: pending, in_progress, completed, skipped |
assignedToUserId | string · nullable | yes |
housekeeping.todayOverview
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
| Field | Type | Required | Notes |
|---|---|---|---|
date | string | yes | |
timezone | string | yes | |
departures | array of object | yes | |
departures.id | string | yes | |
departures.guestName | string · nullable | yes | |
departures.room | string · nullable | yes | |
departures.checkIn | string · nullable | yes | |
departures.checkOut | string · nullable | yes | |
departures.status | enum | yes | One of: pending, confirmed, checked_in, checked_out, cancelled, hold |
departures.expectedArrivalAt | string · nullable | yes | |
departures.expectedArrivalQuelle | string · nullable | yes | |
departures.expectedDepartureAt | string · nullable | yes | |
arrivals | array of object | yes | |
arrivals.id | string | yes | |
arrivals.guestName | string · nullable | yes | |
arrivals.room | string · nullable | yes | |
arrivals.checkIn | string · nullable | yes | |
arrivals.checkOut | string · nullable | yes | |
arrivals.status | enum | yes | One of: pending, confirmed, checked_in, checked_out, cancelled, hold |
arrivals.expectedArrivalAt | string · nullable | yes | |
arrivals.expectedArrivalQuelle | string · nullable | yes | |
arrivals.expectedDepartureAt | string · nullable | yes | |
stayovers | array of object | yes | |
stayovers.id | string | yes | |
stayovers.guestName | string · nullable | yes | |
stayovers.room | string · nullable | yes | |
stayovers.checkIn | string · nullable | yes | |
stayovers.checkOut | string · nullable | yes | |
stayovers.status | enum | yes | One of: pending, confirmed, checked_in, checked_out, cancelled, hold |
stayovers.expectedArrivalAt | string · nullable | yes | |
stayovers.expectedArrivalQuelle | string · nullable | yes | |
stayovers.expectedDepartureAt | string · nullable | yes |
housekeeping.todayTasks
Today's task queue. Lazy-creates checkout tasks for stays leaving today. Read-only query.
Input parameters
Returns object.
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
date | string | yes | |
stats | object | yes | |
stats.total | integer | yes | |
stats.pending | integer | yes | |
stats.in_progress | integer | yes | |
stats.completed | integer | yes | |
stats.skipped | integer | yes | |
tasks | array of object | yes | |
tasks.id | string | yes | |
tasks.roomId | string | yes | |
tasks.roomName | string | yes | |
tasks.roomType | string · nullable | yes | |
tasks.floor | integer · nullable | yes | |
tasks.date | string | yes | |
tasks.taskType | enum | yes | One of: checkout, midstay, deep_clean, manual, checkup |
tasks.status | enum | yes | One of: pending, in_progress, completed, skipped |
tasks.estimatedDurationMinutes | integer · nullable | yes | |
tasks.actualDurationMinutes | integer · nullable | yes | |
tasks.startedAt | string · nullable | yes | |
tasks.completedAt | string · nullable | yes | |
tasks.assignedToUserId | string · nullable | yes | |
tasks.notes | string · nullable | yes | |
tasks.skipReason | string · nullable | yes | |
tasks.isManual | boolean | yes | |
tasks.stayId | string · nullable | yes |
housekeeping.updateRoom
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
| Field | Type | Required | Notes |
|---|---|---|---|
roomId | string | yes | |
type | string · nullable | no | |
anzeigename | string · nullable | no | |
floor | integer · nullable | no | |
seite | enum · nullable | no | One of: links, rechts |
defaultCheckoutTime | string | no | |
estimatedCleaningMinutes | integer | no | |
priority | integer | no | |
specialNotes | string · nullable | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
type | string · nullable | yes | |
anzeigename | string · nullable | yes | |
floor | integer · nullable | yes | |
seite | enum · nullable | yes | One of: links, rechts |
defaultCheckoutTime | string | yes | |
estimatedCleaningMinutes | integer | yes | |
priority | integer | yes | |
specialNotes | string · nullable | yes | |
maintenanceStatus | enum | yes | One of: active, maintenance, out_of_order |
isActive | boolean | yes | |
createdAt | string | yes | |
updatedAt | string | yes |