[IMP] l10n_us_hr_payroll: For Kentucky 13.0

l10n_us_hr_payroll/__manifest__.py

@@ -41,6 +41,7 @@ United States of America - Payroll Rules.
         'data/state/il_illinois.xml',
         'data/state/in_indiana.xml',
         'data/state/ks_kansas.xml',
+        'data/state/ky_kentucky.xml',
         'data/state/la_louisiana.xml',
         'data/state/me_maine.xml',
         'data/state/mi_michigan.xml',

l10n_us_hr_payroll/data/state/ky_kentucky.xml

@@ -0,0 +1,97 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+    <!-- Wage Base -->
+    <record id="rule_parameter_us_ky_suta_wage_base" model="hr.rule.parameter">
+        <field name="name">US KY Kentucky SUTA Wage Base</field>
+        <field name="code">us_ky_suta_wage_base</field>
+        <field name="country_id" ref="base.us"/>
+    </record>
+    <data noupdate="1">
+        <record id="rule_parameter_us_ky_suta_wage_base_2020" model="hr.rule.parameter.value">
+            <field name="parameter_value">10800.0</field>
+            <field name="rule_parameter_id" ref="rule_parameter_us_ky_suta_wage_base"/>
+            <field name="date_from" eval="datetime(2020, 1, 1).date()"/>
+        </record>
+    </data>
+
+    <!-- Rate -->
+    <record id="rule_parameter_us_ky_suta_rate" model="hr.rule.parameter">
+        <field name="name">US KY Kentucky SUTA Rate</field>
+        <field name="code">us_ky_suta_rate</field>
+        <field name="country_id" ref="base.us"/>
+    </record>
+    <data noupdate="1">
+        <record id="rule_parameter_us_ky_suta_rate_2020" model="hr.rule.parameter.value">
+            <field name="parameter_value">2.4</field>
+            <field name="rule_parameter_id" ref="rule_parameter_us_ky_suta_rate"/>
+            <field name="date_from" eval="datetime(2020, 1, 1).date()"/>
+        </record>
+    </data>
+
+    <record id="rule_parameter_us_ky_sit_standard_deduction_rate" model="hr.rule.parameter">
+        <field name="name">US KY Kentucky Standard Deduction Rate</field>
+        <field name="code">us_ky_sit_standard_deduction_rate</field>
+        <field name="country_id" ref="base.us"/>
+    </record>
+    <data noupdate="1">
+        <record id="rule_parameter_us_ky_sit_standard_deduction_rate_2020" model="hr.rule.parameter.value">
+            <field name="parameter_value">2650</field>
+            <field name="rule_parameter_id" ref="rule_parameter_us_ky_sit_standard_deduction_rate"/>
+            <field name="date_from" eval="datetime(2020, 1, 1).date()"/>
+        </record>
+    </data>
+
+    <record id="rule_parameter_us_ky_sit_tax_rate" model="hr.rule.parameter">
+        <field name="name">US KY Kentucky SIT Tax Rate</field>
+        <field name="code">us_ky_sit_tax_rate</field>
+        <field name="country_id" ref="base.us"/>
+    </record>
+    <data noupdate="1">
+        <record id="rule_parameter_us_ky_sit_tax_rate_2020" model="hr.rule.parameter.value">
+            <field name="parameter_value">5.0</field>
+            <field name="rule_parameter_id" ref="rule_parameter_us_ky_sit_tax_rate"/>
+            <field name="date_from" eval="datetime(2020, 1, 1).date()"/>
+        </record>
+    </data>
+
+    <!-- Partners and Contribution Registers -->
+    <record id="res_partner_us_ky_dor" model="res.partner">
+        <field name="name">US Kentucky - Office of Unemployment Insurance - Unemployment Tax</field>
+    </record>
+
+    <record id="res_partner_us_ky_dor_sit" model="res.partner">
+        <field name="name">US Kentucky - Department of Revenue - Income Tax</field>
+    </record>
+
+    <!-- Categories -->
+
+    <!-- Rules -->
+    <record id="hr_payroll_rule_er_us_ky_suta" model="hr.salary.rule">
+        <field name="sequence" eval="450"/>
+        <field name="struct_id" ref="hr_payroll_structure"/>
+        <field name="category_id" ref="hr_payroll_category_er_us_suta"/>
+        <field name="name">ER: US KY Kentucky State Unemployment</field>
+        <field name="code">ER_US_KY_SUTA</field>
+        <field name="condition_select">python</field>
+        <field name="condition_python">result, _ = general_state_unemployment(payslip, categories, worked_days, inputs, wage_base='us_ky_suta_wage_base', rate='us_ky_suta_rate', state_code='KY')</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_ky_suta_wage_base', rate='us_ky_suta_rate', state_code='KY')</field>
+        <field name="partner_id" ref="res_partner_us_ky_dor"/>
+        <field name="appears_on_payslip" eval="False"/>
+    </record>
+
+    <record id="hr_payroll_rule_ee_us_ky_sit" model="hr.salary.rule">
+        <field name="sequence" eval="195"/>
+        <field name="struct_id" ref="hr_payroll_structure"/>
+        <field name="category_id" ref="hr_payroll_category_ee_us_sit"/>
+        <field name="name">EE: US KY Kentucky State Income Tax Withholding</field>
+        <field name="code">EE_US_KY_SIT</field>
+        <field name="condition_select">python</field>
+        <field name="condition_python">result, _ = ky_kentucky_state_income_withholding(payslip, categories, worked_days, inputs)</field>
+        <field name="amount_select">code</field>
+        <field name="amount_python_compute">result, result_rate = ky_kentucky_state_income_withholding(payslip, categories, worked_days, inputs)</field>
+        <field name="partner_id" ref="res_partner_us_ky_dor_sit"/>
+        <field name="appears_on_payslip" eval="True"/>
+    </record>
+
+</odoo>

