> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/product/features/housekeeping/cleaning-tasks.md).

# Cleaning tasks

{% hint style="info" %}
Draft, written by an agent and not yet checked by a person ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). [Source on GitHub](https://github.com/snapfix/docs/blob/main/product/features/cleaning-tasks.md).
{% endhint %}

A **cleaning task** (a clean) is a housekeeping task that cleans one room. Each one has a **clean type**, such as "Stayover Clean", "Departure Clean", "Correction Clean" or "Touch Up Clean", and goes red (not started), amber (in progress) and green (done) like any task. Managers create cleans for chosen rooms on the web board or in the mobile apps; the server also creates them from the site's room status rules, every morning and when the property management system (PMS) reports a change. Housekeepers work on their cleans in the task feed and the task screen, and in the mobile apps they can **snooze** a clean they can't do yet, with a reason such as "DND - Do Not Disturb" or "NSR - No Service Required". Most cleans have a linked [inspection](https://docs.snapfix.com/product/features/housekeeping/inspections.md).

## Rules

### Clean types

* In the data, a clean is a task of type 45 with the clean type `stayover`, `departure`, `correction` or `standard`; a `standard` clean also has a sub type ([Housekeeping API](https://docs.snapfix.com/engineering-reference/api/housekeeping.md)).
* The default list offered is "Stayover Clean", "Departure Clean", "Correction Clean", "Touch Up Clean" and "Inspections". "Touch Up Clean" has six sub types: "Deep Clean", "Request Clean", "Floor Deep Cleaning", "5 Min Touch Up Clean", "10 Min Touch Up Clean" and "Deep Clean Pet Room". Five sites have their own list in the server's configuration, which replaces the default and can add "Studio Tidy", "Trash and towel" and "Pre Arrival Maintenance Blitz" ([`GET /v1/app/housekeeping/manual-clean-types`](https://docs.snapfix.com/engineering-reference/api/housekeeping.md#get-v1apphousekeepingmanual-clean-types)).
* The clean type decides the roles that may take the task, the default group, and whether the creator may set a duration ([Create Tasks](https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/timeline.md#create-tasks); roles in [Staff schedule](https://docs.snapfix.com/product/features/housekeeping/staff-schedule.md)).

### Creating cleans by hand

* Managers create cleans on the web board's "Create Tasks" dialog or the apps' "Create Tasks" sheet: one task per chosen room, up to 100 rooms per request, all in the site. The creator needs "create task" in the chosen group, and can name an assignee, who is assigned once the tasks exist ([Create Tasks](https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/timeline.md#create-tasks), [`POST /v1/app/housekeeping/manual-hk-task/bulk`](https://docs.snapfix.com/engineering-reference/api/housekeeping.md#post-v1apphousekeepingmanual-hk-taskbulk)).
* The group defaults to the cleaning group of the first room's status rule (the inspection group for "Inspections"); the creator can pick another ([`GET /v1/app/rooms/{uuid}/hk-businesses`](https://docs.snapfix.com/engineering-reference/api/housekeeping.md#get-v1approomsuuidhk-businesses)).
* The title is the room's name and the clean type, unless the creator types one (one room only) ([Create Tasks](https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/timeline.md#create-tasks)).
* A new clean is red, unassigned and pending, so it waits in the unassigned list until someone assigns it ([Assigning housekeeping tasks](https://docs.snapfix.com/product/features/housekeeping/housekeeping-assignment.md)).
* Duration: the creator can set up to 2 hours where the clean type allows it; all three platforms send seconds. Without it, the two touch-up sub types take 5 or 10 minutes and other sub types 30 minutes ([Create Tasks](https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/timeline.md#create-tasks)). The minimum differs by platform.
* A clean with no duration gets an estimate, which differs by path \[[ASK-141](https://github.com/snapfix/docs/blob/main/ASK.md#ask-141-which-duration-estimate-should-a-clean-with-no-set-duration-get)]. Cleans the server generates get the room's own stayover or departure duration when it has one, and otherwise 30 minutes plus time for more than two guests, nights beyond two and beds beyond one (api\_php\_live\_v2 @ ef3c4319f6, `app/Services/DurationCalculation.php:40-56`, `app/Services/RoomDailyTaskGeneratorService.php:1229`). A clean assigned on the timeline without a duration counts as 30 minutes plus 5 for each guest after the first (`app/Services/AutoAssign/JobDurationCalculator.php:20-38`, `app/Traits/Job/JobActions.php:1237-1240`).
* Each clean gets a linked, locked inspection when housekeeping is on for the room's building, except "Studio Tidy", "Trash and towel" and "Pre Arrival Maintenance Blitz". The "Inspections" type creates only an inspection ([Inspections](https://docs.snapfix.com/product/features/housekeeping/inspections.md)). The create route itself doesn't check that housekeeping is on.

### Cleans the server creates

* The daily run checks every minute and creates the day's cleans for each site when it is 06:00 in the site's time zone, for buildings with housekeeping on. It runs only when the server setting `RUN_TASK_GENERATOR` is on, which is off by default \[[ASK-12](https://github.com/snapfix/docs/blob/main/ASK.md#ask-12-which-settings-do-the-production-api-servers-use)] (api\_php\_live\_v2 @ ef3c4319f6, `app/Console/Kernel.php:23-28`, `app/Console/Commands/GenerateRoomTasksDailyCommand.php:25-26`, `:93-135`).
* A PMS status or reservation change for one room runs the same generator for that room, when housekeeping is on and the site has an admin user. It creates the room's clean and inspection, or archives red ones the new status no longer calls for ([Room status](https://docs.snapfix.com/product/features/rooms/room-status.md)).
* The generator follows the site's room status rules: each rule names the statuses it applies to, whether to create a clean, an inspection or both, and their groups and checklists. A room with no matching rule gets no clean ([`tPri_RoomStatus_TaskRules`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_roomstatus_taskrules.md); api\_php\_live\_v2 @ ef3c4319f6, `app/Services/RoomDailyTaskGeneratorService.php:231-242`).
* A rejected inspection creates a correction clean and a new inspection ([Inspections](https://docs.snapfix.com/product/features/housekeeping/inspections.md)).

### Working on a clean

* Housekeepers open cleans from the feed or the group like any task, fill in the checklist and turn them green ([Task detail](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md)).
* A green clean unlocks its inspection. "Studio Tidy", "Trash and towel" and "Pre Arrival Maintenance Blitz" change nothing when they turn green: the room's status stays, and no task is unlocked or created (api\_php\_live\_v2 @ ef3c4319f6, `config/housekeeping.php:4-13`).
* Archiving, unarchiving or deleting a clean does the same to its inspection ([Task detail](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md#task-menu)).
* Only people on today's [staff schedule](https://docs.snapfix.com/product/features/housekeeping/staff-schedule.md) whose role fits the task can set a reminder on it ([Task detail](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md#inputs)).

### Snooze

* Snooze is in the apps only, on cleans and inspections that aren't green ([Snooze Task](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md#snooze-task)). Android hides it on archived, locked and future tasks, outside the task's time range, and for users whose membership is inactive, and shows a disabled "Task Snoozed" once the task is snoozed (android @ 86068bfeea, `app/src/main/java/gmail/com/snapfixapp/fragment/JobChatFragment.java:15140-15172`).
* The reasons are "DND - Do Not Disturb", "NSR - No Service Required" and "Other", with an optional note. Android keeps "Save & Snooze" off until a reason is picked. The reason is saved as the label in the user's language.
* Snoozing saves the reason and note on the task and posts them in its chat ([Approval and housekeeping](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md#approval-and-housekeeping)).
* "NSR - No Service Required" archives the clean and its linked inspection.
* "DND - Do Not Disturb" and "Other" turn the task red. When someone is assigned, the task is moved for that first assignee: iOS asks for a new place from the current time, Android moves the start one hour later \[[ASK-90](https://github.com/snapfix/docs/blob/main/ASK.md#ask-90-what-should-a-dnd-or-other-snooze-do-to-the-tasks-time)] ([Task timeline](https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/timeline.md#task-actions)). iOS also turns the task red for "NSR".
* The web shows the snooze line in the task's chat but can't snooze.

## Flow

```mermaid
flowchart TD
  manual["Manager: Create Tasks for rooms"] --> red["Red, unassigned cleans"]
  daily["06:00 site time, or a PMS change"] --> rules{"Room status rule?"}
  rules -->|yes| red
  rules -->|no| none["No clean"]
  red --> assign["Assigned on the timeline"]
  assign --> work["Housekeeper works the clean"]
  work -->|green| unlock["Linked inspection unlocks"]
  work -.->|"apps: can't clean yet"| snooze{"Snooze reason"}
  snooze -->|NSR| archive["Clean and inspection archived"]
  snooze -->|"DND or Other"| moved["Red, moved for the same person"]
  moved --> work
  unlock -.->|"inspector rejects"| correction["Correction clean and new inspection"]
  correction --> assign
```

## Platforms

| Capability                               | Web                                                          | iOS                   | Android                                                                                                                                                                                                           |
| ---------------------------------------- | ------------------------------------------------------------ | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Create cleans, one per room              | "Create Tasks" dialog, up to 100 rooms                       | "Create Tasks" sheet  | "Create Tasks" sheet; its "+" shows although a comment says creating is off \[[ASK-96](https://github.com/snapfix/docs/blob/main/ASK.md#ask-96-is-creating-housekeeping-tasks-meant-to-be-on-in-the-android-app)] |
| Choose clean type, sub type and duration | Yes                                                          | Yes                   | Yes                                                                                                                                                                                                               |
| Work on a clean                          | Task preview on the board; the task for members of its group | Task screen           | Task screen                                                                                                                                                                                                       |
| Snooze with a reason                     | No                                                           | Yes                   | Yes                                                                                                                                                                                                               |
| "NSR" archives the linked inspection     | -                                                            | Yes                   | Yes                                                                                                                                                                                                               |
| Where a "DND" or "Other" clean moves     | -                                                            | From the current time | One hour later                                                                                                                                                                                                    |

## Screens

* [Task timeline](https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/timeline.md): where managers create cleans and see them on each person's timeline.
* [Feed](https://docs.snapfix.com/how-the-apps-work/screens/tasks/feed.md): where housekeepers find their cleans.
* [Task detail](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md): the task screen, with the snooze sheet in the apps.

## API and data

* [Housekeeping API](https://docs.snapfix.com/engineering-reference/api/housekeeping.md):
  * [`GET /v1/app/housekeeping/manual-clean-types`](https://docs.snapfix.com/engineering-reference/api/housekeeping.md#get-v1apphousekeepingmanual-clean-types): the clean types, sub types, roles and durations of a site.
  * [`POST /v1/app/housekeeping/manual-hk-task/bulk`](https://docs.snapfix.com/engineering-reference/api/housekeeping.md#post-v1apphousekeepingmanual-hk-taskbulk), with its status at [`GET /v1/app/housekeeping/manual-hk-task/bulk/status/{taskId}`](https://docs.snapfix.com/engineering-reference/api/housekeeping.md#get-v1apphousekeepingmanual-hk-taskbulkstatustaskid): one clean per room, created in the background.
  * [`GET /v1/app/rooms/{uuid}/hk-businesses`](https://docs.snapfix.com/engineering-reference/api/housekeeping.md#get-v1approomsuuidhk-businesses): the cleaning and inspection groups of a room's rule.
  * [`POST /v1/app/housekeeping/reassignment/{uuid}`](https://docs.snapfix.com/engineering-reference/api/housekeeping.md#post-v1apphousekeepingreassignmentuuid): the move both apps send after a "DND" or "Other" snooze.
* The apps save the snooze itself on the device and send it with the task sync ([`?action=save_pri_job`](https://docs.snapfix.com/engineering-reference/api/tasks.md#post-actionsave_pri_job)).
* Tables: [`tPri_Job`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_job.md) (type, clean type and sub type, correction flag, lock, snooze fields), [`tPri_JobLink`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_joblink.md) (clean and inspection pairs), [`tPri_JobRoom`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_jobroom.md), [`tPri_JobChat`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_jobchat.md) (the snooze line), [`tPri_RoomStatus_TaskRules`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_roomstatus_taskrules.md) (the rules), [`tPri_Building`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_building.md) (the housekeeping flag).

## Depends on

* [Inspections](https://docs.snapfix.com/product/features/housekeeping/inspections.md): each clean's inspection, its lock and the rejection flow.
* [Assigning housekeeping tasks](https://docs.snapfix.com/product/features/housekeeping/housekeeping-assignment.md): who gets a clean and when.
* [Staff schedule](https://docs.snapfix.com/product/features/housekeeping/staff-schedule.md): which roles may take which clean type.
* [Room status](https://docs.snapfix.com/product/features/rooms/room-status.md) and [PMS integrations](https://docs.snapfix.com/product/features/integrations/pms-integrations.md): the rules and PMS changes that create and archive cleans, and the room status a clean can set.
* [Groups](https://docs.snapfix.com/product/features/groups/groups.md): the cleaning and inspection groups.
* [Tasks](https://docs.snapfix.com/product/features/tasks/tasks.md), [Checklists](https://docs.snapfix.com/product/features/checklists/checklists.md) and [Task chat](https://docs.snapfix.com/product/features/chat/task-chat.md): status, checklist, archive, delete and the snooze line.
* [Reminders](https://docs.snapfix.com/product/features/notifications/reminders.md): the schedule rule for housekeeping reminders.

## Edge cases

* **Nobody on the schedule:** cleans can still be created; they stay unassigned until someone on the schedule takes them.
* **Rooms of another site, or over 100 rooms:** the whole request is refused: "Rooms not found", or "You can select up to 100 rooms" on the web ([`POST /v1/app/housekeeping/manual-hk-task/bulk`](https://docs.snapfix.com/engineering-reference/api/housekeeping.md#post-v1apphousekeepingmanual-hk-taskbulk)).
* **No clean types:** the iOS picker shows "No clean types available".
* **Housekeeping off for the building:** a manual clean gets no inspection.
* **Snooze without an assignee:** the task turns red and no new place is asked for; Android still moves a set time range one hour later.
* **Offline:** the web needs a connection. The apps save a snooze on the device and send it with the sync.
* **Time zones:** the daily run uses each site's 06:00, but the unassigned list counts the day from midnight UTC.
* **Several sites:** each site's cleans are generated with its own rules and time.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.snapfix.com/product/features/housekeeping/cleaning-tasks.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
