[IMP] l10n_in_hr_payroll_extension: test cases and monetary fields

With This Commit
========================================================

- Added Test Cases for salary component calculations
- Modified some fields to make them monetary
- Minor changes in views according above changes

Author: jmra-odoo

.gitignore

@@ -127,3 +127,4 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+.vscode

l10n_in_hr_payroll_extension/models/hr_contract.py

@@ -4,15 +4,15 @@
 class HrContract(models.Model):
     _inherit = 'hr.contract'
 
-    l10n_in_basic_salary = fields.Float(string="Basic Salary", help="Basic salary calculated from the wage", compute="_compute_l10n_in_basic_salary", inverse="_inverse_l10n_in_basic_salary")
-    l10n_in_house_rent_allowance = fields.Float(string="House Rent Allowance", compute="_compute_l10n_in_house_rent_allowance", inverse="_inverse_l10n_in_house_rent_allowance")
-    l10n_in_standard_allowance = fields.Float(string="Standard Allowance", default=4167)
-    l10n_in_performance_bonus = fields.Float(string="Performance Bonus", compute="_compute_l10n_in_performance_bonus", inverse="_inverse_l10n_in_performance_bonus")
-    l10n_in_leave_travel_allowance = fields.Float(string="Leave Travel Allowance", compute="_compute_l10n_in_leave_travel_allowance", inverse="_inverse_l10n_in_leave_travel_allowance")
-    l10n_in_leave_allowance = fields.Float(string="Leave Allowance", compute="_compute_leave_allowance", inverse="_inverse_leave_allowance")
+    l10n_in_basic_salary = fields.Monetary(string="Basic Salary", help="Basic salary calculated from the wage", compute="_compute_l10n_in_basic_salary", inverse="_inverse_l10n_in_basic_salary", currency_field="currency_id")
+    l10n_in_house_rent_allowance = fields.Monetary(string="House Rent Allowance", compute="_compute_l10n_in_house_rent_allowance", inverse="_inverse_l10n_in_house_rent_allowance", currency_field="currency_id")
+    l10n_in_standard_allowance = fields.Monetary(string="Standard Allowance", default=4167, currency_field="currency_id")
+    l10n_in_performance_bonus = fields.Monetary(string="Performance Bonus", compute="_compute_l10n_in_performance_bonus", inverse="_inverse_l10n_in_performance_bonus", currency_field="currency_id")
+    l10n_in_leave_travel_allowance = fields.Monetary(string="Leave Travel Allowance", compute="_compute_l10n_in_leave_travel_allowance", inverse="_inverse_l10n_in_leave_travel_allowance", currency_field="currency_id")
+    l10n_in_leave_allowance = fields.Monetary(string="Leave Allowance", compute="_compute_leave_allowance", inverse="_inverse_leave_allowance", currency_field="currency_id")
     l10n_in_leave_days = fields.Float(string="Leave Days", default=1)
-    l10n_in_gratuity = fields.Float(string="Gratuity", default=0)
-    l10n_in_supplementary_allowance = fields.Float(string="Supplementary Allowance", compute="_compute_l10n_in_supplementary_allowance", inverse="_inverse_l10n_in_supplementary_allowance", default=0)
+    l10n_in_gratuity = fields.Monetary(string="Gratuity", currency_field="currency_id")
+    l10n_in_supplementary_allowance = fields.Monetary(string="Supplementary Allowance", compute="_compute_l10n_in_supplementary_allowance", inverse="_inverse_l10n_in_supplementary_allowance", currency_field="currency_id")
 
     l10n_in_basic_salary_percent = fields.Float(string="Basic Salary Percentage", help="basic salary percentage of wage", default=50)
     l10n_in_house_rent_allowance_percent = fields.Float(string="House Rent Allowance Percentage", help="this is the percentage of basic salary", default=50)
@@ -24,14 +24,14 @@ class HrContract(models.Model):
     l10n_in_gratuity_percent = fields.Float(string="Gratuity Percentage", compute="_compute_l10n_in_gratuity_percent", inverse="_inverse_l10n_in_gratuity_percent")
     l10n_in_supplementary_allowance_percent = fields.Float(string="Supplementary Allowance Percentage")
 
