Appointments Overview Public

Appointments

End-user documentation for the ERPat Appointments module (spa / salon / clinic booking).

Guide version: r1 Module version: 1.0.0 Updated: 2026-07-22 Estimated time: 13 min 1 views
Overview

ERPat Appointments

The Appointments module is a complete booking system for spas, salons, and clinics — it takes a customer from a first request all the way through the visit, checkout, and follow-up. This page is your map of the whole module: what it does, who uses each part, and where to go next.

Book it. Serve it. Get paid. Bring them back.

One place for your calendar, your service menu, prepaid packages, a waitlist, reports, settings — plus a public page where customers book themselves online.

???? Calendar & lifecycle ???? Online booking portal ???? Checkout & loyalty ???? Reports & reviews
????
New here? Jump straight to Getting Started for a first-run setup checklist, or use the Glossary & Legends whenever a term is unfamiliar.

What is the Appointments module

The Appointments module runs online and front-desk bookings for the treatments your business offers — haircuts, massages, facials, consultations — performed by staff providers in your rooms or chairs. It answers the everyday questions a front desk faces: What's on today? Is this time free for this stylist? Did the client show up? What did we use or sell? Have we been paid?

It is built around a few connected ideas:

  • A service menu — the treatments customers can book, each with a duration, price, colour, and the staff qualified to perform it. (See Services & Staff.)
  • A calendar & lifecycle — every booking moves through clear stages, from a fresh request to a finished, paid visit. (See Calendar & Appointments.)
  • An availability engine — the system works out real, bookable time slots from each provider's working hours, existing bookings, and service buffers. Times are never free-typed.
  • A public booking portal — an optional web page where customers book themselves online without logging in. (See Online Booking Portal.)
  • Money & retention — turn a finished visit into an invoice, take payment, apply prepaid packages, award loyalty points, and collect reviews. (See Checkout & Payments.)
ℹ️
Two sides, one module There is a staff/admin side (calendar, catalog, checkout, reports, settings) that your team operates, and a public side (the online booking page, waitlist join, and review page) that customers use on their own. The public portal only appears once a manager enables it in Settings.

What you can do here at a glance

????
See & create bookings on a colour-coded calendar
????
Let customers book online 24/7
????
Invoice, take payment & award loyalty
Collect star reviews after each visit

Who uses it (roles)

Different people touch different parts of the module. Access is controlled by permissions, so a person only sees what their role grants — and an admin bypasses every permission check.

Front desk / reception Manager Admin Customer

Front-desk / reception staff live in the Calendar. They create walk-in and phone bookings, check clients in, mark visits Completed or No Show, record products used or sold, run checkout, and add people to the Waitlist. They confirm online bookings that arrive as Pending.

Managers do everything the front desk does, plus build the service menu and packages, review a customer's spend and history, read the Workforce Monitor and reviews, and configure booking rules and automation in Settings (needs the Manage Appointment Settings permission).

Admins have unrestricted access — every permission gate is bypassed. Admins typically enable the module, turn on public booking, and set up the initial catalog and settings before handing day-to-day running to managers and the front desk.

Customers never see the admin screens. They interact only with the public pages: the online booking portal (book a service, join the waitlist when full) and the review page (rate a completed visit). No login is required for any of these.

Permissions at a glance

Each area is gated by its own permission. If a button or menu item is missing, it usually means the permission hasn't been granted.

AreaBase permissionWho typically holds it
Calendar & appointmentsappointments (+ create / update / delete)Front desk, managers
Checkout & invoicingappointment_checkoutFront desk (with checkout rights), managers
Services & categoriesappointment_services (+ create / update / delete)Managers
Packages & membershipsappointment_packages (+ create / update / delete / sell)Managers, front desk (to sell)
Waitlistappointment_waitlist (+ create / update / delete)Front desk, managers
Reports & analyticsappointment_reportsManagers, team leads
Settings & remindersmanage_appointment_settingsManagers, admins
Online booking / review pagesNone — fully publicCustomers (no login)
ℹ️
Two conditions gate everything The whole module needs to be enabled (Settings → Manage Modules) before any screen or automation works. The public booking pages additionally require the Enable public booking page switch to be on — see Settings & Reminders.

Module map (card grid)

