Module Reference

Account

A signed-in customer's own page on the website, with their bookings, orders, points and profile.

Account is the page a signed-in customer opens on the customer site. It draws the frame (the tab bar and the overview) and other Modules fill it: Booking adds the customer's bookings, Queue their queue tickets, Storefront their orders, POS their visits, and Membership their points and packages. With Customers on, the customer can also edit their own profile and connect earlier visits to their login. Account keeps no records of its own. The profile and consent belong to Customers, and a Module that's switched off drops its tab.

What it handles

  • A business that has turned the portal off. With Booking or Membership on, the page opens only while Enable CRM and Customer portal are both on under Settings → Application → Customers. A signed-out visitor is asked to sign in instead of being told the portal is off. Tested: "Account: portal follows the Customers switches"
  • A customer editing someone else's record. A customer reads and changes only the profile and consent linked to their own login, even when the request names another customer. An edit made from a stale copy of the profile is refused, and a session with no identity behind it can't read or change anything. Tested: "Account: customer profile self-service"
  • Connecting earlier visits to a new login. A customer who visited before signing up is offered the guest profile that holds the phone number or email their login has proved, and only that one: a longer number containing theirs doesn't match, and a contact they haven't proved offers nothing. Asking to connect any other profile is refused. Tested: "Account: portal history connect"
  • A few more details after sign-up. When the business asks for extra details (gender, birth date) at sign-up, a required field holds the customer on that step and can't be skipped. A field the business has turned off is refused, and the details land on the customer's record in Customers. Tested: "Account: a few more details after sign-up"

What you build on top

  • Which Modules to switch on. Account shows only what other Modules add. Switch on Customers for the profile, Membership for points and packages, and Booking, Queue, Storefront or POS for the customer's history with each.
  • Your own tabs and panels. Add a tab with account.tabs, a panel on the overview with account.overview, and a check that runs once the customer is signed in (a page they must see first) with account.gates. Customers uses a gate for the details step. See Extend a Module.
  • Your words. Rename the tabs with an override.
  • In code. Your coding agent imports Account only through its public API: index.ts and server/index.ts in apps/web/src/modules/account/. See Build on a Module.

Limits

  • Account has no page for staff. Staff look customers up in Customers' admin pages.

Facts

Pages

WherePath
Customer site/account

Slots

Places other Modules and your app code can add to. See Extend a Module.

  • account.tabs
  • account.overview
  • account.gates

Tested workflows

  • Account: endpoint congruence
  • Account: import graph
  • Account: customer profile self-service (with Customers on)
  • Account + customers: generated composition (with Customers on)
  • Account + customers: customer card (with Customers on)
  • Account: portal history connect (with Customers on)
  • Account: a few more details after sign-up (with Customers on)
  • Account + membership: endpoint congruence (with Membership on)
  • Account: portal follows the Customers switches (with Membership on)