-    l10n_in_pf_employee_contribution = fields.Float(related="company_id.l10n_in_pf_employee_contribution", readonly=False)
-    l10n_in_pf_employer_contribution = fields.Float(related="company_id.l10n_in_pf_employer_contribution", readonly=False)
-    l10n_in_professional_tax = fields.Float(string="Professional Tax", default=200)
-    l10n_in_esic_employee_contribution = fields.Float(related="company_id.l10n_in_esic_employee_contribution", readonly=False)
-    l10n_in_esic_employer_contribution = fields.Float(related="company_id.l10n_in_esic_employer_contribution", readonly=False)
-    l10n_in_lwf_employee_contribution = fields.Float(related="company_id.l10n_in_lwf_employee_contribution", readonly=False)
-    l10n_in_lwf_employer_contribution = fields.Float(related="company_id.l10n_in_lwf_employer_contribution", readonly=False)
-    l10n_in_other_deduction = fields.Float(string="Other Deduction")
+    l10n_in_pf_employee_contribution = fields.Float(string="Employee Contribution", default=12)
+    l10n_in_pf_employer_contribution = fields.Float(string="Employer Contribution", default=12)
+    l10n_in_professional_tax = fields.Monetary(string="Professional Tax", default=200)
+    l10n_in_esic_employee_contribution = fields.Float(string="Employee Contribution", default=0.75)
+    l10n_in_esic_employer_contribution = fields.Float(string="Employer Contribution", default=3.25)
+    l10n_in_lwf_employee_contribution = fields.Monetary(string="Employee Contribution", currency_field="currency_id", default=6)
+    l10n_in_lwf_employer_contribution = fields.Monetary(string="Employer Contribution", currency_field="currency_id", default=12)
+    l10n_in_other_deduction = fields.Monetary(string="Other Deduction", currency_field="currency_id")
 
     @api.depends("l10n_in_basic_salary_percent", "wage")
     def _compute_l10n_in_basic_salary(self):
@@ -76,7 +76,7 @@ def _compute_l10n_in_leave_travel_allowance(self):
 
     def _inverse_l10n_in_leave_travel_allowance(self):
         for record in self:
-            record.l10n_in_leave_travel_allowance_percent = record.l10n_in_leave_days * ((record.l10n_in_leave_allowance * 100) / record.wage if record.wage else 0)
+            record.l10n_in_leave_travel_allowance_percent = (record.l10n_in_leave_travel_allowance * 100) / record.l10n_in_basic_salary if record.l10n_in_basic_salary else 0
 
     @api.depends('wage', 'l10n_in_leave_allowance_per_day_percent', 'l10n_in_leave_days')
     def _compute_leave_allowance(self):

l10n_in_hr_payroll_extension/models/res_company.py

@@ -4,24 +4,11 @@
 class ResCompany(models.Model):
     _inherit = 'res.company'
 
+    l10n_in_org_tax_details = fields.Boolean(string="Organisation Tax Details")
     l10n_in_org_pan_number = fields.Char(string="PAN Number")
     l10n_in_org_tan_number = fields.Char(string="TAN Number")
     l10n_in_org_tds_circle = fields.Char(string="TDS Circle/AO Code")
-    l10n_in_org_tax_details = fields.Boolean(string="Organisation Tax Details")
 
-    l10n_in_is_provident_fund = fields.Boolean(string="Employee's Provident Fund")
     l10n_in_employer_identification = fields.Char(string="Employer Identification")
-    l10n_in_pf_employee_contribution = fields.Float(string="Employee Contribution")
-    l10n_in_pf_employer_contribution = fields.Float(string="Employer Contribution")
-
-    l10n_in_is_professional_tax = fields.Boolean(string="Professional Tax")
     l10n_in_professional_tax_number = fields.Char(string="Professional Tax Number")
-
-    l10n_in_is_esic = fields.Boolean(string="Employee's State Insurance Corporation")
     l10n_in_esic_ip = fields.Char(string="ESIC IP")
