From b495294cce02799c75f2a770b2f7d0236f9c4211 Mon Sep 17 00:00:00 2001 From: David Frick Date: Thu, 11 Jul 2019 16:25:28 -0400 Subject: [PATCH] NEW `l10n_us_mi_hr_payroll` for 11.0 --- l10n_us_mi_hr_payroll/__init__.py | 1 + l10n_us_mi_hr_payroll/__manifest__.py | 28 ++ l10n_us_mi_hr_payroll/data/base.xml | 45 +++ l10n_us_mi_hr_payroll/data/final.xml | 17 + l10n_us_mi_hr_payroll/data/rates.xml | 14 + l10n_us_mi_hr_payroll/data/rules.xml | 86 +++++ l10n_us_mi_hr_payroll/models/__init__.py | 1 + l10n_us_mi_hr_payroll/models/hr_payroll.py | 10 + l10n_us_mi_hr_payroll/tests/__init__.py | 1 + .../tests/test_us_mi_payslip.py | 294 ++++++++++++++++++ .../views/hr_payroll_views.xml | 22 ++ 11 files changed, 519 insertions(+) create mode 100755 l10n_us_mi_hr_payroll/__init__.py create mode 100755 l10n_us_mi_hr_payroll/__manifest__.py create mode 100755 l10n_us_mi_hr_payroll/data/base.xml create mode 100755 l10n_us_mi_hr_payroll/data/final.xml create mode 100755 l10n_us_mi_hr_payroll/data/rates.xml create mode 100755 l10n_us_mi_hr_payroll/data/rules.xml create mode 100644 l10n_us_mi_hr_payroll/models/__init__.py create mode 100755 l10n_us_mi_hr_payroll/models/hr_payroll.py create mode 100755 l10n_us_mi_hr_payroll/tests/__init__.py create mode 100755 l10n_us_mi_hr_payroll/tests/test_us_mi_payslip.py create mode 100755 l10n_us_mi_hr_payroll/views/hr_payroll_views.xml diff --git a/l10n_us_mi_hr_payroll/__init__.py b/l10n_us_mi_hr_payroll/__init__.py new file mode 100755 index 00000000..0650744f --- /dev/null +++ b/l10n_us_mi_hr_payroll/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/l10n_us_mi_hr_payroll/__manifest__.py b/l10n_us_mi_hr_payroll/__manifest__.py new file mode 100755 index 00000000..8a28dfbe --- /dev/null +++ b/l10n_us_mi_hr_payroll/__manifest__.py @@ -0,0 +1,28 @@ +{ + 'name': 'USA - Michigan - Payroll', + 'author': 'Hibou Corp. ', + 'license': 'AGPL-3', + 'category': 'Localization', + 'depends': ['l10n_us_hr_payroll'], + 'version': '11.0.2019.0.0', + 'description': """ +USA::Michigan Payroll Rules. +================================== + +* Contribution register and partner for Michigan Unemployment Insurance Agency - Unemployment +* Contribution register and partner for Michigan Department of Treasury - Income Tax Withholding +* Contract level Michigan Exemptions +* Company level Michigan Unemployment Rate + """, + + 'auto_install': False, + 'website': 'https://hibou.io/', + 'data': [ + 'views/hr_payroll_views.xml', + 'data/base.xml', + 'data/rates.xml', + 'data/rules.xml', + 'data/final.xml', + ], + 'installable': True +} diff --git a/l10n_us_mi_hr_payroll/data/base.xml b/l10n_us_mi_hr_payroll/data/base.xml new file mode 100755 index 00000000..c420fc9a --- /dev/null +++ b/l10n_us_mi_hr_payroll/data/base.xml @@ -0,0 +1,45 @@ + + + + + + Michigan Unemployment Insurance Agency - Unemployment Tax + 1 + + + + Michigan Department of Treasury - Income Tax Withholding + 1 + + + + Michigan Unemployment + Michigan Unemployment Insurance Agency - Unemployment + + + + Michigan Income Tax Withholding + Michigan Department of Treasury - Income Tax Withholding + + + + + + + Wage: US-MI Unemployment + WAGE_US_MI_UNEMP + + + + ER: US-MI Unemployment + ER_US_MI_UNEMP + + + + + EE: US-MI Income Tax Withholding + EE_US_MI_INC_WITHHOLD + + + + diff --git a/l10n_us_mi_hr_payroll/data/final.xml b/l10n_us_mi_hr_payroll/data/final.xml new file mode 100755 index 00000000..bd088e61 --- /dev/null +++ b/l10n_us_mi_hr_payroll/data/final.xml @@ -0,0 +1,17 @@ + + + + + + US_MI_EMP + USA Michigan Employee + + + + + + diff --git a/l10n_us_mi_hr_payroll/data/rates.xml b/l10n_us_mi_hr_payroll/data/rates.xml new file mode 100755 index 00000000..1becd022 --- /dev/null +++ b/l10n_us_mi_hr_payroll/data/rates.xml @@ -0,0 +1,14 @@ + + + + + + US MI Unemployment + US_MI_UNEMP + 6 + 2019-01-01 + + + + + diff --git a/l10n_us_mi_hr_payroll/data/rules.xml b/l10n_us_mi_hr_payroll/data/rules.xml new file mode 100755 index 00000000..3afef64d --- /dev/null +++ b/l10n_us_mi_hr_payroll/data/rules.xml @@ -0,0 +1,86 @@ + + + + + + + + Wage: US-MI Unemployment + WAGE_US_MI_UNEMP + python + result = (contract.futa_type != contract.FUTA_TYPE_BASIC) + code + +rate = payslip.dict.get_rate('US_MI_UNEMP') +year = int(payslip.dict.date_to[:4]) +ytd = payslip.sum('WAGE_US_MI_UNEMP', str(year) + '-01-01', str(year+1) + '-01-01') +ytd += contract.external_wages +remaining = rate.wage_limit_year - ytd +if remaining <= 0.0: + result = 0 +elif remaining < categories.BASIC: + result = remaining +else: + result = categories.BASIC + + + + + + + + ER: US-MI Unemployment + ER_US_MI_UNEMP + python + result = (contract.futa_type != contract.FUTA_TYPE_BASIC) + code + +rate = payslip.dict.get_rate('US_MI_UNEMP') +result_rate = -rate.rate +result = categories.WAGE_US_MI_UNEMP + +# result_rate of 0 implies 100% due to bug +if result_rate == 0.0: + result = 0.0 + + + + + + + + + EE: US-MI Income Tax Withholding + EE_US_MI_INC_WITHHOLD + python + result = not contract.mi_w4_tax_exempt + code + +wages = categories.GROSS +allowances = contract.mi_w4_exemptions +schedule_pay = contract.schedule_pay +annual_exemption_amount = 4400.00 * allowances +allowance_amount = 0.0 + +pay_period = 0.0 +pay_periods = { + 'weekly': 52.0, + 'bi-weekly': 26.0, + 'semi-monthly': 24.0, + 'monthly': 12.0 + } +if schedule_pay in pay_periods: + pay_period = pay_periods[schedule_pay] +else: + raise Exception('Invalid schedule_pay="' + schedule_pay + '" for MI Income Withholding calculation') + +allowance_amount = (annual_exemption_amount / pay_period) +withholding = round((wages - allowance_amount) * 0.0425) + contract.mi_w4_additional_wh +result = - withholding + + + + + + + diff --git a/l10n_us_mi_hr_payroll/models/__init__.py b/l10n_us_mi_hr_payroll/models/__init__.py new file mode 100644 index 00000000..e99aa24a --- /dev/null +++ b/l10n_us_mi_hr_payroll/models/__init__.py @@ -0,0 +1 @@ +from . import hr_payroll diff --git a/l10n_us_mi_hr_payroll/models/hr_payroll.py b/l10n_us_mi_hr_payroll/models/hr_payroll.py new file mode 100755 index 00000000..9bdb8d10 --- /dev/null +++ b/l10n_us_mi_hr_payroll/models/hr_payroll.py @@ -0,0 +1,10 @@ +from odoo import models, fields, api + + +class USMIHrContract(models.Model): + _inherit = 'hr.contract' + + mi_w4_exemptions = fields.Integer(string='Michigan W-4 Allowances', default=0) + mi_w4_additional_wh = fields.Float(string="Additional Withholding", default=0.0) + mi_w4_tax_exempt = fields.Boolean(string="Tax Exempt") + diff --git a/l10n_us_mi_hr_payroll/tests/__init__.py b/l10n_us_mi_hr_payroll/tests/__init__.py new file mode 100755 index 00000000..af81e140 --- /dev/null +++ b/l10n_us_mi_hr_payroll/tests/__init__.py @@ -0,0 +1 @@ +from . import test_us_mi_payslip diff --git a/l10n_us_mi_hr_payroll/tests/test_us_mi_payslip.py b/l10n_us_mi_hr_payroll/tests/test_us_mi_payslip.py new file mode 100755 index 00000000..17448df0 --- /dev/null +++ b/l10n_us_mi_hr_payroll/tests/test_us_mi_payslip.py @@ -0,0 +1,294 @@ +from odoo.addons.l10n_us_hr_payroll.tests.test_us_payslip import TestUsPayslip, process_payslip +from odoo.addons.l10n_us_hr_payroll.models.l10n_us_hr_payroll import USHrContract + + +class TestUsMIPayslip(TestUsPayslip): + + # Taxes and Rates + MI_UNEMP_MAX_WAGE = 9000.0 + MI_UNEMP = - 6.0 / 100.0 + MI_INC_TAX = - 4.25 / 100.0 + ANNUAL_EXEMPTION_AMOUNT = 4400.00 + PAY_PERIOD_DIVISOR = { + 'weekly': 52.0, + 'bi-weekly': 26.0, + 'semi-monthly': 24.0, + 'monthly': 12.0 + } + + def test_2019_taxes_weekly(self): + salary = 5000.0 + schedule_pay = 'weekly' + exemptions = 1 + allowance_amount = self.ANNUAL_EXEMPTION_AMOUNT / self.PAY_PERIOD_DIVISOR[schedule_pay] + wh = -round((salary - (allowance_amount * exemptions)) * -self.MI_INC_TAX) + + employee = self._createEmployee() + contract = self._createContract(employee, + salary, + struct_id=self.ref('l10n_us_mi_hr_payroll.hr_payroll_salary_structure_us_mi_employee'), + schedule_pay=schedule_pay) + contract.mi_w4_exemptions = exemptions + + self.assertEqual(contract.schedule_pay, 'weekly') + + self._log('2019 Michigan tax first payslip weekly:') + payslip = self._createPayslip(employee, '2019-01-01', '2019-01-31') + payslip.compute_sheet() + cats = self._getCategories(payslip) + + self.assertPayrollEqual(cats['WAGE_US_MI_UNEMP'], salary) + self.assertPayrollEqual(cats['ER_US_MI_UNEMP'], cats['WAGE_US_MI_UNEMP'] * self.MI_UNEMP) + self.assertPayrollEqual(cats['EE_US_MI_INC_WITHHOLD'], wh) + + process_payslip(payslip) + + # Make a new payslip, this one will have maximums + remaining_MI_UNEMP_wages = self.MI_UNEMP_MAX_WAGE - salary if (self.MI_UNEMP_MAX_WAGE - 2*salary < salary) \ + else salary + + self._log('2019 Michigan tax second payslip weekly:') + payslip = self._createPayslip(employee, '2019-02-01', '2019-02-28') + payslip.compute_sheet() + cats = self._getCategories(payslip) + + self.assertPayrollEqual(cats['WAGE_US_MI_UNEMP'], remaining_MI_UNEMP_wages) + self.assertPayrollEqual(cats['ER_US_MI_UNEMP'], remaining_MI_UNEMP_wages * self.MI_UNEMP) + + def test_2019_taxes_with_external_weekly(self): + salary = 5000.0 + external_wages = 30000.0 + schedule_pay = 'weekly' + + employee = self._createEmployee() + contract = self._createContract(employee, + salary, + external_wages=external_wages, + struct_id=self.ref('l10n_us_mi_hr_payroll.hr_payroll_salary_structure_us_mi_employee'), + schedule_pay=schedule_pay) + + self._log('2019 Michigan external tax first payslip weekly:') + payslip = self._createPayslip(employee, '2019-01-01', '2019-01-31') + payslip.compute_sheet() + cats = self._getCategories(payslip) + + self.assertPayrollEqual(cats['WAGE_US_MI_UNEMP'], max(self.MI_UNEMP_MAX_WAGE - external_wages, 0.0)) + self.assertPayrollEqual(cats['ER_US_MI_UNEMP'], cats['WAGE_US_MI_UNEMP'] * self.MI_UNEMP) + + def test_2019_taxes_with_state_exempt_weekly(self): + salary = 5000.0 + external_wages = 10000.0 + schedule_pay = 'weekly' + + employee = self._createEmployee() + contract = self._createContract(employee, salary, external_wages=external_wages, struct_id=self.ref( + 'l10n_us_mi_hr_payroll.hr_payroll_salary_structure_us_mi_employee'), + futa_type=USHrContract.FUTA_TYPE_BASIC, schedule_pay=schedule_pay) + + self._log('2019 Michigan exempt tax first payslip weekly:') + payslip = self._createPayslip(employee, '2019-01-01', '2019-01-31') + payslip.compute_sheet() + cats = self._getCategories(payslip) + + self.assertPayrollEqual(cats.get('WAGE_US_MI_UNEMP', 0.0), 0.0) + self.assertPayrollEqual(cats.get('ER_US_MI_UNEMP', 0.0), cats.get('WAGE_US_MI_UNEMP', 0.0) * self.MI_UNEMP) + + def test_2019_taxes_biweekly(self): + salary = 5000.0 + schedule_pay = 'bi-weekly' + allowance_amount = 0.0 + allowance_amount = self.ANNUAL_EXEMPTION_AMOUNT / self.PAY_PERIOD_DIVISOR[schedule_pay] + allowances = 2 + + wh = -round((salary - (allowance_amount * allowances)) * -self.MI_INC_TAX) + + employee = self._createEmployee() + contract = self._createContract(employee, salary, struct_id=self.ref( + 'l10n_us_mi_hr_payroll.hr_payroll_salary_structure_us_mi_employee'), + schedule_pay=schedule_pay) + contract.mi_w4_exemptions = allowances + + self.assertEqual(contract.schedule_pay, 'bi-weekly') + + self._log('2019 Michigan tax first payslip bi-weekly:') + payslip = self._createPayslip(employee, '2019-01-01', '2019-01-31') + payslip.compute_sheet() + cats = self._getCategories(payslip) + + self.assertPayrollEqual(cats['WAGE_US_MI_UNEMP'], salary) + self.assertPayrollEqual(cats['ER_US_MI_UNEMP'], cats['WAGE_US_MI_UNEMP'] * self.MI_UNEMP) + self.assertPayrollEqual(cats['EE_US_MI_INC_WITHHOLD'], wh) + + process_payslip(payslip) + + # Make a new payslip, this one will have maximums + remaining_MI_UNEMP_wages = self.MI_UNEMP_MAX_WAGE - salary if (self.MI_UNEMP_MAX_WAGE - 2*salary < salary) \ + else salary + + self._log('2019 Michigan tax second payslip bi-weekly:') + payslip = self._createPayslip(employee, '2019-02-01', '2019-02-28') + payslip.compute_sheet() + cats = self._getCategories(payslip) + + self.assertPayrollEqual(cats['WAGE_US_MI_UNEMP'], remaining_MI_UNEMP_wages) + self.assertPayrollEqual(cats['ER_US_MI_UNEMP'], remaining_MI_UNEMP_wages * self.MI_UNEMP) + + def test_2019_taxes_semimonthly(self): + salary = 5000.0 + schedule_pay = 'semi-monthly' + allowance_amount = self.ANNUAL_EXEMPTION_AMOUNT / self.PAY_PERIOD_DIVISOR[schedule_pay] + allowances = 1 + + wh = -round((salary - (allowance_amount * allowances)) * -self.MI_INC_TAX) + + employee = self._createEmployee() + contract = self._createContract(employee, salary, struct_id=self.ref( + 'l10n_us_mi_hr_payroll.hr_payroll_salary_structure_us_mi_employee'), + schedule_pay=schedule_pay) + contract.mi_w4_exemptions = allowances + + self.assertEqual(contract.schedule_pay, 'semi-monthly') + + self._log('2019 Michigan tax first payslip semi-monthly:') + payslip = self._createPayslip(employee, '2019-01-01', '2019-01-31') + payslip.compute_sheet() + cats = self._getCategories(payslip) + + self.assertPayrollEqual(cats['WAGE_US_MI_UNEMP'], salary) + self.assertPayrollEqual(cats['ER_US_MI_UNEMP'], cats['WAGE_US_MI_UNEMP'] * self.MI_UNEMP) + self.assertPayrollEqual(cats['EE_US_MI_INC_WITHHOLD'], wh) + + process_payslip(payslip) + + # Make a new payslip, this one will have maximums + remaining_MI_UNEMP_wages = self.MI_UNEMP_MAX_WAGE - salary if (self.MI_UNEMP_MAX_WAGE - 2 * salary < salary) \ + else salary + + self._log('2019 Michigan tax second payslip semi-monthly:') + payslip = self._createPayslip(employee, '2019-02-01', '2019-02-28') + payslip.compute_sheet() + cats = self._getCategories(payslip) + + self.assertPayrollEqual(cats['WAGE_US_MI_UNEMP'], remaining_MI_UNEMP_wages) + self.assertPayrollEqual(cats['ER_US_MI_UNEMP'], remaining_MI_UNEMP_wages * self.MI_UNEMP) + + def test_2019_taxes_monthly(self): + salary = 5000.0 + schedule_pay = 'monthly' + allowance_amount = self.ANNUAL_EXEMPTION_AMOUNT / self.PAY_PERIOD_DIVISOR[schedule_pay] + allowances = 1 + + wh = -round((salary - (allowance_amount * allowances)) * -self.MI_INC_TAX) + + employee = self._createEmployee() + contract = self._createContract(employee, salary, struct_id=self.ref( + 'l10n_us_mi_hr_payroll.hr_payroll_salary_structure_us_mi_employee'), + schedule_pay=schedule_pay) + contract.mi_w4_exemptions = allowances + + self.assertEqual(contract.schedule_pay, 'monthly') + + self._log('2019 Michigan tax first payslip monthly:') + payslip = self._createPayslip(employee, '2019-01-01', '2019-01-31') + payslip.compute_sheet() + cats = self._getCategories(payslip) + + self.assertPayrollEqual(cats['WAGE_US_MI_UNEMP'], salary) + self.assertPayrollEqual(cats['ER_US_MI_UNEMP'], cats['WAGE_US_MI_UNEMP'] * self.MI_UNEMP) + self.assertPayrollEqual(cats['EE_US_MI_INC_WITHHOLD'], wh) + + process_payslip(payslip) + + # Make a new payslip, this one will have maximums + remaining_MI_UNEMP_wages = self.MI_UNEMP_MAX_WAGE - salary if ( + self.MI_UNEMP_MAX_WAGE - (2 * salary) < salary) \ + else salary + + self._log('2019 Michigan tax second payslip monthly:') + payslip = self._createPayslip(employee, '2019-02-01', '2019-02-28') + payslip.compute_sheet() + cats = self._getCategories(payslip) + + self.assertPayrollEqual(cats['WAGE_US_MI_UNEMP'], remaining_MI_UNEMP_wages) + self.assertPayrollEqual(cats['ER_US_MI_UNEMP'], remaining_MI_UNEMP_wages * self.MI_UNEMP) + + def test_tax_exempt(self): + salary = 5000.0 + wh = 0 + schedule_pay = 'weekly' + exemptions = 1 + + employee = self._createEmployee() + contract = self._createContract(employee, salary, struct_id=self.ref( + 'l10n_us_mi_hr_payroll.hr_payroll_salary_structure_us_mi_employee'), + schedule_pay=schedule_pay) + contract.mi_w4_exemptions = exemptions + contract.mi_w4_tax_exempt = True + + self.assertEqual(contract.schedule_pay, 'weekly') + + self._log('2019 Michigan tax first payslip exempt:') + payslip = self._createPayslip(employee, '2019-01-01', '2019-01-31') + payslip.compute_sheet() + cats = self._getCategories(payslip) + + self.assertPayrollEqual(cats['WAGE_US_MI_UNEMP'], salary) + self.assertPayrollEqual(cats['ER_US_MI_UNEMP'], cats['WAGE_US_MI_UNEMP'] * self.MI_UNEMP) + self.assertPayrollEqual(cats.get('EE_US_MI_INC_WITHHOLD', 0.0), 0.0) + + process_payslip(payslip) + + # Make a new payslip, this one will have maximums + remaining_MI_UNEMP_wages = self.MI_UNEMP_MAX_WAGE - salary if ( + self.MI_UNEMP_MAX_WAGE - 2 * salary < salary) \ + else salary + + self._log('2019 Michigan tax second payslip exempt:') + payslip = self._createPayslip(employee, '2019-02-01', '2019-02-28') + payslip.compute_sheet() + cats = self._getCategories(payslip) + + self.assertPayrollEqual(cats['WAGE_US_MI_UNEMP'], remaining_MI_UNEMP_wages) + self.assertPayrollEqual(cats['ER_US_MI_UNEMP'], remaining_MI_UNEMP_wages * self.MI_UNEMP) + + def test_additional_withholding(self): + salary = 5000.0 + schedule_pay = 'weekly' + allowance_amount = 0.0 + allowance_amount = self.ANNUAL_EXEMPTION_AMOUNT / self.PAY_PERIOD_DIVISOR[schedule_pay] + additional_wh = 40.0 + allowances = 1 + + wh = -round(((salary - (allowance_amount * allowances)) * -self.MI_INC_TAX) + additional_wh) + + employee = self._createEmployee() + contract = self._createContract(employee, + salary, + struct_id=self.ref('l10n_us_mi_hr_payroll.hr_payroll_salary_structure_us_mi_employee'), + schedule_pay=schedule_pay) + contract.mi_w4_additional_wh = additional_wh + contract.mi_w4_exemptions = allowances + + self.assertEqual(contract.schedule_pay, 'weekly') + + self._log('2019 Michigan tax first payslip with additional withholding:') + payslip = self._createPayslip(employee, '2019-01-01', '2019-01-31') + payslip.compute_sheet() + cats = self._getCategories(payslip) + + self.assertPayrollEqual(cats['WAGE_US_MI_UNEMP'], salary) + self.assertPayrollEqual(cats['ER_US_MI_UNEMP'], cats['WAGE_US_MI_UNEMP'] * self.MI_UNEMP) + self.assertPayrollEqual(cats['EE_US_MI_INC_WITHHOLD'], wh) + + process_payslip(payslip) + + # Make a new payslip, this one will have maximums + remaining_MI_UNEMP_wages = 4000.00 + + self._log('2019 Michigan tax second payslip with additional withholding:') + payslip = self._createPayslip(employee, '2019-02-01', '2019-02-28') + payslip.compute_sheet() + cats = self._getCategories(payslip) + + self.assertPayrollEqual(cats['WAGE_US_MI_UNEMP'], remaining_MI_UNEMP_wages) + self.assertPayrollEqual(cats['ER_US_MI_UNEMP'], remaining_MI_UNEMP_wages * self.MI_UNEMP) diff --git a/l10n_us_mi_hr_payroll/views/hr_payroll_views.xml b/l10n_us_mi_hr_payroll/views/hr_payroll_views.xml new file mode 100755 index 00000000..7a526e12 --- /dev/null +++ b/l10n_us_mi_hr_payroll/views/hr_payroll_views.xml @@ -0,0 +1,22 @@ + + + + + hr.contract.form.inherit + hr.contract + 130 + + + + + + + + + + + + + + +