Documentation

User Guide

This guide explains how to use the Tax Management System interface to manage tax configurations, coverage definitions, and perform tax calculations.

Navigation

The main navigation is accessible through the sidebar menu:

  • Dashboard - Overview of system status and quick access to features
  • Tax Information - View tax information by country and coverage
  • AI Query - Ask natural language questions about tax configurations
  • Documentation - Access this documentation
  • Tax Configurations - Manage tax rules and rate tables
  • Coverage Configurations - Define coverage types and structures
  • Tax Calculator - Calculate tax for policy scenarios

Dashboard

The dashboard provides an overview of the system and quick access to key features:

  • System Status - Current operational status
  • Recent Activity - Latest configuration changes
  • Quick Actions - Shortcuts to common tasks
  • Statistics - Overview of configurations and calculations

Tax Information

View tax configuration information for specific countries and coverage types.

Viewing Tax Information

  1. Navigate to Tax Information from the sidebar
  2. Select a country from the dropdown
  3. Select a coverage type
  4. View the applicable tax configurations, rates, and rules

Filtering

  • Use the country filter to focus on specific regions
  • Use the coverage filter to see tax rules for specific insurance types
  • Toggle "Include Inactive" to see historical configurations

AI Query

Use natural language to ask questions about tax configurations.

Using AI Query

  1. Navigate to AI Query from the sidebar
  2. Type your question in the text field
  3. Optionally filter by country or tax code
  4. Click "Ask" to get an AI-powered response

Example Questions

  • "What is the IPT rate for motor insurance in the UK?"
  • "How do I configure tax rules for property insurance?"
  • "What are the tax rates for Germany?"
  • "How do I set up coverage for travel insurance?"

Tax Configurations

Manage tax rules, rate tables, and calculation methods.

Viewing Tax Configurations

  1. Navigate to Tax Configurations from the sidebar
  2. View the list of all tax configurations
  3. Click on a configuration to view details
  4. Use filters to find specific configurations

Creating a Tax Configuration

  1. Click "Create Tax Configuration"
  2. Fill in the basic information:
    • Name - Descriptive name for the tax configuration
    • Tax Code - Unique identifier
    • Country Codes - Countries where this tax applies
    • Currency - Currency for tax amounts
  3. Configure calculation settings:
    • Calculation Based On - Premium or limit
    • Calculation Type - Percentage or fixed
    • Payable By - Who pays the tax
    • Administered By - Who administers the tax
    • Status - Active, inactive, or draft
  4. Create coverage groups and define tax rules
  5. Save the configuration

Editing a Tax Configuration

  1. Navigate to the tax configuration list
  2. Click on the configuration you want to edit
  3. Click "Edit" to modify the configuration
  4. Make your changes
  5. Save the configuration

Managing Rate Tables

Tax rates can change over time. Use rate tables to manage these changes:

  1. In a coverage group, click "Add Rate Entry"
  2. Set the effective date for the new rate
  3. Define the tax rules for this rate
  4. The system automatically uses the correct rate based on the date

Tax Rule Types

Simple Rule - Flat tax amount that always applies

  • Set the amount and amount type (percentage or fixed)
  • Mark as default if it's the fallback rule

Complex Rule - Tax that varies based on conditions

  • Define conditions that must be met
  • Set different amounts for different scenarios

Function Rule - Custom calculation using formulas

  • Write a calculation formula (Groovy script)
  • Define return type and parameters

Coverage Configurations

Define the structure and requirements for insurance coverage types.

Viewing Coverage Configurations

  1. Navigate to Coverage Configurations from the sidebar
  2. View the list of all coverage configurations
  3. Click on a configuration to view details

Creating a Coverage Configuration

  1. Click "Create Coverage Configuration"
  2. Fill in basic information:
    • Coverage Name - Human-readable name
    • Coverage Code - Unique identifier
    • Description - Detailed description
  3. Define input fields:
    • Name - Field identifier
    • Type - Data type (string, number, boolean, date)
    • Default Value - Optional default
    • Mandatory - Whether required
  4. Add country-specific inputs if needed
  5. Define additional premium types
  6. Add notes for reference
  7. Save the configuration

Country-Specific Inputs

Different countries may require different information:

  1. Click "Add Country Input"
  2. Select the country
  3. Add input fields specific to that country
  4. Example: UK might require vehicle registration number

Additional Premium Types

Define types of additional premiums that can apply to coverage:

  1. Click "Add Additional Premium Type"
  2. Specify the name and code
  3. Select applicable countries
  4. Example: Windscreen cover, breakdown cover

Tax Calculator

Calculate tax for specific policy scenarios.

Using the Tax Calculator

  1. Navigate to Tax Calculator from the sidebar
  2. Select a tax configuration
  3. Enter policy details:
    • Reference number
    • Policy dates
    • Currency
  4. Add coverage information:
    • Coverage code
    • Country
    • Premium amount
    • Coverage-specific details
  5. Click "Calculate"
  6. Review the calculated tax amounts

Testing Configurations

Use the tax calculator to test your tax configurations:

  1. Create a test scenario with realistic values
  2. Calculate the tax
  3. Verify the results match your expectations
  4. Adjust configurations if needed

Theme and Display

Dark/Light Mode

Toggle between light and dark mode using the theme button in the top-right corner.

Collapsible Sidebar

Click the menu icon to collapse or expand the sidebar for more screen space.

Best Practices

Configuration Management

  • Use descriptive names - Make configurations easy to identify
  • Document your changes - Use notes to explain complex rules
  • Test thoroughly - Use the tax calculator before deploying
  • Plan rate changes - Add future rate entries before they take effect

Data Entry

  • Use consistent naming - Follow naming conventions for codes and identifiers
  • Validate inputs - Ensure data types match between coverage and tax configurations
  • Check country codes - Use correct ISO country codes (GB, US, DE, etc.)

Security

  • Keep credentials secure - Don't share login information
  • Log out when done - Especially on shared computers
  • Report issues - Contact administrators if you notice unusual behavior

Troubleshooting

Common Issues

Configuration not appearing

  • Check that the status is set to "Active"
  • Verify country codes match
  • Ensure effective dates are correct

Calculation results unexpected

  • Verify coverage input names match exactly
  • Check tax rule conditions and order
  • Review amount type (percentage vs fixed)

AI query not helpful

  • Try rephrasing your question
  • Be more specific about country or coverage
  • Use "how to" questions for procedural help

Getting Help

If you encounter issues:

  1. Check the relevant documentation section
  2. Use the AI Query feature for immediate help
  3. Contact your system administrator
  4. Check for system status updates on the dashboard