Tax Groups
Use this page to define how tax applies at each location — pick a tax rate (or mark Tax Exempt), choose inclusive or exclusive pricing, and assign products, categories, order types, deals, or whole-order charge types (Surcharge, Service, Delivery).
Open the screen: Sidebar → Tax Management → Tax Groups
Create rates first
Each non-exempt group links to one Tax Rate from Tax Rates. Add rates there before building groups.
Tax groups list
What it does
Shows summary cards, a filterable table of groups, and view/edit/delete actions.
Step-by-step
- Open Tax Management → Tax Groups.
- Optionally use filters (below).
- Read summary cards — Active Groups, Inactive Groups, Total Entities, Total Groups.
- Read the table columns.
- Tap refresh to reload.
- Use pagination for page size (10, 20, 50, 100).
Filters
| Filter | What it does |
|---|---|
| Search | Search tax groups... — press Enter to apply. Clear via Search: badge X. |
| Status | All Status, Active (default), or Inactive |
| Tax Rate | All Tax Rates or one rate (name and % shown) |
| Entity | All Entities, Products, Categories, Order Types, or Orders |
What the table shows
| Column | Meaning |
|---|---|
| Tax Group | Group name; subtext shows created date and entity count |
| Location | Outlet name (wide screens) |
| Tax Rate | Linked rate name and % badge |
| Type | Inclusive, Exclusive, or Exempt badge |
| Applied To | Icons for products, categories, order types, surcharges + Total: N |
| Status | Active or Inactive |
| Actions | View, Edit, Delete |
Row actions
| Action | What it does |
|---|---|
| View (eye) | View Tax Group (read-only) |
| Edit (pencil) | Edit Tax Group |
| Delete (trash) | Delete confirmation dialog |
Common mistakes / FAQs
- “No tax groups found”. Clear filters or tap Add Tax Group.
- “Error loading tax groups”. Tap Try Again.
- Entity pickers disabled in the form. Select Location first.
Add or edit a tax group
What it does
Opens a multi-section dialog — Create New Tax Group, Edit Tax Group, or View Tax Group.
Step-by-step
- Tap Add Tax Group, or Edit / View on a row.
- Complete sections in order: Basic Information → Tax Configuration → Entity Assignments → Advanced Settings.
- Tap Create Tax Group / Update Tax Group (Creating... / Updating...) or Cancel.
- On success: Tax group created successfully. / Tax group updated successfully.
Basic Information
| Field | Required? | What to enter |
|---|---|---|
| Location | Yes | Outlet for this group. Locked on edit — cannot move a group to another location after save. Filters entity pickers. |
| Group Name | Yes | Display name (for example Food Items GST 5%) |
New groups get an auto-generated internal group ID (not shown in the form).
Tax Configuration
| Field | Required? | What to enter |
|---|---|---|
| Tax Rate | Yes (unless exempt) | Pick from Tax Rates — hidden when Tax Exempt is on |
| Tax Exempt | No | No tax applied; requires Exemption Reason. Disabled when Surcharge, Service, or Delivery tax is on |
| Tax Exclusive | No | When on, tax is added on top of price (off = Inclusive). Disabled for surcharge/service/delivery modes |
| Exemption Reason | Yes if exempt | For example Essential goods |
Entity Assignments
Pick one approach:
A — Charge-level tax (mutually exclusive toggles):
| Toggle | What it does |
|---|---|
| Surcharge Tax | Tax all surcharges |
| Service Tax | Tax all service charges |
| Delivery Tax | Tax all delivery charges |
Enabling one clears products/categories/order types/deals and other charge toggles.
B — Item-level assignments (when no charge toggle is on):
| Block | How to add |
|---|---|
| Products | + → Select Products (search, shows if already assigned to another group) |
| Categories | + → Select Categories |
| Order Types | + → Select Order Types |
| Deals | + → Select Deals |
At least one entity or charge toggle is required unless using Tax Exempt with valid setup.
Charge tax vs item tax
You cannot mix Surcharge / Service / Delivery tax with product/category picks — toggles clear item-level selections.
Advanced Settings
| Field | What to enter |
|---|---|
| Effective From | Optional datetime-local — when the group starts |
| Effective To | Optional end date/time |
| Active Status | Switch for Active / Inactive |
Validation toasts (examples)
- Group name is required
- Please select a location
- Please select a tax rate
- Exemption reason is required when tax exempt is enabled
- At least one entity (products, categories, order_types, order, surcharge, service, delivery, or deal) is required
View a tax group
Same dialog as edit with all fields read-only. Subtitle: View tax group details and entity assignments. Tap Close.
Delete a tax group
- Tap Delete on the row.
- Confirm — This will permanently delete the tax group and all its entity assignments. This may affect tax calculations for orders.
- On success: Tax group deleted successfully.
Permissions
| What you need | Why |
|---|---|
| Tax Groups module permission | See the menu and list |
| CREATE | Add Tax Group |
| UPDATE | Edit |
| DELETE | Delete |