l10n_us_hr_payroll/models/hr_payslip.py

@@ -26,6 +26,7 @@ from .state.id_idaho import id_idaho_state_income_withholding
 from .state.il_illinois import il_illinois_state_income_withholding
 from .state.in_indiana import in_indiana_state_income_withholding
 from .state.ks_kansas import ks_kansas_state_income_withholding
+from .state.ky_kentucky import ky_kentucky_state_income_withholding
 from .state.la_louisiana import la_louisiana_state_income_withholding
 from .state.me_maine import me_maine_state_income_withholding
 from .state.mi_michigan import mi_michigan_state_income_withholding
@@ -89,6 +90,7 @@ class HRPayslip(models.Model):
             'il_illinois_state_income_withholding': il_illinois_state_income_withholding,
             'in_indiana_state_income_withholding': in_indiana_state_income_withholding,
             'ks_kansas_state_income_withholding': ks_kansas_state_income_withholding,
+            'ky_kentucky_state_income_withholding':ky_kentucky_state_income_withholding,
             'la_louisiana_state_income_withholding': la_louisiana_state_income_withholding,
             'me_maine_state_income_withholding': me_maine_state_income_withholding,
             'mi_michigan_state_income_withholding': mi_michigan_state_income_withholding,

l10n_us_hr_payroll/models/state/ky_kentucky.py

@@ -0,0 +1,32 @@
+# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details.
+
+from .general import _state_applies, sit_wage
+
+
+def ky_kentucky_state_income_withholding(payslip, categories, worked_days, inputs):
+    """
+    Returns SIT eligible wage and rate.
+
+    :return: result, result_rate (wage, percent)
+    """
+    state_code = 'KY'
+    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
+
+    pay_periods = payslip.dict.get_pay_periods_in_year()
+    additional = payslip.contract_id.us_payroll_config_value('state_income_tax_additional_withholding')
+    tax_rate = payslip.rule_parameter('us_ky_sit_tax_rate')
+    standard_deduction = payslip.rule_parameter('us_ky_sit_standard_deduction_rate')
+
+    taxable_income = (wage * pay_periods) - standard_deduction
+    withholding = taxable_income * (tax_rate / 100)
+
+    withholding = max(withholding, 0.0)
+    withholding /= pay_periods
+    withholding += additional
+    return wage, -((withholding / wage) * 100.0)

l10n_us_hr_payroll/tests/__init__.py

@@ -46,6 +46,8 @@ from . import test_us_il_illinois_payslip_2020
 
 from . import test_us_in_indiana_payslip_2020
 
+from . import test_us_ky_kentucky_payslip_2020
+
 from . import test_us_ks_kansas_payslip_2020
 
 from . import test_us_la_louisiana_payslip_2019

l10n_us_hr_payroll/tests/test_us_ky_kentucky_payslip_2020.py

@@ -0,0 +1,33 @@
+# 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 TestUsKYPayslip(TestUsPayslip):
+    ###
+    #   2020 Taxes and Rates
+    ###
+    KY_UNEMP_MAX_WAGE = 10800.0
+    KY_UNEMP = 2.4
+    # Calculation based on example https://revenue.ky.gov/Forms/42A003(T)%20(12-2019)%202020%20Tax%20Tables.pdf
+
+    def _test_sit(self, wage, additional_withholding, schedule_pay,  date_start, expected_withholding):
+        employee = self._createEmployee()
+        contract = self._createContract(employee,
+                                        wage=wage,
+                                        state_id=self.get_us_state('KY'),
+                                        state_income_tax_additional_withholding=additional_withholding,
+                                        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('KY', self.KY_UNEMP, date(2020, 1, 1), wage_base=self.KY_UNEMP_MAX_WAGE)
+        self._test_sit(3020, 0.0, 'monthly', date(2020, 1, 1), 139.96)
+        self._test_sit(1500, 0.0, 'bi-weekly', date(2020, 1, 1), 69.90)
+        self._test_sit(1500, 10.0, 'bi-weekly', date(2020, 1, 1), 79.90)

l10n_us_hr_payroll/views/us_payroll_config_views.xml

@@ -132,6 +132,10 @@
                             <field name="state_income_tax_additional_withholding" string="Additional Withholding 5."/>
                             <field name="state_income_tax_exempt" string="Exempt 6."/>
                         </group>
+                        <group name="state_ky_kentucky" string="KY Kentucky" attrs="{'invisible':[('state_id', '!=', %(base.state_us_18)s)]}">
+                            <p colspan="2"><h3>No additional fields.</h3></p>
+                            <field name="state_income_tax_additional_withholding" string="Additional Withholding 4."/>
+                        </group>
                         <group name="state_la_louisiana" string="LA Louisiana" attrs="{'invisible':[('state_id', '!=', %(base.state_us_19)s)]}">
                             <p colspan="2"><h3>Form LA L-4 - State Income Tax</h3></p>
                             <field name="la_l4_sit_filing_status" string="Filing Status 3."/>