Everything it can do

Dismiss the setup checklist

Hides the getting-started checklist from the dashboard.

dismiss_onboarding_checklist

Dismiss the survey prompt

Hides the in-app survey prompt for the signed-in user without answering (it may be shown again later).

dismiss_survey

Dashboard summary

The dashboard home page as data.

get_dashboard_summary

Get setup checklist

The getting-started checklist shown on the dashboard: add a service, set working hours, add a first customer, and (owner only) connect Stripe, each with done flag, plus whether it was dismissed.

get_onboarding_checklist

What's new

Recent product updates from the What's New page, newest first, in plain language: entry date, title, intro, and items grouped by section (with the plan tiers an item applies to, when limited).

get_whats_new

Search everything

Quick cross-entity search (min 2 chars), up to 8 hits each: clients (name/email/phone), jobs (client name, property address, notes) and invoices (number, client name).

global_search

Planned features and votes

The public roadmap: features being considered with their vote counts and whether you have voted, highest-voted first, plus items coming in this week's Friday push.

list_roadmap

Contact support / send feedback

Sends a message to the Sparkly / The Cleaners Place support team as the signed-in user (it appears in their support queue with your name, email and business).

submit_feedback

Submit the customer survey

Submits the user's own answers to the short product survey (all optional, but at least one required).

submit_survey

Vote on a planned feature

Toggles the signed-in user's upvote on a planned feature: votes if they have not, removes the vote if they have.

toggle_roadmap_vote

Who am I

Returns who you are acting as in The Cleaners Place: name, role, company, plan status, and the actions your role is allowed to perform.

whoami

Accept estimate for customer

Records that the customer accepted a SENT estimate (as if they had clicked accept on their link).

accept_estimate

Add client note

Appends a line to the client's internal notes without touching the existing text (update_client REPLACES the whole notes field, so prefer this to add something).

add_client_note

Add client preference

