audrius/suite
1
0
Fork 1
mirror of https://gitlab.com/hibou-io/hibou-odoo/suite.git synced 2025-01-20 12:37:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'new/11.0/l10n_us_ar_hr_payroll' into 11.0

Browse Source
This commit is contained in:
Jared Kipe
2019-07-19 07:21:39 -07:00
parent 6904f71fa4 b2b2469f49
commit 01ee399f93
11 changed files with 547 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
l10n_us_ar_hr_payroll/__init__.py Executable file
View File

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

28
l10n_us_ar_hr_payroll/__manifest__.py Executable file
View File

@@ -0,0 +1,28 @@
{
'name': 'USA - Arkansas - Payroll',
'author': 'Hibou Corp. <hello@hibou.io>',
'license': 'AGPL-3',
'category': 'Localization',
'depends': ['l10n_us_hr_payroll'],
'version': '11.0.2019.0.0',
'description': """
USA::Arkansas Payroll Rules.
==================================
* Contribution register and partner for Arkansas Department of Financial Administration - Income Tax Withholding
* Contribution register and partner for Arkansas Department of Workforce Solutions - Unemployment
* Contract level Arkansas Exemptions
* Company level Arkansas Unemployment Rate
* Salary Structure for Arkansas
""",
'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
}

47
l10n_us_ar_hr_payroll/data/base.xml Executable file
View File

@@ -0,0 +1,47 @@
<?xml version="1.0" encoding="utf-8"?>
<odoo>
<!-- PARTNERS -->
<record id="res_partner_ar_dws_unemp" model="res.partner">
<field name="name"> Arkansas Department of Workforce Solutions - Unemployment Tax</field>
<field name="supplier">1</field>
<field eval="0" name="customer"/>
</record>
<record id="res_partner_ar_dfa_withhold" model="res.partner">
<field name="name">Arkansas Department of Financial Administration- Income Tax Withholding</field>
<field name="supplier">1</field>
<field eval="0" name="customer"/>
</record>
<!-- CONTRIBUTION REGISTERS -->
<record id="contrib_register_ar_dws_unemp" model="hr.contribution.register">
<field name="name">Arkansas Unemployment</field>
<field name="note"> Arkansas Department of Workforce Solutions - Unemployment</field>
<field name="partner_id" ref="res_partner_ar_dws_unemp"/>
</record>
<record id="contrib_register_ar_dfa_withhold" model="hr.contribution.register">
<field name="name">Arkansas Income Tax Withholding</field>
<field name="note">Arkansas Department of Financial Administration - Income Tax Withholding</field>
<field name="partner_id" ref="res_partner_ar_dfa_withhold"/>
</record>
<!-- HR SALARY RULE CATEGORIES-->
<record id="hr_payroll_ar_unemp_wages" model="hr.salary.rule.category">
<field name="name">Wage: US-AR Unemployment</field>
<field name="code">WAGE_US_AR_UNEMP</field>
</record>
<record id="hr_payroll_ar_unemp" model="hr.salary.rule.category">
<field name="name">ER: US-AR Unemployment</field>
<field name="code">ER_US_AR_UNEMP</field>
<field name="parent_id" ref="hr_payroll.COMP"/>
</record>
<record id="hr_payroll_ar_income_withhold" model="hr.salary.rule.category">
<field name="name">EE: US-AR Income Tax Withholding</field>
<field name="code">EE_US_AR_INC_WITHHOLD</field>
<field name="parent_id" ref="hr_payroll.DED"/>
</record>
</odoo>

17
l10n_us_ar_hr_payroll/data/final.xml Executable file
View File

@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<odoo>
<!-- HR PAYROLL STRUCTURE -->
<record id="hr_payroll_salary_structure_us_ar_employee" model="hr.payroll.structure">
<field name="code">US_AR_EMP</field>
<field name="name">USA Arkansas Employee</field>
<field eval="[(6, 0, [
ref('hr_payroll_rules_ar_unemp_wages'),
ref('hr_payroll_rules_ar_unemp'),
ref('hr_payroll_rules_ar_inc_withhold'),
])]" name="rule_ids"/>
<field name="company_id" ref="base.main_company"/>
<field name="parent_id" ref="l10n_us_hr_payroll.hr_payroll_salary_structure_us_employee"/>
</record>
</odoo>

14
l10n_us_ar_hr_payroll/data/rates.xml Executable file
View File

