Merge branch 'new/13.0/l10n_us_hr_payroll' into '13.0-test'

new/13.0/l10n_us_hr_payroll into 13.0-test

See merge request hibou-io/hibou-odoo/suite!217
This commit is contained in:
Hibou Bot
2020-01-07 23:00:13 +00:00
11 changed files with 295 additions and 41 deletions

View File

@@ -26,6 +26,7 @@ United States of America - Payroll Rules.
'data/federal/fed_941_fit_parameters.xml',
'data/federal/fed_941_fit_rules.xml',
'data/state/fl_florida.xml',
'data/state/pa_pennsylvania.xml',
'views/hr_contract_views.xml',
'views/us_payroll_config_views.xml',
],

View File

@@ -29,4 +29,11 @@
<field name="parent_id" ref="hr_payroll.COMP"/>
</record>
<!-- State Income Tax -->
<record id="hr_payroll_category_ee_us_sit" model="hr.salary.rule.category">
<field name="name">EE: State Income Tax Withholding</field>
<field name="code">EE_US_SIT</field>
<field name="parent_id" ref="hr_payroll.DED"/>
</record>
</odoo>

View File

@@ -0,0 +1,131 @@
<?xml version="1.0" encoding="UTF-8" ?>
<odoo>
<!-- Wage Base -->
<record id="rule_parameter_us_pa_suta_wage_base" model="hr.rule.parameter">
<field name="name">US PA Pennsylvania SUTA Wage Base (ER)</field>
<field name="code">us_pa_suta_wage_base</field>
<field name="country_id" ref="base.us"/>
</record>
<data noupdate="1">
<record id="rule_parameter_us_pa_suta_wage_base_2019" model="hr.rule.parameter.value">
<field name="parameter_value">10000.00</field>
<field name="rule_parameter_id" ref="rule_parameter_us_pa_suta_wage_base"/>
<field name="date_from" eval="datetime(2019, 1, 1).date()"/>
</record>
<record id="rule_parameter_us_pa_suta_wage_base_2020" model="hr.rule.parameter.value">
<field name="parameter_value">10000.00</field>
<field name="rule_parameter_id" ref="rule_parameter_us_pa_suta_wage_base"/>
<field name="date_from" eval="datetime(2020, 1, 1).date()"/>
</record>
</data>
<!-- Rate -->
<record id="rule_parameter_us_pa_suta_rate" model="hr.rule.parameter">
<field name="name">US PA Pennsylvania SUTA Rate</field>
<field name="code">us_pa_suta_rate</field>
<field name="country_id" ref="base.us"/>
</record>
<data noupdate="1">
<record id="rule_parameter_us_pa_suta_rate_2019" model="hr.rule.parameter.value">
<field name="parameter_value">3.6890</field>
<field name="rule_parameter_id" ref="rule_parameter_us_pa_suta_rate"/>
<field name="date_from" eval="datetime(2019, 1, 1).date()"/>
</record>
<record id="rule_parameter_us_pa_suta_rate_2020" model="hr.rule.parameter.value">
<field name="parameter_value">3.6890</field>
<field name="rule_parameter_id" ref="rule_parameter_us_pa_suta_rate"/>
<field name="date_from" eval="datetime(2020, 1, 1).date()"/>
</record>
</data>
<record id="rule_parameter_us_pa_suta_ee_rate" model="hr.rule.parameter">
<field name="name">US PA Pennsylvania SUTA Employee Rate</field>
<field name="code">us_pa_suta_ee_rate</field>
<field name="country_id" ref="base.us"/>
</record>
<data noupdate="1">
<record id="rule_parameter_us_pa_suta_ee_rate_2019" model="hr.rule.parameter.value">
<field name="parameter_value">0.06</field>
<field name="rule_parameter_id" ref="rule_parameter_us_pa_suta_ee_rate"/>
<field name="date_from" eval="datetime(2019, 1, 1).date()"/>
</record>
<record id="rule_parameter_us_pa_suta_ee_rate_2020" model="hr.rule.parameter.value">
<field name="parameter_value">0.06</field>
<field name="rule_parameter_id" ref="rule_parameter_us_pa_suta_ee_rate"/>
<field name="date_from" eval="datetime(2020, 1, 1).date()"/>
</record>
</data>
<record id="rule_parameter_us_pa_sit_rate" model="hr.rule.parameter">
<field name="name">US PA Pennsylvania SIT Rate</field>
<field name="code">us_pa_sit_rate</field>
<field name="country_id" ref="base.us"/>
</record>
<data noupdate="1">
<record id="rule_parameter_us_pa_sit_rate_2019" model="hr.rule.parameter.value">
<field name="parameter_value">3.07</field>
<field name="rule_parameter_id" ref="rule_parameter_us_pa_sit_rate"/>
<field name="date_from" eval="datetime(2019, 1, 1).date()"/>
</record>
<record id="rule_parameter_us_pa_sit_rate_2020" model="hr.rule.parameter.value">
<field name="parameter_value">3.07</field>
<field name="rule_parameter_id" ref="rule_parameter_us_pa_sit_rate"/>
<field name="date_from" eval="datetime(2020, 1, 1).date()"/>
</record>
</data>
<!-- Partners and Contribution Registers -->
<record id="res_partner_us_pa_dor" model="res.partner">
<field name="name">US Pennsylvania - Department of Revenue - Unemployment Tax</field>
</record>
<record id="res_partner_us_pa_dor_sit" model="res.partner">
<field name="name">US Pennsylvania - Department of Revenue - Income Tax</field>
</record>
<!-- Categories -->
<!-- Rules -->
<record id="hr_payroll_rule_er_us_pa_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 PA Pennsylvania State Unemployment (RT-6)</field>
<field name="code">ER_US_PA_SUTA</field>
<field name="condition_select">python</field>
<field name="condition_python">result, _ = general_state_unemployment(payslip, categories, worked_days, inputs, wage_base='us_pa_suta_wage_base', rate='us_pa_suta_rate', state_code='PA')</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_pa_suta_wage_base', rate='us_pa_suta_rate', state_code='PA')</field>
<field name="partner_id" ref="res_partner_us_pa_dor"/>
<field name="appears_on_payslip" eval="False"/>
</record>
<record id="hr_payroll_rule_ee_us_pa_suta" 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_suta"/>
<field name="name">EE: US PA Pennsylvania State Unemployment (RT-6)</field>
<field name="code">EE_US_PA_SUTA</field>
<field name="condition_select">python</field>
<field name="condition_python">result, _ = general_state_unemployment(payslip, categories, worked_days, inputs, rate='us_pa_suta_ee_rate', state_code='PA')</field>
<field name="amount_select">code</field>
<field name="amount_python_compute">result, result_rate = general_state_unemployment(payslip, categories, worked_days, inputs, rate='us_pa_suta_ee_rate', state_code='PA')</field>
<field name="partner_id" ref="res_partner_us_pa_dor"/>
<field name="appears_on_payslip" eval="True"/>
</record>
<record id="hr_payroll_rule_ee_us_pa_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 PA Pennsylvania State Income Tax Withholding</field>
<field name="code">EE_US_PA_SIT</field>
<field name="condition_select">python</field>
<field name="condition_python">result, _ = general_state_income_withholding(payslip, categories, worked_days, inputs, rate='us_pa_sit_rate', state_code='PA')</field>
<field name="amount_select">code</field>
<field name="amount_python_compute">result, result_rate = general_state_income_withholding(payslip, categories, worked_days, inputs, rate='us_pa_sit_rate', state_code='PA')</field>
<field name="partner_id" ref="res_partner_us_pa_dor_sit"/>
<field name="appears_on_payslip" eval="True"/>
</record>
</odoo>