Adds one care preference to a client (e.g.

add_client_preference

Add property checklist item

Adds a task to ONE property's own cleaning checklist (e.g.

add_property_checklist_item

Adjust referral credit

Adds (positive) or subtracts (negative) from a client's referral-credit balance, which reduces what they are billed.

adjust_referral_credit

Archive client

Archives (deactivates) a client so they drop out of the active client list.

archive_client

Archive package

Archives a package so it can no longer be sold.

archive_package

Archive service type

Archives a service type so it can no longer be picked for new jobs, quotes or schedules.

archive_service_type

Cancel recurring schedule

Ends a recurring schedule so no more visits are generated.

cancel_subscription

Book estimate as job

Books an estimate as a scheduled job at the given local date/time (use when the customer said yes verbally, or an accepted estimate had no proposed date).

convert_estimate_to_job

Create card-setup link

Creates a secure Stripe link for saving a card on file and RETURNS it instead of emailing it (email_card_setup_link emails it).

create_card_setup_link

Create client

Creates a client (customer) record.

create_client

Create estimate

Creates a DRAFT estimate/quote (nothing is sent).

create_estimate

Create package

Creates a prepaid package: a number of visits (credits) of one service type sold for a total price.

create_package

Create property

Adds a service address (property) to a client.

create_property

Create service type

Creates a service type (e.g.

create_service_type

Create recurring schedule

Creates a recurring cleaning schedule for a client (weekly, every 2/3/4 weeks, twice weekly, or monthly).

create_subscription

Decline estimate for customer

Records that the customer declined a SENT estimate (as if they had clicked decline on their link), with an optional reason.

decline_estimate

Delete estimate

Permanently deletes an estimate and its public link.

delete_estimate

Archive property

Archives a property (soft delete: hidden from pickers, history kept).

delete_property

Delete property checklist item

Permanently removes one task from a property's own cleaning checklist.

delete_property_checklist_item

Erase client personal data

PERMANENT, irreversible GDPR-style erasure of one client's personal data: name, contact details, notes, addresses, access codes, photos, card on file and portal link are removed and the client is deac

erase_client_data

Export client data

Everything stored about one client, for a GDPR/CCPA access or portability request: profile, properties, jobs, invoices, estimates, reviews and recurring schedules.

export_client_data

Get booking link

The company's public online booking page URL, the same link shown on the dashboard.

get_booking_link

Get client

Full detail for one client by id: contact info, notes, preferences, source, referral info, active properties (with access/preference notes), last 10 jobs, last 10 invoices, outstanding balance (sent +

get_client

Get estimate

Full detail for one estimate/quote by id or number (e.g.

get_estimate

Get subscription

One recurring subscription by id: schedule, price, next job date, pause window, skipped dates, assignees, notes, plus its next 5 scheduled jobs and count of completed jobs generated so far.

get_subscription

List estimates

Lists estimates/quotes, newest first.

list_estimates

List package purchases

Lists packages sold to clients, newest first, with price paid and creditsRemaining (visits left).

list_package_purchases

List packages

Lists prepaid service packages (bundles of N visits of given services at a total price) with their items and how many have been sold.

list_packages

List properties

Lists service properties (addresses) across the company, optionally for one client.

list_properties

List property checklist items

The tasks on one property's own cleaning checklist (the per-address list cleaners see), in order, with ids.

list_property_checklist_items

List referrals

Shows the referral program: every client who referred someone, was referred, or holds referral credit, with their credit balance (company currency), who referred them and who they referred.

list_referrals

List review candidates

Completed jobs from the last N days (default 14) that are good candidates for a review request: no request sent yet, no review left, and the client is active, has an email and has not opted out of emails.

list_review_candidates

List reviews

Lists customer reviews/ratings (1-5 stars), newest first, with comment, reviewer name, linked client/service and whether it is public (ratings under 4 are private for the owner to follow up).

list_reviews

List services

Lists the service catalog: each service type with description, default duration (hours), base price, active add-ons (flat extra prices), and sqft-based price tiers (a property whose sqft is in [minSqf

list_services

List subscriptions

Lists recurring cleaning subscriptions (schedules that generate jobs), active first.

list_subscriptions

List upcoming client milestones

Client birthdays, join anniversaries (1 year and up) and cleaning-count milestones (10, 25, 50, 75, 100...

list_upcoming_milestones

Pause recurring schedule

Puts a recurring schedule on hold between two dates (vacation hold): no visits are generated in the window, and any already-scheduled visits inside it are CANCELLED.

pause_subscription

Remove saved card

Deletes the client's saved card (detaches it in Stripe) and turns autopay OFF.

remove_card_on_file

Delete price tier

Permanently deletes a square-footage price tier from a service type.

remove_price_tier

Remove service add-on

Retires (archives) an add-on so it is no longer offered; past jobs are unaffected.

remove_service_add_on

Request a review

Emails the client a link to rate a COMPLETED job (4+ stars are then invited to leave a Google review; lower ratings stay private).

request_review

Restore client

Reactivates an archived client so they show in the active client list again.

restore_client

Resume recurring schedule

Clears a vacation hold so the schedule generates visits again.

resume_subscription

Create or edit price tier

Creates a square-footage price tier for a service type (e.g.

save_price_tier

Create or edit service add-on

Creates a priced add-on for a service type (e.g.

save_service_add_on

Search clients

Lists the company's clients (customers), newest page first by name.

search_clients

Sell package to client

Records the sale of a package to a client: creates the purchase with its visit credits at the package price.

sell_package

Email client portal link

Emails a client a fresh sign-in-free link to their client portal (view appointments, invoices, pay, book).

send_client_portal_link

Email estimate

Emails an estimate to its customer email with a link to view and accept it, and marks it "sent".

send_estimate

Set a customer's language

Sets one customer's preferred language for their portal and emails (en, fi, cy), or "" to follow the business default.

set_client_language

Set client referrer

Records which existing client referred this client (referrerId), or clears it (referrerId null).

set_client_referrer

Skip next visits

Skips the next N already-scheduled visits of a recurring schedule (cancels those jobs and suppresses regeneration), e.g.

skip_subscription_visit

Suggest a deep clean

Emails a recurring client a short, branded note recommending a deep clean (with the booking link when the company has one) and records the send date.

suggest_deep_clean

Update client

Edits a client. Send only the fields to change; omitted fields stay as they are.

update_client

Update estimate

Edits an estimate that is not yet accepted or booked (accepted/converted ones are locked).

update_estimate

Update package

Renames a package or changes its price.

update_package

Update property

Edits a property. Send only the fields to change; empty string clears nickname/accessNotes/preferenceNotes.

update_property

Update service type

Edits a service type's name, description, default duration or base price.

update_service_type

Update recurring schedule

Edits a recurring schedule.

update_subscription

Add one-time extra to job

Adds a one-time extra to ONE visit (e.g.

add_job_extra

Add a note to a job

Appends one line to a job's internal notes, stamped with the company-local date/time and your name (e.g.

add_job_note

Apply a new route order

Applies new start times to one person's jobs on a date (normally the stops from preview_route_optimization): updates each changed job's time, resets reminders, and EMAILS each affected client their ne

apply_route_order

Approve check-in/out correction

Approves a cleaner's pending request to correct their check-in/out times; the requested times become the real ones (this feeds pay).

approve_check_time_request

Assign staff to job

Assigns an active staff member to a job (more than one person can be assigned).

assign_job

Cancel job

Cancels a scheduled or in-progress job (it stays in history as cancelled; an existing invoice is NOT voided and the client is NOT emailed, so handle those separately).

cancel_job

Withdraw my check-in/out correction request

Withdraws YOUR pending check-in/check-out correction request on a job you are assigned to, before a manager reviews it (the recorded times stay as they are).

cancel_my_check_time_request

Change job price or billing type

Changes what a job will bill: its price and/or billingType (invoice = draft invoice is created when the job is completed; other types create none, so setting a non-invoice type means no invoice will be raised).

change_job_price

Check in to job

Records that YOU arrived on a job you're assigned to (stamps the time; the first check-in also moves a scheduled job to in_progress).

check_in_job

Check out of job

Records that YOU finished on site for a job you are assigned to (needs a check-in first).

check_out_job

Check a time slot

Advisory pre-flight for scheduling a job at a company-local date and time: warns if it is in the past, on a closed day, outside working hours, inside a block-out, or double-booking an existing job.

check_schedule_slot

Clear a cleaner's check-in/out times

Manager fix: wipe a bad check-in/check-out pair from an assigned cleaner on a job (so they can check in again, or a correct time can be set with set_job_check_times).

clear_job_check_times

Complete job

Marks an IN-PROGRESS job completed.

complete_job

Create job

Schedules a new job (visit) for a client at a company-local date and time.

create_job

Find open time slots

Open start times on a company-local date for a service type, on the 30-minute grid inside working hours, excluding block-outs and existing jobs (including the company's buffer between jobs) and times already in the past.

find_available_slots

Get job details

Everything about one job: time, client, property and access notes, service, assigned staff with check-in/out times (and any pending correction request), notes, checklist progress, weekly rotation focu

get_job

Get the "on my way" text

Returns the customer's phone number, the ready-to-send "on my way" text (the company's template filled in with the customer, your name and the company, in the customer's language) and a tap-to-open sm

get_on_my_way_message

Calendar / schedule view

The calendar for a date range (default this week, max 42 days; company-local YYYY-MM-DD): non-cancelled jobs grouped by day, business block-out dates, approved time off, and (owners/managers) a confli

get_schedule

Today's briefing

Day briefing: the jobs for a day (default today, in the company timezone) with start/end times, client, service, address, access notes, client preferences and who is assigned, plus the next job.

get_today

Pending check-in/out corrections

Cleaners' requests to correct their own check-in/check-out times on a job, waiting for manager/owner approval (oldest first).

list_check_time_requests

List jobs

Jobs (visits) with filters, oldest first by default.

list_jobs

Propose a better route order

Proposes a lower-drive-time order and start times for ONE person's open jobs on a company-local date (needs 2+ stops with addresses; locked stops stay put).

preview_route_optimization

Reject check-in/out correction

Rejects a cleaner's pending check-in/out correction request, leaving the recorded times untouched.

reject_check_time_request

Remove extra from job

Removes a one-time extra from a visit and lowers the job price (and any unpaid invoice) by the same amount.

remove_job_extra

Request check-in/out correction

Fix YOUR check-in/check-out time on a job you're assigned to (e.g.

request_check_time_correction

Reschedule job

Moves a scheduled or in-progress job to a new company-local date and time (keeps its length and assignees, resets the client's reminders).

reschedule_job

Set a cleaner's check-in/out times

Manager fix: backfill or correct the exact check-in (and optionally check-out) time of an assigned cleaner on a job, e.g.

set_job_check_times

Choose which job photos the customer sees

Sets which of a job's EXISTING photos are featured for the customer (their portal before/after gallery).

set_job_photo_sharing

Set job status

Moves a SCHEDULED job to 'in_progress' (started) or 'no_show' (client wasn't there / couldn't get in).

set_job_status

Lock or unlock a stop on the route

Pins (locked=true) or releases a job's start time so the route optimizer will not move it.

set_route_lock

Unassign staff from job

Removes a staff member from a job (the job stays scheduled, possibly unassigned).

unassign_job

Edit job

Edits a job's details.

update_job

Add a block-out

Blocks out dates (holiday, closed day, vacation) so scheduling warns and online booking is unavailable.

add_blockout

Add checklist item

Adds a task to the end of a checklist template.

add_checklist_item

Add a note to a key

Adds a short note to a key's history (e.g.

add_key_note

Add rotation task

Adds a focus task to the end of the weekly rotation (e.g.

add_rotation_task

Set supply level

Sets how full a supply is, as a percentage 0-100 (0 = out, e.g.

adjust_supply

Check in a key

Records that a key is back with the company.

check_in_key

Check out a key

Records that a key is now held by a staff member.

check_out_key

Create checklist template

Creates an empty cleaning/training checklist template (name + optional description).

create_checklist_template

Create job template

Creates a reusable job preset (name, default length, price, billing type, notes, optional service type) used to prefill new jobs.

create_job_template

Add property key

Registers a key (or lockbox/alarm code) for a property, starting with the company.

create_key

Add supply item

Adds a supply to the tracker, starting at 100% full.

create_supply

Delete a block-out

Removes a block-out so those dates become bookable again.

delete_blockout

Delete checklist item

Removes one task from a checklist template (and its reference photo).

delete_checklist_item

Delete checklist template

Deletes a checklist template and all its items (and their reference photos).

delete_checklist_template

Delete incident

Permanently deletes an incident report (and its photo links).

delete_incident

Delete job template

Deletes a job template (jobs already created from it are unaffected).

delete_job_template

Delete property key

Deletes a key record and its hand-off history.

delete_key

Delete rotation task

Removes a task from the weekly rotation; later weeks shift up.

delete_rotation_task

Delete supply item

Removes a supply from the tracker.

delete_supply

Get incident report

One incident report in full: category, complete description, photo links, whether the client was notified, resolution note, who reported it and the job it belongs to.

get_incident

Weekly rotation plan

The company's rotational-cleaning plan: a list of focus tasks that advances every N weeks (e.g.

get_rotation_plan

Route for a day

One person's driving route for a day, as the Route page shows it: stops in time order with client, address, access notes, key holder, drive time/distance from the previous point, slack minutes (negati

get_route_day

My route settings

Your own Route-page settings: preferred navigation app (google/apple/waze) and where your day starts (your own start address, or the company address when unset).

get_route_settings

Working hours

The company's weekly working hours (Sunday to Saturday: open/closed and start/end, 24h company-local) and the buffer minutes kept between jobs.

get_working_hours

Block-out dates

Company block-out dates (holidays, closures, days nobody should be booked).

list_blockouts

Cleaning checklist templates

Training/cleaning checklist templates cleaners follow on a job (a service type points at one): name, description, item count and which services use it.

list_checklist_templates

Incident reports

Job incident / damage reports (damage, access problem, injury, pet, complaint, other), newest first.

list_incidents

Job templates

Saved job templates owners use to create jobs quickly: name, service, default duration (hours), price, billing type and notes.

list_job_templates

Property keys

Property keys / lockbox codes with status (with_company, with_holder, with_client, lost), the holder, the property, the lockbox code if one is stored, and recent hand-off events.

list_keys

Supplies tracker

Cleaning supplies with a rough stock level (0-100%), the low-stock threshold and a derived status: good, low or out.

list_supplies

Time-off requests

Staff time-off requests with status (requested / approved / rejected).

list_time_off

Load starter checklists

Creates the built-in starter checklist templates (with their tasks) that the company does not already have by name.

load_starter_checklists

Reopen incident

Sets a resolved incident back to open.

reopen_incident

Reorder rotation tasks

Sets the order of the weekly rotation.

reorder_rotation_tasks

Report an incident

Logs an incident (damage, access, injury, pet, complaint, other) on a job and emails the business owner about it.

report_incident

Resolve incident

Marks an incident resolved with an optional resolution note.

resolve_incident

Tick this visit's rotation focus

Marks the weekly rotation focus as done (or not done) for one job, snapshotting the current focus task.

set_job_rotation_done

Set key status

Marks a key 'with_company' (back at the office), 'with_client' (given back to the client) or 'lost'.

set_key_status

Set the checklist for a service

Points a service type at a checklist template (cleaners work through it on those jobs), or clears it with templateId null.

set_service_checklist

Set working hours

Sets the company working hours that bookings and scheduling warnings use.

set_working_hours

Edit checklist item

Edits a checklist task (room, task text, standard ('' clears), required).

update_checklist_item

Edit checklist template

Renames a checklist template or changes its description ('' clears the description).

update_checklist_template

Edit job template

Edits a job template.

update_job_template

Edit property key

Edits a key's label, code or notes (send only what changes; '' clears code/notes).

update_key

Update rotation plan

Updates the rotation plan (the "deep-clean focus" cycle): name, cadenceWeeks (a new focus every N units; the name is historical) with cadenceUnit (days, weeks, months, or visits; visits counts each cu

update_rotation_plan

Edit rotation task

Edits a rotation task's label or detail ('' clears detail).

update_rotation_task

Edit supply item

Renames a supply or changes its low-stock threshold or note ('' clears the note).

update_supply

Charge invoice to saved card

CHARGES the client's saved card for the full invoice total right now (no email is sent).

charge_invoice_now

Add company expense

Records a company expense (Expenses page): date, category, amount and an optional note.

create_expense

Create invoice

Creates a DRAFT invoice for a client (optionally for one job; a job can only have one invoice).

create_invoice

Create invoice payment link

Creates a hosted Stripe Checkout link for the invoice total and saves it on the invoice.

create_invoice_payment_link

Delete company expense

Permanently deletes a company expense (and its receipt file, if any).

delete_expense

Email client a card-setup link

Emails the client a secure Stripe link to save a card on file.

email_card_setup_link

Get invoice

Full detail of one invoice: client, service and add-on line items, tax (label and effective rate), tip, checkout payments, auto-charge (card on file) attempts and last decline reason, and whether an o

get_invoice

Get a company expense receipt link

Returns a TEMPORARY, private signed link (valid about 10 minutes) to the receipt file attached to one COMPANY expense (Expenses page).

get_receipt_url

List company expenses

Company expenses (Expenses page) for one calendar month, newest first, with the total and a per-category breakdown.

list_expenses

List invoices

Lists invoices (newest first) with status, client, dates and totals, plus a summary of invoiced/collected/outstanding amounts for the same filters.

list_invoices

List payments received

Payments page data: paid invoices (newest payment first) over the last N days, or between explicit from/to dates, with client, amount, tip and method (autopay, card, or manual).

list_payments

Send invoice (emails the client, may charge their card)

Emails the invoice to the client and marks it sent.

send_invoice

Turn client autopay on or off

Turns automatic card payment on or off for a client.

set_client_autopay

Edit company expense

Edits a company expense's date, category, amount or note (fields you omit stay as they are; pass an empty note to clear it).

update_expense

Edit invoice

Edits the amount, tax, due date or notes of a DRAFT invoice (sent invoices must be edited in the dashboard; fields you omit stay as they are; pass null for dueDate/notes to clear them).

update_invoice

Mark invoice paid or void

Marks an invoice as paid (money was received outside the app: cash, cheque, transfer) or void (cancelled).

update_invoice_status

Create pay run

Creates a draft pay run for a date range (inclusive, company timezone) and computes a line per team member from their hours or revenue share on jobs in that window.

create_pay_run

Delete pay run

Permanently deletes a pay run and all its lines.

delete_pay_run

Finalize or re-open a pay run

Finalizes a draft pay run (approves it: amounts are frozen, team members can see their unpaid amount, and lines can then be paid) or, with action "reopen", turns a finalized run back into an editable draft.

finalize_pay_run

Get pay run

One pay run with a line per person: pay type and rate, hours, completed jobs, attributed revenue, base pay, adjustment (+ note), total, paid state/method/reference, and Stripe payout status (pending/s

get_pay_run

List pay runs

Pay runs (cleaner payroll periods), newest period first: period dates, draft/finalized status, number of people, gross pay (base + adjustments) and how many lines are still unpaid.

list_pay_runs

Staff pay settings

Active team members with their pay model and rate (visible to owner/manager only), preferred payout method and Stripe payout setup status (pending/active/restricted/unsupported).

list_staff_pay_rates

Upcoming and problem payouts

Pay-run lines that are not paid yet: what is owed, Stripe payouts in flight (retrying/pending/awaiting_funds) and failed ones with the reason.

list_upcoming_payouts

Pay a pay-run line through Stripe

PAYS one person's line of a FINALIZED pay run through Stripe: charges the owner's saved funding card/bank (the amount plus Stripe's processing fee) and transfers the pay to the person's Stripe payout account.

pay_line_via_stripe

Recompute pay run

Rebuilds a DRAFT pay run's lines from the latest jobs, hours and staff pay rates (manual adjustments are kept).

recompute_pay_run

Refresh a team member's Stripe payout status

Re-checks one team member's Stripe payout setup with Stripe and saves the result (active = they can be paid via pay_line_via_stripe; pending / restricted = they must finish or fix setup).

refresh_cleaner_payout_status

Retry a failed Stripe payout

Retries the transfer to the person for a line where the owner was already charged but the transfer failed or is waiting (status failed or retrying).

retry_stripe_payout

Set pay line adjustment

Sets the manual adjustment (bonus positive, deduction negative; REPLACES any earlier adjustment, it is not added) and an optional note on one person's line of a DRAFT pay run.

set_pay_line_adjustment

Record a manual (cash / Zelle / cheque) pay payment

RECORDS that you already paid one person's line of a FINALIZED pay run outside the app (cash, Zelle, cheque, bank transfer).

set_pay_line_paid

Change when revenue-share pay is earned

Company-wide setting for people paid a % of revenue: "paid" = a job counts once its invoice is paid; "completed" = it counts as soon as the job is completed, even if the client has not paid.

set_revenue_share_basis

Change how shared jobs are split for revenue-share pay

Company-wide setting for people paid a % of revenue: "split" = a job's revenue is divided evenly across everyone assigned, then each person's % applies; "full" = each person's % applies to the whole job.

set_revenue_split_mode

Change a team member's pay

Changes how a team member is paid: payType hourly | revenue_share | none and the payRate.

set_staff_pay

Change a draft pay run's dates

Changes the start/end dates (inclusive, company timezone) of a DRAFT pay run and REBUILDS its lines for the new window from jobs, hours and current pay rates (manual adjustments are kept for people wh

update_pay_run_period

Profit by client and service

Margin after labor by client and by service over the last N months (paid invoices on jobs, minus estimated crew pay from each cleaner's pay model).

get_profit_breakdown

Profit report

Profit over the last N months: paid revenue, logged expenses by category, estimated card fees (2.9% + 0.30 per online payment unless the client pays the fee), tax set-aside, and take-home profit.

get_profit_report

Retention and churn risk

Client retention for clients who joined in the last N months: how many are still active (a real visit in the last 90 days), median lifetime value, clients at risk of leaving (streak of cancellations/n

get_retention_report

Revenue report

Reports page overview: paid revenue per month for the last N months, KPIs (jobs this month, completed, average job value last month, outstanding unpaid invoices), top clients by completed jobs (last 3

get_revenue_report

Year-end tax / accountant summary

The data behind the Reports page CSV exports (summary, income, expenses, payroll) for one calendar year, returned as summarized JSON rather than a file.

get_tax_summary

Add an onboarding step

Adds a step to the end of the company onboarding checklist that every staff member works through.

add_onboarding_task

Add feedback about a team member

Writes a feedback note about a team member (praise, improve, or general).

add_staff_feedback

Approve a time-off request

Approves a pending time-off request (status "requested" in list_time_off_requests), blocking that person from being scheduled on those days.

approve_time_off

Cancel a staff invite

Withdraws a pending staff invitation so its link stops working and frees the plan slot.

cancel_staff_invite

Change a staff member's role

Changes someone's role between cleaner, manager and owner, which changes what they can see and do (owners can do everything; managers run jobs/clients/invoices but not billing, settings or role changes).

change_staff_role

Deactivate a staff member

Removes someone's access: they are signed out everywhere, lose any connected AI assistant access, and are taken off all future job assignments (history is kept).

deactivate_staff

Delete an onboarding step

Permanently removes an onboarding step from the company checklist and from every staff member's completed list.

delete_onboarding_task

Delete a staff document

Permanently deletes a staff member's compliance document and its stored file (any status, including accepted ones).

delete_staff_document

Delete a feedback note

Permanently deletes a feedback note about a team member.

delete_staff_feedback

Deny a time-off request

Rejects a pending time-off request with an optional reason.

deny_time_off

Get company availability

The business's weekly working hours (per weekday: open flag, start/end HH:MM in the company timezone) and block-out dates (holidays, closures; upcoming by default).

get_company_availability

Get a staff document link

Returns a temporary (about 10 minutes), private, signed download link for one staff compliance document so the user can open it.

get_staff_doc_url

Get staff member

Full profile of one team member: contact, role, pay setup, payout method, onboarding checklist progress (done/total and each step), document summary (see list_staff_documents for details), and pending

get_staff_member

Staff onboarding progress

The company onboarding checklist (steps, and which are tied to a document kind that auto-completes when a document is accepted) plus each active team member's progress (done/total and which steps remain).

get_staff_onboarding

Staff contribution stats

One team member's contribution over the last N days (staff page): completed jobs, revenue attributed to them from paid invoices (split across the crew unless the company counts full revenue), tips, sc

get_staff_stats

Invite a staff member

Emails an invitation (valid 7 days) to join the company as cleaner, manager or owner.

invite_staff

List staff

Lists the team (owner, managers, cleaners) with role, active status, contact details, pay type/rate and payout method.

list_staff

List staff documents

Lists staff compliance documents (W-9, agreements, IDs, certifications, background checks): kind, label, status (uploaded = awaiting review, accepted = verified, rejected), expiry.

list_staff_documents

List staff feedback notes

Feedback notes owners/managers wrote about team members (praise, improve, general), with author, date, and whether the note is shared with the person (shared) or private to owners/managers.

list_staff_feedback

List pending staff invites

Lists staff invitations that have not been accepted yet (email, role, sent date, expiry, and whether expired).

list_staff_invites

List time-off requests

Company-wide staff time-off requests with person, dates (YYYY-MM-DD, inclusive), note, and status (requested = awaiting a decision, approved, rejected).

list_time_off_requests

Load starter onboarding steps

Adds ready-made onboarding steps (agreement, W-9 on file, app walkthrough, shadowing, quality standards, supplies, key procedure, cancellation policy, first solo clean review) to the company checklist.

load_onboarding_starters

Reactivate a staff member

Restores a deactivated team member with their previous role and history (upcoming job assignments removed at deactivation are not restored).

reactivate_staff

Resend a staff invite

Re-sends a pending staff invitation email and extends it another 7 days.

resend_staff_invite

Accept or reject a staff document

Accepts or rejects a document a staff member uploaded (status "uploaded" in list_staff_documents).

review_staff_document

Set a staff document expiry date

Sets or clears the expiry date of a staff document (certifications, insurance, background checks), which drives the expiring-soon reminders.

set_staff_document_expiry

Share or hide a feedback note

Toggles whether a feedback note about a team member is shared with that person (they then see it on their own onboarding page) or private to owners/managers.

set_staff_feedback_shared

Mark a staff onboarding step

Marks one onboarding checklist step done (or not done) for a team member, including document-linked steps (manager override).

set_staff_onboarding_step

Edit an onboarding step

Changes the text and/or linked document kind of an existing onboarding step (docKind: null removes the link).

update_onboarding_task

Update staff member details

Changes a team member's display name, phone number or calendar colour (not their role: use change_staff_role).

update_staff_member

Snooze the payout setup reminder

Snoozes the owner's "set up how you pay your team" reminder for about two weeks.

dismiss_payout_setup_prompt

Plan and payments setup status

Owner only. Status (no ids or secrets) of the subscription plan and trial, staff seats used vs allowed, whether Stripe is connected for taking customer payments, the card/bank saved to fund cleaner pa

get_billing_status

Get company settings

The company profile and settings from Settings: name, phone, address, timezone, country, currency, language, VAT number and default tax rate (percent), tips and pass-card-fee toggles, tax set-aside pe

get_company_settings

Get integrations status

Which integrations are connected, as on the Integrations page: Stripe (customer card payments; connected flag and account id), Google reviews link (set or not), and QuickBooks (coming soon).

get_integrations_status

Get plan and staff limit

Subscription plan (trial / solo / team / enterprise / cancelled), whether it is active, trial end date and days left, staff limit usage (active employees, pending invites, limit, over limit, at capaci

get_plan_status

Remove the saved payout funding card / bank

Owner only. Removes the card or bank account saved to FUND team payouts (it is detached at Stripe and cleared from the company).

remove_owner_payout_card

Set the business default language

Sets the default language customers see from this business: booking page, quotes, invoices, client portal and emails (en English, fi Finnish, cy Welsh).

set_company_language

Update public marketplace listing

Updates the public "Find a cleaner" directory listing (US companies only): visible on/off, short bio, and the service area as a zip-code list or a radius around a centre zip.

set_marketplace_listing

Update business settings

Changes operating settings from Settings: tipsEnabled (customers can tip), passFeeToClient (card processing fee is added to what customers pay), taxSetAsidePercent (0-100, for profit reports), jobGapM

update_business_settings

Update company profile

Changes the company name, phone, address, timezone, and (non-US companies only) VAT number, as in Settings.

update_company_profile

Update email accent colour

Sets the accent colour used in customer emails (buttons, headings) as a hex colour like #2563eb; "" resets to the default.

update_email_branding

Update email notification settings

Turns on/off the optional emails: milestone emails to customers (birthday, anniversary, cleaning-count; sent automatically when on), the weekly "what's new" email to the owner, and the blog email to owners.

update_notification_settings

Update staff payout methods

Sets which ways staff can be paid in pay runs: any of stripe (direct deposit via Stripe, US companies only), cash, check, other.

update_payout_methods

Cancel my time-off request

Withdraws one of your own time-off requests, only while it is still pending (not yet approved or denied).

cancel_my_time_off

Delete my uploaded document

Retracts one of your own uploaded documents, only while it is still waiting for review (status "uploaded"); accepted or rejected documents stay as a record.

delete_my_document

Get a link to my document

Returns a temporary (about 10 minutes), private, signed download link for one of YOUR OWN uploaded documents.

get_my_doc_url

Get my expense receipt link

Returns a TEMPORARY, private signed link (valid about 10 minutes) to the receipt attached to one of YOUR OWN expense log entries.

get_my_receipt_url

Add to my expenses

Adds an entry to YOUR OWN private expense log (for your year-end taxes; the owner cannot see it).

my_add_expense

My availability

Your availability picture: the business's weekly working hours (company timezone) and your own upcoming approved and pending time off.

my_availability

My documents

Your own compliance documents (W-9, agreement, ID, certifications): kind, label, review status (uploaded = waiting for review, accepted = verified, rejected with reason) and expiry.

my_documents

My expenses

Your own expense log for one year (My expenses page: supplies, mileage, vehicle, equipment, phone, insurance, training, other), newest first, with totals per category and for the year.

my_expenses

My onboarding

Your onboarding checklist: each step, whether you completed it, and (for steps tied to a document like a W-9) which document kind it needs; plus feedback notes your manager chose to share with you.

my_onboarding

My pay

Your own pay: how you are paid (pay model, rate, payout method and Stripe payout setup status), your pay-run lines that are paid or on the way (amount, period, paid date, when a Stripe payout should r

my_pay

My profile

Your own staff profile: name, email, phone, role, how you are paid (pay type and rate) and payout method/status, route start address and preferred maps app, language.

my_profile

My time off

Your own time-off requests with dates (YYYY-MM-DD, inclusive), note and status (requested = waiting for your manager, approved, rejected with reason).

my_time_off

Edit my expense

Edits one of YOUR OWN expense log entries (fields you omit stay as they are; pass an empty note to clear it).

my_update_expense

Refresh my Stripe payout status

Re-checks YOUR Stripe payout setup with Stripe and saves the result (active = you can be paid by direct deposit; pending / restricted = setup is unfinished or needs attention in the app).

refresh_my_payout_status

Report a pay problem to support

Any signed-in team member (cleaner, manager or owner) can report a missing or wrong payout or ask a pay question.

report_pay_issue

Request time off

Submits a time-off request for yourself (any role) covering startDate to endDate inclusive (YYYY-MM-DD), held for an owner/manager to approve or deny.

request_time_off

Set my dashboard language

Sets the language of your own dashboard and app (en English, fi Finnish, cy Welsh).

set_my_language

Tick off my onboarding step

Marks one of your own onboarding checklist steps done or not done.

set_my_onboarding_step

Choose how I get paid

Sets how YOU want to be paid: stripe (direct deposit via Stripe), cash, check or other (needs a note saying how, e.g.

set_my_payout_method

Update my route preferences

Sets your own route preferences: which maps app opens for directions (google, apple, waze) and the address your daily route starts from ("" clears it).

update_my_route_settings