Merge branch 'mig/12.0/l10n_us_hr_payroll__2020' into '12.0-test'

mig/12.0/l10n_us_hr_payroll__2020 into 12.0-test

See merge request hibou-io/hibou-odoo/suite!316

l10n_us_hr_payroll/__manifest__.py

@@ -33,6 +33,7 @@ USA Payroll Rules.
         'data/state/ar_arkansas.xml',
         'data/state/az_arizona.xml',
         'data/state/ca_california.xml',
+        'data/state/co_colorado.xml',
         'data/state/ct_connecticut.xml',
         'data/state/de_delaware.xml',
         'data/state/fl_florida.xml',

l10n_us_hr_payroll/data/final.xml

@@ -33,6 +33,9 @@
             ref('hr_payroll_rule_ee_us_ca_suta_sdi'),
             ref('hr_payroll_rule_ee_us_ca_sit'),
 
+            ref('hr_payroll_rule_er_us_co_suta'),
+            ref('hr_payroll_rule_ee_us_co_sit'),
+
             ref('hr_payroll_rule_er_us_ct_suta'),
             ref('hr_payroll_rule_ee_us_ct_sit'),
 

l10n_us_hr_payroll/data/state/co_colorado.xml

@@ -0,0 +1,89 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+    <!-- Wage Base -->
+    <data noupdate="1">
+        <record id="rule_parameter_us_co_suta_wage_base_2020" model="hr.payroll.rate">
+            <field name="name">US CO Colorado SUTA Wage Base</field>
+            <field name="code">us_co_suta_wage_base</field>
+            <field name="parameter_value">13600.0</field>
+            <field name="date_from" eval="datetime(2020, 1, 1).date()"/>
+        </record>
+    </data>
+
+    <!-- Rate -->
+    <data noupdate="1">
+        <record id="rule_parameter_us_co_suta_rate_2020" model="hr.payroll.rate">
+            <field name="name">US CO Colorado SUTA Rate</field>
+            <field name="code">us_co_suta_rate</field>
+            <field name="parameter_value">1.7</field>
+            <field name="date_from" eval="datetime(2020, 1, 1).date()"/>
+        </record>
+    </data>
+
+    <data noupdate="1">
+        <record id="rule_parameter_us_co_sit_tax_rate_2020" model="hr.payroll.rate">
+            <field name="name">US CO Colorado SIT Tax Rate</field>
+            <field name="code">us_co_sit_tax_rate</field>
+            <field name="parameter_value">4.63</field>
+            <field name="date_from" eval="datetime(2020, 1, 1).date()"/>
+        </record>
+    </data>
+
+    <data noupdate="1">
+        <record id="rule_parameter_us_co_sit_exemption_rate_2020" model="hr.payroll.rate">
+            <field name="name">US CO Colorado SIT Exemption Rate</field>
+            <field name="code">us_co_sit_exemption_rate</field>
+            <field name="parameter_value">4000</field>
+            <field name="date_from" eval="datetime(2020, 1, 1).date()"/>
+        </record>
+    </data>
+
+    <!-- Partners and Contribution Registers -->
+    <record id="res_partner_us_co_dor" model="res.partner">
+        <field name="name">US Colorado - Department of Labor and Employment - Unemployment Tax</field>
+        <field name="supplier">1</field>
+    </record>
+    <record id="contrib_register_us_co_dor" model="hr.contribution.register">
+        <field name="name">US Colorado - Department of Labor and Employment - Unemployment Tax</field>
+        <field name="partner_id" ref="res_partner_us_co_dor"/>
+    </record>
+
+    <record id="res_partner_us_co_dor_sit" model="res.partner">
+        <field name="name">US Colorado - Division of Revenue - Income Tax</field>
+        <field name="supplier">1</field>
+    </record>
+    <record id="contrib_register_us_co_dor_sit" model="hr.contribution.register">
+        <field name="name">US Colorado - Division of Revenue - Income Tax</field>
+        <field name="partner_id" ref="res_partner_us_co_dor_sit"/>
+    </record>
+
+    <!-- Categories -->
+
+    <!-- Rules -->
+    <record id="hr_payroll_rule_er_us_co_suta" model="hr.salary.rule">
+        <field name="sequence" eval="450"/>
+        <field name="category_id" ref="hr_payroll_category_er_us_suta"/>
+        <field name="name">ER: US CO Colorado State Unemployment</field>
+        <field name="code">ER_US_CO_SUTA</field>
+        <field name="condition_select">python</field>
+        <field name="condition_python">result, _ = general_state_unemployment(payslip, categories, worked_days, inputs, wage_base='us_co_suta_wage_base', rate='us_co_suta_rate', state_code='CO')</field>
+        <field name="amount_select">code</field>
+        <field name="amount_python_compute">result, result_rate = general_state_unemployment(payslip, categories, worked_days, inputs, wage_base='us_co_suta_wage_base', rate='us_co_suta_rate', state_code='CO')</field>
+        <field name="register_id" ref="contrib_register_us_co_dor"/>
+        <field name="appears_on_payslip" eval="False"/>
+    </record>
+
+    <record id="hr_payroll_rule_ee_us_co_sit" model="hr.salary.rule">
+        <field name="sequence" eval="195"/>
+        <field name="category_id" ref="hr_payroll_category_ee_us_sit"/>
+        <field name="name">EE: US CO Colorado State Income Tax Withholding</field>
+        <field name="code">EE_US_CO_SIT</field>
+        <field name="condition_select">python</field>
+        <field name="condition_python">result, _ = co_colorado_state_income_withholding(payslip, categories, worked_days, inputs)</field>
+        <field name="amount_select">code</field>
+        <field name="amount_python_compute">result, result_rate = co_colorado_state_income_withholding(payslip, categories, worked_days, inputs)</field>
+        <field name="register_id" ref="contrib_register_us_co_dor_sit"/>
+        <field name="appears_on_payslip" eval="True"/>
+    </record>
+
+</odoo>