@@ -0,0 +1,14 @@
<?xml version="1.0" encoding="utf-8"?>
<odoo>
<data noupdate="1">
<record id="hr_payroll_rates_ar_unemp" model="hr.payroll.rate">
<field name="name">US AR Unemployment</field>
<field name="code">US_AR_UNEMP</field>
<field name="rate">3.2</field>
<field name="date_from">2019-01-01</field>
<field name="wage_limit_year" eval="10000.00"/>
</record>
</data>
</odoo>

113
l10n_us_ar_hr_payroll/data/rules.xml Executable file
View File

@@ -0,0 +1,113 @@
<?xml version="1.0" encoding="utf-8"?>
<odoo>
<record id="hr_payroll_rules_ar_unemp_wages" model="hr.salary.rule">
<field name="sequence" eval="423"/>
<field name="category_id" ref="hr_payroll_ar_unemp_wages"/>
<field name="name">Wage: US-AR Unemployment</field>
<field name="code">WAGE_US_AR_UNEMP</field>
<field name="condition_select">python</field>
<field name="condition_python">result = (contract.futa_type != contract.FUTA_TYPE_BASIC)</field>
<field name="amount_select">code</field>
<field name="amount_python_compute">
rate = payslip.dict.get_rate('US_AR_UNEMP')
year = int(payslip.dict.date_to[:4])
ytd = payslip.sum('WAGE_US_AR_UNEMP', str(year) + '-01-01', str(year+1) + '-01-01')
ytd += contract.external_wages
remaining = rate.wage_limit_year - ytd
if remaining &lt;= 0.0:
result = 0
elif remaining &lt; categories.BASIC:
result = remaining
else:
result = categories.BASIC
</field>
<field name="appears_on_payslip" eval="False"/>
</record>
<record id="hr_payroll_rules_ar_unemp" model="hr.salary.rule">
<field name="sequence" eval="443"/>
<field name="category_id" ref="hr_payroll_ar_unemp"/>
<field name="name">ER: US-AR Unemployment</field>
<field name="code">ER_US_AR_UNEMP</field>
<field name="condition_select">python</field>
<field name="condition_python">result = (contract.futa_type != contract.FUTA_TYPE_BASIC)</field>
<field name="amount_select">code</field>
<field name="amount_python_compute">
rate = payslip.dict.get_rate('US_AR_UNEMP')
result_rate = -rate.rate
result = categories.WAGE_US_AR_UNEMP
# result_rate of 0 implies 100% due to bug
if result_rate == 0.0:
result = 0.0
</field>
<field name="register_id" ref="contrib_register_ar_dws_unemp"/>
<field name="appears_on_payslip" eval="False"/>
</record>
<record id="hr_payroll_rules_ar_inc_withhold" model="hr.salary.rule">
<field name="sequence" eval="155"/>
<field name="category_id" ref="hr_payroll_ar_income_withhold"/>
<field name="name">EE: US-AR Income Tax Withholding</field>
<field name="code">EE_US_AR_INC_WITHHOLD</field>
<field name="condition_select">python</field>
<field name="condition_python">result = not (contract.ar_w4_texarkana_exemption or contract.ar_w4_tax_exempt)</field>
<field name="amount_select">code</field>
<field name="amount_python_compute">
wages = categories.GROSS
annual_gross_pay = 0.00
allowance_amt = contract.ar_w4_allowances * 26.00
schedule_pay = contract.schedule_pay
standard_deduction = 2200
additional_withholding = contract.ar_w4_additional_wh
if contract.w4_filing_status == 'married':
standard_deduction = standard_deduction * 2
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 AR Income Withholding calculation')
annual_gross_pay = (wages * pay_period)
net_taxable_income = annual_gross_pay - standard_deduction - allowance_amt
if (net_taxable_income &lt; 50000.00):
# This formula will round the number to the nearest 50 if under 50000
net_taxable_income = (net_taxable_income // 50) * 50.0 + 50.0
tax_rate_table = [(4299, 0.90),
(8499, 2.50),
(12699, 3.50),
(21199, 4.50),
(35099, 6.0),
(float('inf'), 6.9)]
result = 0.0
last = 0.0
for row in tax_rate_table:
cap, rate = row
if cap &lt;= net_taxable_income:
taxed = cap - last
result = result + (taxed * (rate / 100.0))
last = cap
elif cap &gt; net_taxable_income:
taxed = net_taxable_income - last
result = result + (taxed * (rate / 100.0))
break
result = (result / pay_period) + additional_withholding
result = -result
</field>
<field name="register_id" ref="contrib_register_ar_dfa_withhold"/>
</record>
</odoo>

1
l10n_us_ar_hr_payroll/models/__init__.py Normal file
View File

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

10
l10n_us_ar_hr_payroll/models/hr_payroll.py Executable file
View File

@@ -0,0 +1,10 @@
from odoo import models, fields, api
class USARHrContract(models.Model):
_inherit = 'hr.contract'
ar_w4_allowances = fields.Integer(string='Arkansas W-4 allowances', default=0)
ar_w4_additional_wh = fields.Float(string="Arkansas Additional Withholding", default=0.0)
ar_w4_tax_exempt = fields.Boolean(string="Tax Exempt")
ar_w4_texarkana_exemption = fields.Boolean(string="Texarkana Exemption")

1
l10n_us_ar_hr_payroll/tests/__init__.py Executable file
View File

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

292
l10n_us_ar_hr_payroll/tests/test_us_ar_payslip_2019.py Executable file
View File

@@ -0,0 +1,292 @@
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 TestUsARPayslip(TestUsPayslip):
AR_UNEMP_MAX_WAGE = 10000.00
AR_UNEMP = -3.2 / 100.0
AR_INC_TAX = -0.0535
def test_taxes_monthly(self):
salary = 10000.0
schedule_pay = 'monthly'
employee = self._createEmployee()
contract = self._createContract(employee, salary,
struct_id=self.ref('l10n_us_ar_hr_payroll.hr_payroll_salary_structure_us_ar_employee'),
schedule_pay=schedule_pay)
self.assertEqual(contract.schedule_pay, 'monthly')
self._log('2019 Arkansas tax first payslip weekly:')
payslip = self._createPayslip(employee, '2019-01-01', '2019-01-31')
payslip.compute_sheet()
cats = self._getCategories(payslip)
# Not exempt from rule 1 or rule 2 - unemployment wages., and actual unemployment.
self.assertPayrollEqual(cats['WAGE_US_AR_UNEMP'], salary)
self.assertPayrollEqual(cats['ER_US_AR_UNEMP'], cats['WAGE_US_AR_UNEMP'] * self.AR_UNEMP)
process_payslip(payslip)
# Make a new payslip, this one will have maximums
remaining_AR_UNEMP_wages = self.AR_UNEMP_MAX_WAGE - salary if (self.AR_UNEMP_MAX_WAGE - 2*salary < salary) \
else salary
# We reached the cap of 10000.0 in the first payslip.
self.assertEqual(0.0, remaining_AR_UNEMP_wages)
self._log('2019 Arkansas 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_AR_UNEMP'], remaining_AR_UNEMP_wages)
self.assertPayrollEqual(cats['ER_US_AR_UNEMP'], remaining_AR_UNEMP_wages * self.AR_UNEMP)
def test_taxes_with_state_exempt(self):
salary = 50000.0
tax_exempt = True # State withholding should be zero.
employee = self._createEmployee()
contract = self._createContract(employee,
salary,
struct_id=self.ref('l10n_us_ar_hr_payroll.hr_payroll_salary_structure_us_ar_employee'),
)
contract.ar_w4_tax_exempt = tax_exempt
self._log('2019 Arkansas 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['WAGE_US_AR_UNEMP'], self.AR_UNEMP_MAX_WAGE)
self.assertPayrollEqual(cats.get('ER_US_AR_UNEMP', 0.0), cats.get('WAGE_US_AR_UNEMP', 0.0) * self.AR_UNEMP)
self.assertPayrollEqual(cats.get('EE_US_AR_INC_WITHHOLD', 0.0), 0.0)
process_payslip(payslip)
def test_taxes_with_texarkana_exempt(self):
salary = 40000.00
texarkana_exemption = True # State withholding should be zero.
employee = self._createEmployee()
contract = self._createContract(employee,
salary,
struct_id=self.ref('l10n_us_ar_hr_payroll.hr_payroll_salary_structure_us_ar_employee'))
contract.ar_w4_texarkana_exemption = texarkana_exemption
self._log('2019 Arkansas tax first payslip:')
payslip = self._createPayslip(employee, '2019-01-01', '2019-01-31')
payslip.compute_sheet()
cats = self._getCategories(payslip)
self.assertPayrollEqual(cats.get('WAGE_US_AR_UNEMP', 0.0), self.AR_UNEMP_MAX_WAGE)
self.assertPayrollEqual(cats.get('ER_US_AR_UNEMP', 0.0), cats.get('WAGE_US_AR_UNEMP', 0.0) * self.AR_UNEMP)
process_payslip(payslip)
def test_additional_withholding(self):
wages = 5000.0
schedule_pay = 'monthly'
pay_periods = 12
additional_wh = 150.0
exemptions = 2
# TODO: comment on how it was calculated
test_ar_amt = 3069.97
employee = self._createEmployee()
contract = self._createContract(employee,
wages,
struct_id=self.ref('l10n_us_ar_hr_payroll.hr_payroll_salary_structure_us_ar_employee'),
schedule_pay=schedule_pay)
contract.ar_w4_additional_wh = 0.0
contract.ar_w4_allowances = exemptions
self.assertEqual(contract.schedule_pay, 'monthly')
self._log('2019 Arkansas 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_AR_UNEMP'], wages)
self.assertPayrollEqual(cats['ER_US_AR_UNEMP'], cats['WAGE_US_AR_UNEMP'] * self.AR_UNEMP)
# TODO: change to hand the test_ar_amt already be divided by pay periods
self.assertPayrollEqual(cats['EE_US_AR_INC_WITHHOLD'], -(test_ar_amt / pay_periods))
contract.ar_w4_additional_wh = additional_wh
payslip.compute_sheet()
cats = self._getCategories(payslip)
self.assertPayrollEqual(cats['EE_US_AR_INC_WITHHOLD'], -(test_ar_amt / pay_periods) - additional_wh)
process_payslip(payslip)
def test_under_fifty_thousand(self):
wages = 2500.00
schedule_pay = 'monthly'
pay_periods = 12
additional_wh = 150.0
exemptions = 2
# TODO: comment calc.
test_ar_amt = 1066.151
employee = self._createEmployee()
contract = self._createContract(employee,
wages,
struct_id=self.ref(
'l10n_us_ar_hr_payroll.hr_payroll_salary_structure_us_ar_employee'),
schedule_pay=schedule_pay)
contract.ar_w4_additional_wh = 0.0
contract.ar_w4_allowances = exemptions
self.assertEqual(contract.schedule_pay, 'monthly')
self._log('2019 Arkansas 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_AR_UNEMP'], wages)
self.assertPayrollEqual(cats['ER_US_AR_UNEMP'], cats['WAGE_US_AR_UNEMP'] * self.AR_UNEMP)
self.assertPayrollEqual(cats['EE_US_AR_INC_WITHHOLD'], -(test_ar_amt / pay_periods))
contract.ar_w4_additional_wh = additional_wh
payslip.compute_sheet()
cats = self._getCategories(payslip)
self.assertPayrollEqual(cats['EE_US_AR_INC_WITHHOLD'], -(test_ar_amt / pay_periods) - additional_wh)
process_payslip(payslip)
# Make a new payslip, this one will have maximums
remaining_AR_UNEMP_wages = self.AR_UNEMP_MAX_WAGE - wages if (self.AR_UNEMP_MAX_WAGE - 2 * wages < wages) \
else wages
self._log('2019 Arkansas 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_AR_UNEMP'], remaining_AR_UNEMP_wages)
self.assertPayrollEqual(cats['ER_US_AR_UNEMP'], remaining_AR_UNEMP_wages * self.AR_UNEMP)
def test_over_fifty_thousand(self):
wages = 10000.00 # 10000.00 monthly is over 50,000 annually.
schedule_pay = 'monthly'
pay_periods = 12
additional_wh = 150.0
exemptions = 2
# TODO: comment on how it was calculated
test_ar_amt = 7209.97
employee = self._createEmployee()
contract = self._createContract(employee,
wages,
struct_id=self.ref(
'l10n_us_ar_hr_payroll.hr_payroll_salary_structure_us_ar_employee'),
schedule_pay=schedule_pay)
contract.ar_w4_additional_wh = 0.0
contract.ar_w4_allowances = exemptions
self.assertEqual(contract.schedule_pay, 'monthly')
self._log('2019 Arkansas 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_AR_UNEMP'], wages)
self.assertPayrollEqual(cats['ER_US_AR_UNEMP'], cats['WAGE_US_AR_UNEMP'] * self.AR_UNEMP)
self.assertPayrollEqual(cats['EE_US_AR_INC_WITHHOLD'], -(test_ar_amt / pay_periods))
contract.ar_w4_additional_wh = additional_wh
payslip.compute_sheet()
cats = self._getCategories(payslip)
self.assertPayrollEqual(cats['EE_US_AR_INC_WITHHOLD'], -(test_ar_amt / pay_periods) - additional_wh)
process_payslip(payslip)
# Make a new payslip, this one will have maximums
remaining_AR_UNEMP_wages = self.AR_UNEMP_MAX_WAGE - wages if (self.AR_UNEMP_MAX_WAGE - 2 * wages < wages) \
else wages
self._log('2019 Arkansas 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_AR_UNEMP'], remaining_AR_UNEMP_wages)
self.assertPayrollEqual(cats['ER_US_AR_UNEMP'], remaining_AR_UNEMP_wages * self.AR_UNEMP)
def test_married(self):
wages = 5500.00
schedule_pay = 'monthly'
pay_periods = 12
additional_wh = 150.0
exemptions = 2
w4_filing_status = 'married'
# TODO: explain calc.
# Yearly -> 3332.17. Monthly -> 427.681
test_ar_amt = 3332.17
employee = self._createEmployee()
contract = self._createContract(employee,
wages,
struct_id=self.ref(
'l10n_us_ar_hr_payroll.hr_payroll_salary_structure_us_ar_employee'),
schedule_pay=schedule_pay)
contract.ar_w4_additional_wh = additional_wh
contract.ar_w4_allowances = exemptions
contract.w4_filing_status = w4_filing_status
self.assertEqual(contract.w4_filing_status, 'married')
self._log('2019 Arkansas 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_AR_UNEMP'], wages)
self.assertPayrollEqual(cats['ER_US_AR_UNEMP'], cats['WAGE_US_AR_UNEMP'] * self.AR_UNEMP)
self.assertPayrollEqual(cats['EE_US_AR_INC_WITHHOLD'], -(test_ar_amt / pay_periods) - additional_wh)
def test_single(self):
wages = 5500.00
schedule_pay = 'monthly'
pay_periods = 12
additional_wh = 150.0
exemptions = 2
w4_filling_status = 'single'
# TODO: explain calc.
# Yearly -> 3483.972 Monthly -> 298.331
test_ar_amt = 3483.972
employee = self._createEmployee()
contract = self._createContract(employee,
wages,
struct_id=self.ref(
'l10n_us_ar_hr_payroll.hr_payroll_salary_structure_us_ar_employee'),
schedule_pay=schedule_pay)
contract.ar_w4_additional_wh = 0
contract.ar_w4_allowances = exemptions
contract.w4_filling_status = w4_filling_status
self.assertEqual(contract.w4_filling_status, 'single')
self._log('2019 Arkansas 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_AR_UNEMP'], wages)
self.assertPayrollEqual(cats['ER_US_AR_UNEMP'], cats['WAGE_US_AR_UNEMP'] * self.AR_UNEMP)
self.assertPayrollEqual(cats['EE_US_AR_INC_WITHHOLD'], -(test_ar_amt / pay_periods))
contract.ar_w4_additional_wh = additional_wh
payslip.compute_sheet()
cats = self._getCategories(payslip)
self.assertPayrollEqual(cats['EE_US_AR_INC_WITHHOLD'], -(test_ar_amt / pay_periods) - additional_wh)
process_payslip(payslip)

23
l10n_us_ar_hr_payroll/views/hr_payroll_views.xml Executable file
View File

@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="utf-8"?>
<odoo>
<data>
<record id="hr_contract_form_l10n_us_ar_inherit" model="ir.ui.view">
<field name="name">hr.contract.form.inherit</field>
<field name="model">hr.contract</field>
<field name="priority">106</field>
<field name="inherit_id" ref="hr_contract.hr_contract_view_form"/>
<field name="arch" type="xml">
<data>
<xpath expr="//group[@name='state_filing']" position="inside">
<group string="Arkansas" name="ar">
<field name="ar_w4_allowances" string="Allowances"/>
<field name="ar_w4_additional_wh" string="Additional Withholding"/>
<field name="ar_w4_tax_exempt" string="Tax Exempt"/>
<field name="ar_w4_texarkana_exemption" string="Texarkana Exemption"/>
</group>
</xpath>
</data>
</field>
</record>
</data>
</odoo>