The module is organized into six staff areas plus one public portal. Each card below opens its dedicated page in this guide.

The public online booking portal

????
Also handy Two reference pages tie everything together: End-to-End Workflows (SOP) for step-by-step standard procedures, and FAQ & Troubleshooting for the “why isn't this working?” questions.

The appointment life-cycle at a glance

Everything in the module is driven by an appointment's status. Status sets the calendar colour, decides which action buttons appear, and controls what business logic fires (stock, commission, and loyalty on completion; entitlement release and waitlist alerts on cancellation). A booking normally flows left-to-right, with Cancelled and No Show as off-ramps.

Pending
Awaiting confirm
Confirmed
Email sent
Checked In
Arrived
In Progress
Underway
Completed
Settled

From request to review — the big picture

Here's how a single booking travels through the whole module, and which area handles each step.

  1. A booking is requested

    A customer books on the online portal (landing as Confirmed), or the front desk creates it on the Calendar for a walk-in or phone enquiry. If nothing is free, the customer can join the Waitlist instead.

  2. It lands on the calendar

    The booking appears colour-coded by status. A fresh online booking is already Confirmed and emails the customer; a Pending booking is confirmed with one click. The slot is guarded so two people can't take the same provider's time.

  3. The visit is delivered

    When the client arrives, staff Check In, then mark In Progress as work starts. Along the way they record any back-bar use (products consumed) and retail sales via Manage Items.

  4. Completion & checkout

    Marking the visit Completed fires one-time logic: commission is captured, back-bar stock is decremented, and loyalty is awarded. At Checkout, staff apply any prepaid package coverage, create the invoice, and take payment (in store or via an online pay link).

  5. Loyalty & review follow-up

    Loyalty points accrue automatically on completion. A little later, an automated email invites the customer to leave a 1–5 star review, which feeds the averages on the Reports page.

????
Completion is a one-way trigger The completion side-effects (stock, commission, loyalty) fire only when moving to Completed, and each is latched to run exactly once — re-completing never double-applies, and cancelling afterwards does not automatically reverse points or committed stock. A completed-then-cancelled visit is treated as settled.
⚠️
Cancel vs. Delete Cancelling an appointment captures a reason, releases any package entitlements it used (unless already invoiced), and emails matching waitlist customers that a spot opened. Deleting just hides the record and performs none of those effects — cancel, don't delete, when you need those handled.

Status legend

Status colours are consistent everywhere — the same colour appears on the calendar event and on the status chip. Keep this legend handy; the full definitions live in the Glossary.

Appointment statuses

Pending PendingBooking exists but is not yet confirmed — typically a fresh online booking. The only next action offered is Confirm. Amber #f0ad4e.
Confirmed ConfirmedConfirmed and the customer received a confirmation email. Every successful online booking starts here. Only Confirmed appointments get reminder emails. Teal #1d97a6.
Checked In Checked InThe customer has arrived at the front desk. Can move to Completed, No Show, or Cancelled. Light-blue #5bc0de.
In Progress In ProgressThe service is currently underway. It has no dedicated button on the detail card — set it via the Status dropdown on the edit form. Light-blue #5bc0de.
Completed CompletedVisit finished. Captures commission, decrements stock, and awards loyalty (once each). Terminal, and the only status that unlocks the review page. Hidden by default in the list filter. Green #5cb85c.
Cancelled CancelledCancelled with a captured reason; releases package sessions (unless invoiced) and notifies the waitlist. Terminal. Hidden by default in the list filter. Red #d9534f.
No Show No ShowThe customer did not arrive. Excluded from availability and workforce workload; sends no email. Terminal. Hidden by default in the list filter. Grey #777777.
ℹ️
Where did my appointment go? The appointments list defaults to showing Pending, Confirmed, Checked In, and In Progress. Completed, Cancelled, and No Show are hidden until you tick their filter checkboxes — if a past appointment seems “missing”, that's usually why.

Waitlist statuses

The Waitlist has its own short lifecycle for customers who couldn't get a slot.

Waiting WaitingQueued and not yet alerted. Only Waiting rows show the manual notify (bell) action and can be auto-notified on a cancellation. Shown by default. Orange #f0ad4e.
Notified NotifiedA “slot opened” email has been sent (manually or automatically). Shown by default. Light-blue #5bc0de.
Booked BookedThe customer converted and re-booked. Set manually; hidden from the default view. Green #5cb85c.
Cancelled CancelledThe entry is no longer active. Set manually; hidden from the default view. Red #d9534f.

