housekeeping tools · Foyer Connect

`housekeeping.assignTask`

writes

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`

writes

Mark a housekeeping task complete.

Input parameters

Field	Type	Required
`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`

writes

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`

writes

Housekeeping: create room. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required
`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
`floor`	integer · nullable	yes
`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`

writesconfirm

Delete a housekeeping task.

Input parameters

Field	Type	Required	Notes
`taskId`	string	yes

Output fields

Field	Type	Required	Notes
`id`	string	no

`housekeeping.importRoomsFromStays`

writes

Housekeeping: import rooms from stays. Mutation — changes data. See the input schema for argument details.

Input parameters

Returns object.

Output fields

Field	Type	Required	Notes
`created`	integer	yes

`housekeeping.listRooms`

read-only

Housekeeping: list rooms. Read-only query. See the input schema for argument details.

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
`floor`	integer · nullable	yes
`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`

writes

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
`floor`	integer · nullable	yes
`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`

writes

Housekeeping: skip task. Mutation — changes data. See the input schema for argument details.

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`

writes

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`

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

Field	Type	Required	Notes
`from`	string	yes
`to`	string	yes

Output fields

Field	Type	Required
`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`

read-only

Housekeeping: tasks for date. Read-only query. See the input schema for argument details.

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`

read-only

Housekeeping: tasks for window. Read-only query. See the input schema for argument details.

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`

read-only

Housekeeping: today overview. Read-only query. See the input schema for argument details.

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
`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
`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

`housekeeping.todayTasks`

read-only

Housekeeping: today tasks. Read-only query. See the input schema for argument details.

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`

writes

Change an existing room's master data — type (e.g. double/triple), floor, cleaning minutes, priority, note. The room NAME cannot be changed here: bookings, calendar days and the channel mapping all key off it.

Input parameters

Field	Type	Required
`roomId`	string	yes
`type`	string · nullable	no
`floor`	integer · nullable	no
`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
`floor`	integer · nullable	yes
`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