l10n_us_hr_payroll/models/hr_payslip.py

@@ -18,6 +18,7 @@ from .state.al_alabama import al_alabama_state_income_withholding
 from .state.ar_arkansas import ar_arkansas_state_income_withholding
 from .state.az_arizona import az_arizona_state_income_withholding
 from .state.ca_california import ca_california_state_income_withholding
+from .state.co_colorado import co_colorado_state_income_withholding
 from .state.ct_connecticut import ct_connecticut_state_income_withholding
 from .state.de_delaware import de_delaware_state_income_withholding
 from .state.ga_georgia import ga_georgia_state_income_withholding
@@ -71,6 +72,7 @@ class HRPayslip(models.Model):
             'ar_arkansas_state_income_withholding': ar_arkansas_state_income_withholding,
             'az_arizona_state_income_withholding': az_arizona_state_income_withholding,
             'ca_california_state_income_withholding': ca_california_state_income_withholding,
+            'co_colorado_state_income_withholding': co_colorado_state_income_withholding,
             'ct_connecticut_state_income_withholding': ct_connecticut_state_income_withholding,
             'de_delaware_state_income_withholding': de_delaware_state_income_withholding,
             'ga_georgia_state_income_withholding': ga_georgia_state_income_withholding,

l10n_us_hr_payroll/models/state/co_colorado.py

@@ -0,0 +1,45 @@
+# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details.
+
+from .general import _state_applies, sit_wage
+
+
+def co_colorado_state_income_withholding(payslip, categories, worked_days, inputs):
+    """
+    Returns SIT eligible wage and rate.
+
+    :return: result, result_rate (wage, percent)
+    """
+    state_code = 'CO'
+    if not _state_applies(payslip, state_code):
+        return 0.0, 0.0
+
+    # Determine Wage
+    wage = sit_wage(payslip, categories)
+    if not wage:
+        return 0.0, 0.0
+
+    filing_status = payslip.dict.contract_id.us_payroll_config_value('fed_941_fit_w4_filing_status')
+    if not filing_status:
+        return 0.0, 0.0
+
+    state_exempt = payslip.dict.contract_id.us_payroll_config_value('state_income_tax_exempt')
+    if state_exempt:
+        return 0.0, 0.0
+
+    pay_periods = payslip.dict.get_pay_periods_in_year()
+    additional = payslip.dict.contract_id.us_payroll_config_value('state_income_tax_additional_withholding')
+    exemption_rate = payslip.dict.rule_parameter('us_co_sit_exemption_rate')
+    tax_rate = payslip.dict.rule_parameter('us_co_sit_tax_rate')
+
+    taxable_income = wage * pay_periods
+    if filing_status == 'married':
+        taxable_income -= exemption_rate * 2
+    else:
+        taxable_income -= exemption_rate
+
+    withholding = taxable_income * (tax_rate / 100)
+
+    withholding = max(withholding, 0.0)
+    withholding = withholding / pay_periods
+    withholding += additional
+    return wage, -((withholding / wage) * 100.0)