Appointment item lines

What each product or service line on an appointment represents — relevant at Checkout and in reports.

ServiceThe primary booked treatment. Auto-managed by the booking form; cannot be deleted from the items modal. Can be covered by a package.
Back-bar useA product consumed during the service (shampoo, dye, foils). Priced 0 to the customer, decrements stock on completion, and never appears on the bill.
Retail saleA product sold to the customer to take home. A billable line that carries a retail price and appears on the invoice.
Covered by package Covered by packageA service paid for with one of the customer's prepaid package sessions, and therefore excluded from the invoice. Can only be applied or removed before invoicing.

Where to start

Not sure where to begin? Pick the path that matches your role and what you need to do today.

Quick start by goal

I want to…Go to
Set up the module for the first timeGetting Started
Build my service menu & assign staffServices & Staff
Book a walk-in or phone appointmentCalendar & Appointments
Let customers book themselves onlineOnline Booking Portal + Settings
Take payment after a visitCheckout & Payments
Sell a prepaid package or membershipPackages & Memberships
Capture customers when I'm fully bookedWaitlist
See how the business is performingReports & Analytics
Configure reminders, loyalty & review emailsSettings & Reminders
Follow a full step-by-step procedureEnd-to-End Workflows (SOP)
Troubleshoot something that isn't workingFAQ & Troubleshooting

First-run checklist (managers & admins)

Actor: manager or admin. A minimal path to a live, bookable business. Each step links to its full page.

  1. Enable the module

    In Settings → Manage Modules, turn on Appointments. Nothing else works until this is on.

  2. Build categories, then services

    On Services & Staff, create your categories first (the service form only offers active ones), then add each service with its duration, price, and buffers.

  3. Assign staff to each service

    Use the Assign Staff action so only qualified providers are offered. A service with zero assigned staff can't be booked — the Providers count staying at 0 is the tell.

  4. Tune the booking rules

    On Settings & Reminders, set the slot interval, minimum lead time, and maximum advance days, then decide on deposits, commission, loyalty rate, and review requests.

  5. Turn on public booking (optional)

    If you want online self-booking, tick Enable public booking page and share your public booking URL. Make sure each provider has an HR weekly schedule, or no slots will appear. See the Online Booking Portal.

  6. Do a test booking

    Open your public booking URL (or use the Calendar) and book a real appointment end-to-end to confirm slots appear and confirmation emails send.

????
Tip Leave Provider on “Any available provider” whenever a customer doesn't care who serves them — the system then pools every qualified staff member and offers their combined open times, and picking a slot assigns whoever that slot belongs to.

Common first questions

Do customers need an account to book online?

No. The online booking portal, waitlist join, and review pages are all fully public — no login required. When a customer books with a new email, a customer record is created automatically; if the email already exists, that account is reused.

Why can't I see the Appointments menu or settings?

Two reasons are common: the module isn't enabled (Settings → Manage Modules), or your user doesn't hold the required permission for that area (for example manage_appointment_settings for the Settings page). Admins bypass all permission checks.

A service shows no available times — is it fully booked?

Not necessarily. The Time list only shows slots the availability engine returns. Common causes: the provider has no HR weekly schedule that day, no staff is assigned to the service, the date is closer than the minimum lead time or beyond the maximum advance window, or large buffers are eating the free time. See FAQ & Troubleshooting.

What's the difference between cancelling and deleting a booking?

Cancelling handles the business side — it captures a reason, releases package sessions (unless invoiced), and alerts matching waitlist customers. Deleting simply hides the record and does none of that. Prefer cancel when those effects matter.

When do loyalty points and reviews happen?

Loyalty points are awarded automatically, once, when a visit is marked Completed (if a rate is set). A review-request email is sent automatically a configurable number of hours after completion, and the customer rates the visit on a public page. Details are on Checkout & Payments and Settings & Reminders.

ℹ️
Keep going When you're ready, head to Getting Started for the guided setup, or dive into any module area from the map above.
Was this guide helpful?

Report a content problem