-    l10n_in_esic_employee_contribution = fields.Float(string="Employee Contribution")
-    l10n_in_esic_employer_contribution = fields.Float(string="Employer Contribution")
-
-    l10n_in_is_lwf = fields.Boolean(string="Labour Welfare Fund")
-    l10n_in_lwf_employee_contribution = fields.Float(string="Employee Contribution")
-    l10n_in_lwf_employer_contribution = fields.Float(string="Employer Contribution")

l10n_in_hr_payroll_extension/models/res_config_settings.py

@@ -4,27 +4,29 @@
 class ResConfigSettings(models.TransientModel):
     _inherit = 'res.config.settings'
 
+    currency_id = fields.Many2one("res.currency", default=lambda self: self.env.company.currency_id)
+    
+    l10n_in_org_tax_details = fields.Boolean(related='company_id.l10n_in_org_tax_details', readonly=False)
     l10n_in_org_pan_number = fields.Char(related='company_id.l10n_in_org_pan_number', readonly=False)
     l10n_in_org_tan_number = fields.Char(related='company_id.l10n_in_org_tan_number', readonly=False)
     l10n_in_org_tds_circle = fields.Char(related='company_id.l10n_in_org_tds_circle', readonly=False)
-    l10n_in_org_tax_details = fields.Boolean(related='company_id.l10n_in_org_tax_details', readonly=False)
 
-    l10n_in_is_provident_fund = fields.Boolean(related='company_id.l10n_in_is_provident_fund', readonly=False, default=True)
+    l10n_in_is_provident_fund = fields.Boolean(string="Employee's Provident Fund", default=True)
     l10n_in_employer_identification = fields.Char(related='company_id.l10n_in_employer_identification', readonly=False)
-    l10n_in_pf_employee_contribution = fields.Float(related='company_id.l10n_in_pf_employee_contribution', readonly=False, default=12)
-    l10n_in_pf_employer_contribution = fields.Float(related='company_id.l10n_in_pf_employer_contribution', readonly=False, default=12)
+    default_l10n_in_pf_employee_contribution = fields.Float(string="Employee Contribution", default_model="hr.contract", default=12)
+    default_l10n_in_pf_employer_contribution = fields.Float(string="Employer Contribution", default_model="hr.contract", default=12)
 
-    l10n_in_is_professional_tax = fields.Boolean(related='company_id.l10n_in_is_professional_tax', readonly=False, default=True)
+    l10n_in_is_professional_tax = fields.Boolean(string="Professional Tax", default=True)
     l10n_in_professional_tax_number = fields.Char(related='company_id.l10n_in_professional_tax_number', readonly=False)
 
-    l10n_in_is_esic = fields.Boolean(related='company_id.l10n_in_is_esic', readonly=False, default=True)
+    l10n_in_is_esic = fields.Boolean(string="Employee's State Insurance Corporation", default=True)
     l10n_in_esic_ip = fields.Char(related='company_id.l10n_in_esic_ip', readonly=False)
-    l10n_in_esic_employee_contribution = fields.Float(related='company_id.l10n_in_esic_employee_contribution', readonly=False, default=0.75)
-    l10n_in_esic_employer_contribution = fields.Float(related='company_id.l10n_in_esic_employer_contribution', readonly=False, default=3.25)
+    default_l10n_in_esic_employee_contribution = fields.Float(string="Employee Contribution", default_model="hr.contract", default=0.75)
+    default_l10n_in_esic_employer_contribution = fields.Float(string="Employer Contribution", default_model="hr.contract", default=3.25)
 