l10n_us_hr_payroll/tests/__init__.py

@@ -19,6 +19,8 @@ from . import test_us_az_arizona_payslip_2020
 from . import test_us_ca_california_payslip_2019
 from . import test_us_ca_california_payslip_2020
 
+from . import test_us_co_colorado_payslip_2020
+
 from . import test_us_ct_connecticut_payslip_2019
 from . import test_us_ct_connecticut_payslip_2020
 

l10n_us_hr_payroll/tests/test_us_co_colorado_payslip_2020.py

@@ -0,0 +1,36 @@
+# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details.
+
+from datetime import date, timedelta
+from .common import TestUsPayslip
+
+
+class TestUsCOPayslip(TestUsPayslip):
+    ###
+    #   2020 Taxes and Rates
+    ###
+    CO_UNEMP_MAX_WAGE = 13600.0
+    CO_UNEMP = 1.7
+
+    def _test_sit(self, wage, filing_status, additional_withholding, schedule_pay,  date_start, expected_withholding, state_income_tax_exempt=False):
+        employee = self._createEmployee()
+        contract = self._createContract(employee,
+                                        wage=wage,
+                                        state_id=self.get_us_state('CO'),
+                                        fed_941_fit_w4_filing_status=filing_status,
+                                        state_income_tax_additional_withholding=additional_withholding,
+                                        state_income_tax_exempt=state_income_tax_exempt,
+                                        schedule_pay=schedule_pay)
+        payslip = self._createPayslip(employee, date_start, date_start + timedelta(days=7))
+        payslip.compute_sheet()
+        cats = self._getCategories(payslip)
+
+        self._log('Computed period tax: ' + str(expected_withholding))
+        self.assertPayrollEqual(cats.get('EE_US_SIT', 0.0), -expected_withholding)
+
+    def test_2020_taxes_example(self):
+        self._test_er_suta('CO', self.CO_UNEMP, date(2020, 1, 1), wage_base=self.CO_UNEMP_MAX_WAGE)
+        self._test_sit(5000.0, 'married', 0.0, 'semi-monthly', date(2020, 1, 1), 216.07)
+        self._test_sit(800.0, 'single', 0.0, 'weekly', date(2020, 1, 1), 33.48)
+        self._test_sit(20000.0, 'married', 0.0, 'quarterly', date(2020, 1, 1), 833.4)
+        self._test_sit(20000.0, 'married', 10.0, 'quarterly', date(2020, 1, 1), 843.4)
+        self._test_sit(20000.0, 'married', 0.0, 'quarterly', date(2020, 1, 1), 0.0, True)

l10n_us_hr_payroll/views/us_payroll_config_views.xml

@@ -69,6 +69,11 @@
                             <field name="ca_de4_sit_additional_allowances" string="Additional Allowances 4(c)."/>
                             <field name="state_income_tax_additional_withholding" string="Additional Withholding 2."/>
                         </group>
+                        <group name="state_co_colorado" string="CO Colorado" attrs="{'invisible':[('state_id', '!=', %(base.state_us_6)s)]}">
+                            <p colspan="2"><h3>Form W-4 - State Income Tax</h3></p>
+                            <field name="state_income_tax_additional_withholding" string="Additional Withholding 1."/>
+                            <field name="state_income_tax_exempt" string="State Exempt"/>
+                        </group>
                         <group name="state_de_delaware" string="DE Delaware" attrs="{'invisible':[('state_id', '!=', %(base.state_us_8)s)]}">
                             <p colspan="2"><h3>Form DE W-4 - State Income Tax</h3></p>
                             <field name="de_w4_sit_filing_status" string="Marital Status 3."/>