OpusPAY
User guide
×
Menu
Index

Edit Tax Group

This modal allows the user to update an existing Tax Group
 
Edit Tax Group
1

Close

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
-
1. This should close the modal and take the user back to the Tax Groups screen.
-
-
-
-
-
-
2

Tax Group Name

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should allow the user to enter a Tax Group Name
 
2. This should display an inline error message if the user clicks the 'Save' button without populating this field.
 
3. Check Tax Group Name against already existing ACTIVE Tax Group Names when the user exits this field. If the Tax Group Name already exists, display an inline error message to the user and change the font of this field to red.
Y
-
Y
255
-
2. Please enter a Tax Group Name.
 
3. Tax Group Name already exists, please enter a new Tax Group Name.
3

Country

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Combo- Box
-
1. This should allow the user to select a Country.
 
2. If there is an ACTIVE merchant in the country currently set in the database for this Tax Group, Country cannot be edited. If user attempts to change the country, display an inline error message and do not change the country from the one currently set in the database.
 
3. List of Countries should come from our database of countries, states, post codes, etc. as is used in byondcloud.
 
4. This should display an inline error message if the user clicks the Submit button without populating this field.
 
5. Check existing ACTIVE Tax Groups when the user exits this field. If a Tax Group combination of Country and All States already exists, display an inline error message to the user.
Y
-
Y
-
Default to country currently set in the database for this Tax Group
2. There is at least one merchant in the country set for this Tax Group. The country cannot be changed until a different Tax Group is assigned to all merchants in the current country.
 
4. Please select a Country
 
5. A Tax Group for All States within the Country selected already exists. Duplicate Tax Groups of a Country and State combination are not permitted.
4

Tax Rate

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Number / Decimal
Tax Rate is a percentage.
 
New tax rate will be applied to all transactions included on next invoice for the merchant.
1. This should allow the user to update a Tax Rate.
 
2. This should allow for decimal input.
 
3. This should display an inline error message if the user clicks the Submit button without populating this field.
Y
-
Y
-
-
3. Please enter a Tax Rate.
5

Active

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Checkbox
1. Active Tax Groups are available to be selected and assigned to a Merchant.
 
2. Inactive Tax Groups are unavailable to be selected and assigned to a merchant.
 
3. Tax Groups cannot be set to Inactive if linked to at least one Merchant.
1. This should allow the user to indicate if this tax group is to be active or inactive. 
 
2. If changing the Status to Inactive, check the database to see if there are any Merchants linked to this Tax Group. If there are, do not change the Status to Inactive and display an inline error message.
 
 
-
-
Y
-
If Active is the current status of this Tax Group in the database, by default this should be checked.
 
If Inactive is the current status of this Tax Group in the database, by default this should not be checked.
2. Tax Group cannot be set to inactive because it is linked to a Merchant. Please change all Merchants to another Tax Group before setting this Tax Group to Inactive.
6

All States

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Checkbox
-
1. When checked the Tax Group applies to all States across the Country selected.
 
2. Unchecking the checkbox opens a modal screen allowing the user to select which State or States apply to this Tax Group. Refer to the specification of this screen here.
 
-
-
Y
-
If All States is the current status for this Tax Group in the database, by default this should be checked.
 
If All States is NOT the current status for this Tax Group in the database, by default this should not be checked.
 
7

Select States Button

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Checkbox
-
1. When clicked opens a modal screen allowing the user to select which State or States apply to this Tax Group. Refer to the specification of this screen here.
-
-
-
-
-
-
8

Save

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
-
1. Check the rules mentioned in each input elements, starting with Tax Group Name, then Country, then Tax Rate. Show inline error message for the first invalid / unpopulated input the check comes across, stop the check, remain on this screen and do not save this new Tax Group. 
 
2. If all validation checks are sucessful, check existing ACTIVE Tax Groups for the combination of Country and State or States selected. If there is an existing ACTIVE Tax Group with this combination, display an inline error message, remain on this screen and do not save this Tax Group.
 
3. If all validation checks are successful, and there are no duplicate combinations of Country and States selected, save the new Tax Group.
 
4. New tax rate will be applied to all transactions included on next invoice for the merchant.
-
-
-
-
-
2. Tax Group already exists for the combination of Country and State(s) selected.