-    l10n_in_is_lwf = fields.Boolean(related='company_id.l10n_in_is_lwf', readonly=False, default=True)
-    l10n_in_lwf_employee_contribution = fields.Float(related='company_id.l10n_in_lwf_employee_contribution', readonly=False, default=6)
-    l10n_in_lwf_employer_contribution = fields.Float(related='company_id.l10n_in_lwf_employer_contribution', readonly=False, default=12)
+    l10n_in_is_lwf = fields.Boolean(string="Labour Welfare Fund", default=True)
+    default_l10n_in_lwf_employee_contribution = fields.Monetary(string="Employee Contribution", currency_field="currency_id", default_model="hr.contract", default=6)
+    default_l10n_in_lwf_employer_contribution = fields.Monetary(string="Employer Contribution", currency_field="currency_id", default_model="hr.contract", default=12)
 
     default_l10n_in_basic_salary_percent = fields.Float(string="Basic Salary", help="You can define the % of the salary from company cost to compute the basic salary based on your wages (Including D4).", default_model="hr.contract", default=50)
     default_l10n_in_house_rent_allowance_percent = fields.Float(string="House Rent Allowance", help="You can define 50% for metro city and 40% for non-metro city.", default_model="hr.contract", default=50)

l10n_in_hr_payroll_extension/tests/__init__.py

@@ -0,0 +1 @@
+from . import test_hr_contract

l10n_in_hr_payroll_extension/tests/test_hr_contract.py

@@ -0,0 +1,29 @@
+from odoo.tests.common import TransactionCase
+from odoo.tests import tagged
+
+
+@tagged('post_install', '-at_install')
+class TestHrContract(TransactionCase):
+    @classmethod
+    def setUpClass(cls):
+        super(TestHrContract, cls).setUpClass()
+
+        cls.contract = cls.env['hr.contract'].create({
+            'name': "Test Contract",
+            'wage': 100000,
+            'l10n_in_basic_salary_percent': 50,
+            'l10n_in_house_rent_allowance_percent': 50,
+            'l10n_in_standard_allowance': 4167,
+            'l10n_in_performance_bonus_percent': 20,
+            'l10n_in_leave_travel_allowance_percent': 20,
+            'l10n_in_gratuity': 250,
+        })
+
+    def test_salary_component_amounts(self):
+        self.assertEqual(self.contract.l10n_in_basic_salary, 50000, "50% of 100000 should be 50000")
+        self.assertEqual(self.contract.l10n_in_house_rent_allowance, 25000, "50% of 50000(Basic Salary) should be 25000")
+        self.assertEqual(self.contract.l10n_in_standard_allowance_percent, 4.167, "4167 is a 4.17% of 100000(Wage)")
+        self.assertEqual(self.contract.l10n_in_performance_bonus, 10000, "20% of 50000(Basic Salary) should be 10000")
+        self.assertEqual(self.contract.l10n_in_leave_travel_allowance, 10000, "20% of 50000(Basic Salary) should be 10000")
+        self.assertEqual(self.contract.l10n_in_gratuity_percent, 0.50, "250 is a 0.50% of 50000(Basic Salary)")
+        self.assertEqual(self.contract.l10n_in_supplementary_allowance, 583, "supplementary should be remaining amount from wage")

l10n_in_hr_payroll_extension/views/hr_contract_views.xml

@@ -15,47 +15,47 @@
                     <label for="l10n_in_basic_salary" />
                     <div class="o_row mw-80" name="l10n_in_basic_salary">
                         <field name="l10n_in_basic_salary"/>
-                        <div>₹ / month</div>
+                        <div> / month</div>
                         <field name="l10n_in_basic_salary_percent" groups="base.group_no_one"/>
                         <div groups="base.group_no_one">%</div>
                     </div>
 
                     <label for="l10n_in_house_rent_allowance" />
                     <div class="o_row mw-80" name="l10n_in_house_rent_allowance">
                         <field name="l10n_in_house_rent_allowance"/>
-                        <div class="mb-2">₹ / month</div>
+                        <div class="mb-2"> / month</div>
                         <field name="l10n_in_house_rent_allowance_percent" groups="base.group_no_one"/>
                         <div groups="base.group_no_one">%</div>
                     </div>
 
                     <label for="l10n_in_standard_allowance" />
                     <div class="o_row mw-80" name="l10n_in_standard_allowance">
                         <field name="l10n_in_standard_allowance"/>
