Tax Category Detail
The Tax Category Detail page shows a single tax category’s full configuration — its code, name, exemption status, and all configured rates organized by jurisdiction and validity window. From here you can add, edit, or delete individual rates and update the category itself.
:::tip TODO Capture the tax-category-detail screenshot with a populated category and rates, and update this image. :::
Accessing the Page
Section titled “Accessing the Page”- Navigate to Pricing & Tax → Tax Categories in the sidebar
- Click any category row, or click the dropdown menu on a row and select View Rates
- Direct URL pattern:
/pricing-tax/tax-categories/:id
The breadcrumb trail updates to: Pricing → Tax Categories → [Category Code]
Header / Action Bar
Section titled “Header / Action Bar”| Button | Permission | Description |
|---|---|---|
| Back (arrow) | Any authenticated user | Returns to the Tax Categories list |
| Edit | Edit Tax Category | Opens the edit dialog to update category fields |
| Delete | Delete Tax Category | Opens a confirmation dialog to permanently delete the category |
The Add Rate button appears in the Rates section header (visible only to users with Edit Tax Category permission and only when the category is not exempt).
Summary Card
Section titled “Summary Card”The summary card at the top of the page shows the category’s current state at a glance:
| Field | Description |
|---|---|
| Code | Unique category code badge |
| Name | Category display name |
| Default Rate | Currently active default rate percentage. Displays 0% for exempt categories. Displays — if no active default rate exists. |
| Exempt | Badge shown when the category is marked as exempt (always 0% tax) |
| Default | Badge shown when this category is the system-wide default for new items |
| Status | Active or Inactive badge |
Category Info Card
Section titled “Category Info Card”The left-side info card shows additional category fields:
| Field | Description |
|---|---|
| Description | Optional free-text description (hidden if not set) |
| Exempt | Yes / No — whether the category always produces zero tax |
| Default | Yes / No — whether this is the system default tax category |
| Created by | Name of the user who created the category |
| Last updated by | Name of the user who last modified the category |
Tax Rates
Section titled “Tax Rates”The rates section occupies the right two-thirds of the page and lists all configured rates for the category.
Rate fields
Section titled “Rate fields”Each rate card displays:
| Field | Description |
|---|---|
| Jurisdiction | The jurisdiction code and name this rate applies to. Rates without a jurisdiction show a Default Rate badge — these apply when no specific jurisdiction matches. |
| Rate | The tax rate expressed as a percentage (e.g., 17.00%) |
| Status | An Active badge is shown when the rate is currently within its validity window and is enabled |
| Valid From | The date from which this rate is effective |
| Valid To | The date on which this rate expires. Blank means the rate is open-ended. |
Rate effective logic
Section titled “Rate effective logic”- The system selects the most specific jurisdiction rate that falls within the current date window.
- If no jurisdiction-specific rate matches, the default rate (no jurisdiction) is used.
- If no applicable rate is found, the category’s default rate field is the final fallback.
- Exempt categories always produce 0% tax regardless of rates configured.
Adding a Rate
Section titled “Adding a Rate”- Click Add Rate in the rates section header
- Fill in the dialog:
| Field | Required | Type | Description | Validation |
|---|---|---|---|---|
| Jurisdiction | No | Entity select | Select a jurisdiction, or leave empty for the default rate | — |
| Rate (%) | Yes | Number | Tax rate as a decimal value (e.g., 0.17 for 17%) | 0–1; enter as decimal |
| Valid From | No | Date | Date from which the rate is effective | Defaults to today |
| Valid To | No | Date | Date on which the rate expires | Must be after Valid From; leave empty for open-ended |
- Click Add Rate to save
The rate becomes active immediately if the current date falls within the validity window.
Constraint: If a rate already exists for the same jurisdiction with an overlapping date range, the system rejects the addition with an error.
Editing a Rate
Section titled “Editing a Rate”- Click the Edit (pencil) icon on a rate card
- The edit dialog opens with the rate pre-filled
- Update the Rate, Valid From, or Valid To fields as needed
- Click Save to confirm
The Jurisdiction field is read-only in edit mode — it cannot be changed after creation.
Deleting a Rate
Section titled “Deleting a Rate”- Click the Delete (trash) icon on a rate card
- A confirmation dialog warns that the action is permanent
- Click Delete to confirm — the rate is removed immediately
Editing the Category
Section titled “Editing the Category”Click Edit in the action bar to update the category’s name, description, exemption flag, default flag, or active status. The Code field is read-only after creation.
Deleting the Category
Section titled “Deleting the Category”- Click Delete in the action bar
- A confirmation dialog shows the category code and name
- Click Delete to confirm — the category is permanently removed and the page navigates back to the Tax Categories list
Restriction: A category cannot be deleted if it is currently assigned to any items or documents.
Common tasks
Section titled “Common tasks”- Open the page from the Tax Categories list by clicking a row or selecting View Rates.
- Review the summary card to confirm the active default rate and status.
- Add, edit, or delete rates as needed and verify the updated state in the rates section.
Related Pages
Section titled “Related Pages”- Tax Categories — List and manage all tax categories
- Tax Configuration — Configure the system default tax category and jurisdiction