View File

@@ -9,7 +9,8 @@ from .federal.fed_941 import ee_us_941_fica_ss, \
er_us_941_fica_ss, \
er_us_941_fica_m, \
ee_us_941_fit
from .state.general import general_state_unemployment
from .state.general import general_state_unemployment, \
general_state_income_withholding
class HRPayslip(models.Model):
@@ -39,6 +40,7 @@ class HRPayslip(models.Model):
'er_us_941_fica_m': er_us_941_fica_m,
'ee_us_941_fit': ee_us_941_fit,
'general_state_unemployment': general_state_unemployment,
'general_state_income_withholding': general_state_income_withholding,
})
return res

View File

@@ -5,26 +5,17 @@ from odoo.exceptions import UserError
# _logger = logging.getLogger(__name__)
def general_state_unemployment(payslip, categories, worked_days, inputs, wage_base=None, wage_start=None, rate=None, state_code=None):
def _state_applies(payslip, state_code):
return state_code == payslip.contract_id.us_payroll_config_value('state_code')
def _general_rate(payslip, wage, ytd_wage, wage_base=None, wage_start=None, rate=None):
"""
Returns SUTA eligible wage and rate.
WAGE = GROSS - WAGE_US_940_FUTA_EXEMPT
The contract's `futa_type` determines if SUTA should be collected.
Function parameters:
wage_base, wage_start, rate can either be strings (rule_parameters) or floats
:return: result, result_rate (wage, percent)
:return: result, result_rate(wage, percent)
"""
if state_code != payslip.contract_id.us_payroll_config_value('state_code'):
return 0.0, 0.0
# Determine Eligible.
if payslip.contract_id.futa_type in (payslip.contract_id.FUTA_TYPE_EXEMPT, payslip.contract_id.FUTA_TYPE_BASIC):
return 0.0, 0.0
# Resolve parameters. On exception, return (probably missing a year, would rather not have exception)
if wage_base and isinstance(wage_base, str):
try:
@@ -50,15 +41,6 @@ def general_state_unemployment(payslip, categories, worked_days, inputs, wage_ba
# Rate assumed positive percentage!
rate = -rate
# Determine Wage
year = payslip.dict.get_year()
ytd_wage = payslip.sum_category('GROSS', str(year) + '-01-01', str(year + 1) + '-01-01')
ytd_wage -= payslip.sum_category('WAGE_US_940_FUTA_EXEMPT', str(year) + '-01-01', str(year + 1) + '-01-01')
ytd_wage += payslip.contract_id.external_wages
wage = categories.GROSS - categories.WAGE_US_940_FUTA_EXEMPT
#_logger.warn('ytd_wage: ' + str(ytd_wage) + ' wage: ' + str(wage))
if wage_base:
remaining = wage_base - ytd_wage
if remaining < 0.0:
@@ -68,18 +50,70 @@ def general_state_unemployment(payslip, categories, worked_days, inputs, wage_ba
else:
result = wage
#_logger.warn(' wage_base method result: ' + str(result) + ' rate: ' + str(rate))
# _logger.warn(' wage_base method result: ' + str(result) + ' rate: ' + str(rate))
return result, rate
if wage_start:
if ytd_wage >= wage_start:
#_logger.warn(' wage_start 1 method result: ' + str(wage) + ' rate: ' + str(rate))
# _logger.warn(' wage_start 1 method result: ' + str(wage) + ' rate: ' + str(rate))
return wage, rate
if ytd_wage + wage <= wage_start:
#_logger.warn(' wage_start 2 method result: ' + str(0.0) + ' rate: ' + str(0.0))
# _logger.warn(' wage_start 2 method result: ' + str(0.0) + ' rate: ' + str(0.0))
return 0.0, 0.0
#_logger.warn(' wage_start 3 method result: ' + str((wage - (wage_start - ytd_wage))) + ' rate: ' + str(rate))
# _logger.warn(' wage_start 3 method result: ' + str((wage - (wage_start - ytd_wage))) + ' rate: ' + str(rate))
return (wage - (wage_start - ytd_wage)), rate
# If the wage doesn't have a start or a base
#_logger.warn(' basic result: ' + str(wage) + ' rate: ' + str(rate))
# _logger.warn(' basic result: ' + str(wage) + ' rate: ' + str(rate))
return wage, rate
def general_state_unemployment(payslip, categories, worked_days, inputs, wage_base=None, wage_start=None, rate=None, state_code=None):
"""
Returns SUTA eligible wage and rate.
WAGE = GROSS - WAGE_US_940_FUTA_EXEMPT
The contract's `futa_type` determines if SUTA should be collected.
:return: result, result_rate(wage, percent)
"""
if not _state_applies(payslip, state_code):
return 0.0, 0.0
# Determine Eligible.
if payslip.contract_id.futa_type in (payslip.contract_id.FUTA_TYPE_EXEMPT, payslip.contract_id.FUTA_TYPE_BASIC):
return 0.0, 0.0
# Determine Wage
year = payslip.dict.get_year()
ytd_wage = payslip.sum_category('GROSS', str(year) + '-01-01', str(year + 1) + '-01-01')
ytd_wage -= payslip.sum_category('WAGE_US_940_FUTA_EXEMPT', str(year) + '-01-01', str(year + 1) + '-01-01')
ytd_wage += payslip.contract_id.external_wages
wage = categories.GROSS - categories.WAGE_US_940_FUTA_EXEMPT
return _general_rate(payslip, wage, ytd_wage, wage_base=wage_base, wage_start=wage_start, rate=rate)
def general_state_income_withholding(payslip, categories, worked_days, inputs, wage_base=None, wage_start=None, rate=None, state_code=None):
"""
Returns SUTA eligible wage and rate.
WAGE = GROSS - WAGE_US_941_FIT_EXEMPT
The Federal Income Tax Filing status (W4) is used for Exemption.
:return: result, result_rate (wage, percent)
"""
if not _state_applies(payslip, state_code):
return 0.0, 0.0
if not payslip.contract_id.us_payroll_config_value('fed_941_fit_w4_filing_status'):
return 0.0, 0.0
# Determine Wage
year = payslip.dict.get_year()
ytd_wage = payslip.sum_category('GROSS', str(year) + '-01-01', str(year + 1) + '-01-01')
ytd_wage -= payslip.sum_category('WAGE_US_941_FIT_EXEMPT', str(year) + '-01-01', str(year + 1) + '-01-01')
ytd_wage += payslip.contract_id.external_wages
wage = categories.GROSS - categories.WAGE_US_941_FIT_EXEMPT
return _general_rate(payslip, wage, ytd_wage, wage_base=wage_base, wage_start=wage_start, rate=rate)

View File

@@ -6,3 +6,5 @@ from . import test_us_payslip_2020
from . import test_us_fl_florida_payslip_2019
from . import test_us_fl_florida_payslip_2020
from . import test_us_pa_pennsylvania_payslip_2019
from . import test_us_pa_pennsylvania_payslip_2020

View File

@@ -169,7 +169,7 @@ class TestUsPayslip(common.TransactionCase):
cache[code] = us_state
return us_state
def _test_er_suta(self, state_code, rate, date, wage_base=None, **extra_contract):
def _test_suta(self, category, state_code, rate, date, wage_base=None, **extra_contract):
if wage_base:
# Slightly larger than 1/2 the wage_base
wage = round(wage_base / 2.0) + 100.0
@@ -192,28 +192,29 @@ class TestUsPayslip(common.TransactionCase):
contract.us_payroll_config_id.fed_940_type = USHRContract.FUTA_TYPE_EXEMPT
payslip.compute_sheet()
cats = self._getCategories(payslip)
self.assertPayrollEqual(cats.get('ER_US_SUTA', 0.0), 0.0)
self.assertPayrollEqual(cats.get(category, 0.0), 0.0)
contract.us_payroll_config_id.fed_940_type = USHRContract.FUTA_TYPE_BASIC
payslip.compute_sheet()
cats = self._getCategories(payslip)
self.assertPayrollEqual(cats.get('ER_US_SUTA', 0.0), 0.0)
self.assertPayrollEqual(cats.get(category, 0.0), 0.0)
# Test Normal
contract.us_payroll_config_id.fed_940_type = USHRContract.FUTA_TYPE_NORMAL
payslip.compute_sheet()
cats = self._getCategories(payslip)
self.assertPayrollEqual(cats.get('ER_US_SUTA', 0.0), wage * rate)
self.assertPayrollEqual(cats.get(category, 0.0), wage * rate)
process_payslip(payslip)
# Second Payslip
payslip = self._createPayslip(employee, date + timedelta(days=31), date + timedelta(days=60))
payslip.compute_sheet()
cats = self._getCategories(payslip)
if wage_base:
process_payslip(payslip)
remaining_unemp_wages = wage_base - wage
self.assertTrue((remaining_unemp_wages * rate) <= 0.01) # less than 0.01 because rate is negative
payslip = self._createPayslip(employee, date + timedelta(days=31), date + timedelta(days=60))
payslip.compute_sheet()
cats = self._getCategories(payslip)
self.assertPayrollEqual(cats.get('ER_US_SUTA', 0.0), remaining_unemp_wages * rate)
self.assertPayrollEqual(cats.get(category, 0.0), remaining_unemp_wages * rate)
# As if they were paid once already, so the first "two payslips" would remove all of the tax obligation
# 1 wage - Payslip (confirmed)
@@ -222,4 +223,12 @@ class TestUsPayslip(common.TransactionCase):
contract.external_wages = wage
payslip.compute_sheet()
cats = self._getCategories(payslip)
self.assertPayrollEqual(cats.get('ER_US_SUTA', 0.0), 0.0)
self.assertPayrollEqual(cats.get(category, 0.0), 0.0)
else:
self.assertPayrollEqual(cats.get(category, 0.0), wage * rate)
def _test_er_suta(self, state_code, rate, date, wage_base=None, **extra_contract):
self._test_suta('ER_US_SUTA', state_code, rate, date, wage_base=wage_base, **extra_contract)
def _test_ee_suta(self, state_code, rate, date, wage_base=None, **extra_contract):
self._test_suta('EE_US_SUTA', state_code, rate, date, wage_base=wage_base, **extra_contract)

View File

@@ -1,3 +1,5 @@
# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details.
from .common import TestUsPayslip, process_payslip
from odoo.addons.l10n_us_hr_payroll.models.hr_contract import USHRContract

View File

@@ -1,3 +1,5 @@
# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details.
from datetime import date
from .common import TestUsPayslip

View File

@@ -0,0 +1,33 @@
# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details.
from .common import TestUsPayslip, process_payslip
class TestUsPAPayslip(TestUsPayslip):
###
# Taxes and Rates
###
PA_UNEMP_MAX_WAGE = 10000.0
ER_PA_UNEMP = -3.6890 / 100.0
EE_PA_UNEMP = -0.06 / 100.0
PA_INC_WITHHOLD = 3.07
def test_2019_taxes(self):
salary = 4166.67
wh = -127.92
employee = self._createEmployee()
contract = self._createContract(employee,
wage=salary,
state_id=self.get_us_state('PA'))
self._log('2019 Pennsylvania tax first payslip:')
payslip = self._createPayslip(employee, '2019-01-01', '2019-01-31')
payslip.compute_sheet()
cats = self._getCategories(payslip)
self.assertPayrollEqual(cats['EE_US_SUTA'], cats['GROSS'] * self.EE_PA_UNEMP)
self.assertPayrollEqual(cats['ER_US_SUTA'], cats['GROSS'] * self.ER_PA_UNEMP)
self.assertPayrollEqual(cats['EE_US_SIT'], wh)

View File

@@ -0,0 +1,31 @@
# Part of Hibou Suite Professional. See LICENSE_PROFESSIONAL file for full copyright and licensing details.
from datetime import date
from .common import TestUsPayslip
class TestUsPAPayslip(TestUsPayslip):
###
# Taxes and Rates
###
PA_UNEMP_MAX_WAGE = 10000.0
ER_PA_UNEMP = 3.6890
EE_PA_UNEMP = 0.06
PA_INC_WITHHOLD = 3.07
def test_2020_taxes(self):
self._test_er_suta('PA', self.ER_PA_UNEMP, date(2020, 1, 1), wage_base=self.PA_UNEMP_MAX_WAGE)
self._test_ee_suta('PA', self.EE_PA_UNEMP, date(2020, 1, 1))
salary = 4166.67
wh = -127.92
employee = self._createEmployee()
contract = self._createContract(employee,
wage=salary,
state_id=self.get_us_state('PA'))
self._log('2019 Pennsylvania tax first payslip:')
payslip = self._createPayslip(employee, '2020-01-01', '2020-01-31')
payslip.compute_sheet()
cats = self._getCategories(payslip)
self.assertPayrollEqual(cats['EE_US_SIT'], wh)