-                        <div class="mb-2">₹ / month</div>
+                        <div class="mb-2"> / month</div>
                         <field name="l10n_in_standard_allowance_percent" groups="base.group_no_one"/>
                         <div groups="base.group_no_one">%</div>
                     </div>
 
                     <label for="l10n_in_performance_bonus" />
                     <div class="o_row mw-80" name="l10n_in_performance_bonus">
                         <field name="l10n_in_performance_bonus"/>
-                        <div class="mb-2">₹ / month</div>
+                        <div class="mb-2"> / month</div>
                         <field name="l10n_in_performance_bonus_percent" groups="base.group_no_one"/>
                         <div groups="base.group_no_one">%</div>
                     </div>
 
                     <label for="l10n_in_leave_travel_allowance" />
                     <div class="o_row mw-80" name="l10n_in_leave_travel_allowance">
                         <field name="l10n_in_leave_travel_allowance"/>
-                        <div class="mb-2">₹ / month</div>
+                        <div class="mb-2"> / month</div>
                         <field name="l10n_in_leave_travel_allowance_percent" groups="base.group_no_one"/>
                         <div groups="base.group_no_one">%</div>
                     </div>
 
                     <label for="l10n_in_leave_allowance" />
                     <div class="o_row mw-80" name="l10n_in_leave_allowance">
                         <field name="l10n_in_leave_allowance"/>
-                        <div class="mb-2">₹ / month</div>
+                        <div class="mb-2"> / month</div>
                         <field name="l10n_in_leave_allowance_percent" groups="base.group_no_one"/>
                         <div groups="base.group_no_one">%</div>
                     </div>
@@ -69,15 +69,15 @@
                     <label for="l10n_in_gratuity" />
                     <div class="o_row mw-80" name="l10n_in_gratuity">
                         <field name="l10n_in_gratuity"/>
-                        <div class="mb-2">₹ / month</div>
+                        <div class="mb-2"> / month</div>
                         <field name="l10n_in_gratuity_percent" groups="base.group_no_one"/>
                         <div groups="base.group_no_one">%</div>
                     </div>
 
                     <label for="l10n_in_supplementary_allowance" />
                     <div class="o_row mw-80" name="l10n_in_supplementary_allowance">
                         <field name="l10n_in_supplementary_allowance"/>
-                        <div class="mb-2">₹ / month</div>
+                        <div class="mb-2"> / month</div>
                         <field name="l10n_in_supplementary_allowance_percent" groups="base.group_no_one"/>
                         <div groups="base.group_no_one">%</div>
                     </div>
@@ -106,7 +106,7 @@
                         <label for="l10n_in_professional_tax"/>
                         <div class="o_row mw-60" name="l10n_in_professional_tax">
                             <field name="l10n_in_professional_tax"/>
-                            <div class="mb-2">₹ / month</div>
+                            <div class="mb-2"> / month</div>
                         </div>
 
                         <label for="l10n_in_esic_employee_contribution" string="ESIC Employee Contribution" />
@@ -124,19 +124,19 @@
                         <label for="l10n_in_lwf_employee_contribution" string="LWF Employee Contribution" />
                         <div class="o_row mw-60" name="l10n_in_lwf_employee_contribution">
                             <field name="l10n_in_lwf_employee_contribution"/>
-                            <div class="mb-2">₹ / month</div>
+                            <div class="mb-2"> / month</div>
                         </div>
 
                         <label for="l10n_in_lwf_employer_contribution" string="LWF Employer Contribution" />
                         <div class="o_row mw-60" name="l10n_in_lwf_employer_contribution">
                             <field name="l10n_in_lwf_employer_contribution"/>
-                            <div class="mb-2">₹ / month</div>
+                            <div class="mb-2"> / month</div>
                         </div>
 
                         <label for="l10n_in_other_deduction" />
                         <div class="o_row mw-60" name="l10n_in_other_deduction">
                             <field name="l10n_in_other_deduction"/>
-                            <div class="mb-2">₹ / month</div>
+                            <div class="mb-2"> / month</div>
                         </div>
                     </group>
                 </div>