🏢 Admin

My Business

My Business is where the Admin manages the organisation itself — adding branches, inviting and removing staff logins, and (for platform-level administrators only) overseeing every tenant on the platform.

📍 Menu path: Admin → My Business

👤 Who uses it: Admin only — always available to the Admin role regardless of plan tier, when multi-tenant/multi-branch mode is on

Overview

This page only appears with content when multi-tenant/multi-branch mode is enabled for your installation; on a single-store installation with multi-tenant mode off, it shows a simple "Multi-tenant mode is off" message instead.

A header card summarises your organisation name, its plan, and two usage meters — Branches used vs. your plan's branch limit, and Users used vs. your plan's user limit — each meter turning amber near 70% and red near 90% of the limit.

Below the header are up to three tabs: Branches and Users for everyday organisation management, and — only if your account is a platform-level administrator with no tenant of its own — an All Tenants tab for overseeing every customer organisation on the platform.

Before You Start

Multi-tenant mode must be enabled on this installation, or this page shows only an informational message.
This page is always available to the Admin role — it is marked "adminAlwaysOn" and is not gated by plan tier the way most Admin-section pages are.
Adding branches or users beyond your plan's limits is blocked client-side once you reach the meter's maximum (the Add Branch / Invite User button is disabled and relabelled "…limit reached").

Step-by-Step Guide

1 Add a new branch

Open the Branches tab.
Click Add Branch (disabled once you have reached your plan's branch limit).
Enter the Branch Name (e.g. "Main Store") and a short, unique Branch Code (e.g. "MAIN") — the code is auto-uppercased as you type.
Click Add Branch to save. The new branch appears in the table with an Active status badge.

2 Invite a new staff user

Open the Users tab and click Invite User (disabled at your plan's user limit).
Enter the Full Name, a Phone Number (this becomes their login ID), and a temporary Password (minimum 6 characters).
Choose a Role: Admin, Manager, or Cashier.
If the role is not Admin and you have more than one branch, tick which branches this user should have access to under Branch Access — leave every box unticked to grant access to all branches.
Click Invite User to create the login.

💡 Admin-role users always have access to every branch and the Branch Access picker does not apply to them.

3 Remove a user

In the Users table, click Remove on the row for the user you want to revoke.
Confirm the prompt — this immediately deactivates that person's login.

4 Platform admin: oversee all tenants (platform-level accounts only)

This tab is only visible to accounts that are platform administrators (i.e. not tied to a single tenant) and is not part of a normal shop owner's experience.

Open the All Tenants tab to see summary stat cards: Total Tenants, Active, Suspended, and Total Branches across the whole platform.
Review the tenants table for each organisation's branch, user, product, customer and sales counts, along with its Active/Suspended status.
Click Suspend or Activate on a tenant row to toggle whether that organisation can currently use the platform, after confirming the prompt.

Every Field & Button, Explained

Field / Button	What it does
`Organisation header card`	Shows your business name, its plan badge, and usage meters for Branches and Users against your plan's limits.
`Branch Name / Code`	Required fields when adding a branch; the code is a short unique identifier, auto-uppercased.
`Branch status badge`	Active (green) or Inactive (red) indicator per branch row.
`Full Name / Phone Number / Password`	Required fields when inviting a user; phone number doubles as the login ID and password must be at least 6 characters.
`Role (Admin / Manager / Cashier)`	Determines the user's permission level; Admins automatically get all-branch access.
`Branch Access checkboxes`	Optional per-branch access restriction for Manager/Cashier users — leaving all boxes empty grants access to every branch.
`User status badge`	Active (green) or Inactive (red) indicator per user row.
`Remove (user action)`	Deactivates a user's login after a confirmation prompt.
`All Tenants stat cards`	Platform-wide counts: Total Tenants, Active tenants, Suspended tenants, and Total Branches summed across every tenant.
`Suspend / Activate (tenant action)`	Toggles whether a given tenant organisation can currently access the platform; visible only to platform administrators.

Tips & Best Practices

Give each branch a short, memorable code — it shows up throughout reports and exports wherever branch identification is needed.
When inviting Cashier or Manager users for a multi-branch business, always set Branch Access explicitly rather than leaving it open to all branches, unless that is genuinely intended.
Keep an eye on the Branches/Users usage meters — once they turn red you are close to your plan's limit and should consider upgrading before you are blocked from adding more.

Troubleshooting & FAQ

This page just shows "Multi-tenant mode is off".

Your installation has multi-tenant/multi-branch mode disabled. This is a deployment-level setting, not something changeable from this page — contact support if you need multi-branch support enabled.

The Add Branch / Invite User button is disabled.

You have reached your plan's branch or user limit, shown in the usage meter on the header card. Remove an unused branch/user, or upgrade your plan to raise the limit.

A new Cashier can't see any branches after being invited.

Check that at least one branch was ticked under Branch Access when the user was invited — an empty selection is supposed to mean "all branches", but if none exist yet for your organisation there is nothing to grant access to.

Why do I see an "All Tenants" tab that other admins don't?

That tab only appears for platform-level administrator accounts that are not tied to a single tenant — it is not part of the standard shop-owner Admin experience.

🧑‍💻 Developer Notes

Source component(s):

frontend-app/packages/pos-react-lib/src/pages/TenantAdminPage.jsx

Backend endpoints used:

GET /tenant/config
GET /tenant/me
GET /tenant/branches
POST /tenant/branches
GET /tenant/users
POST /tenant/users
DELETE /tenant/users/:userId
GET /tenant/admin/tenants
PATCH /tenant/admin/tenants/:id/toggle

Related tables (db-core repositories):

Tenant
Store / Branch
User
License (for branch/user limits)

Feature flag key: billing

The "All Tenants" tab and platform stats are shown only when GET /tenant/admin/tenants succeeds AND the current user's business is null — i.e. the account is a platform admin with no tenant of its own. Regular tenant admins only ever see the Branches and Users tabs. This page is flagged adminAlwaysOn in the nav manifest, meaning it is exempt from the usual plan-tier gate applied to other Admin-section pages.