Merge branch 'mig/12.0/l10n_us_wa_hr_payroll' into '12.0'

mig/12.0/l10n_us_wa_hr_payroll into 12.0

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

l10n_us_wa_hr_payroll/README.rst

@@ -0,0 +1,20 @@
+*************************************
+Hibou - US Payroll - Washington State
+*************************************
+
+Calculations and contribution registers for Washington State Payroll.
+
+For more information and add-ons, visit `Hibou.io <https://hibou.io/>`_.
+
+=============
+Main Features
+=============
+
+* LNI (Labor and Industries) defined on HR Contracts that can be shared between contracts.
+* Company level State Unemployment Rate (SUTA)
+
+=======
+License
+=======
+Please see `LICENSE <https://github.com/hibou-io/hibou-odoo-suite/blob/master/LICENSE>`_.
+Copyright Hibou Corp. 2018

l10n_us_wa_hr_payroll/__init__.py

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

l10n_us_wa_hr_payroll/__manifest__.py

@@ -0,0 +1,29 @@
+{
+    'name': 'USA - Washington - Payroll',
+    'author': 'Hibou Corp. <hello@hibou.io>',
+    'license': 'AGPL-3',
+    'category': 'Localization',
+    'depends': ['l10n_us_hr_payroll'],
+    'version': '12.0.2019.0.0',
+    'description': """
+USA::Washington Payroll Rules.
+==============================
+
+* Contribution register and partner for Washington Employment Security Department - Unemployment
+* Contribution register and partner for Washington Labor & Industries -  (LNI)
+* Contract level LNI
+* Company level Washington Unemployment Rate
+    """,
+
+    'auto_install': False,
+    'website': 'https://hibou.io/',
+    'data': [
+        'security/ir.model.access.csv',
+        'views/hr_payroll_views.xml',
+        'data/base.xml',
+        'data/rates.xml',
+        'data/rules.xml',
+        'data/final.xml',
+    ],
+    'installable': True
+}

l10n_us_wa_hr_payroll/data/base.xml

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+    <data>
+<!-- CONTRIBUTION REGISTERS -->
+    <record id="res_partner_wador_unemp" model="res.partner">
+        <field name="name">Washington Employment Security Department - Unemployment Tax</field>
+        <field name="supplier">1</field>
+        <field eval="0" name="customer"/>
+    </record>
+    <record id="res_partner_wador_lni" model="res.partner">
+        <field name="name">Washington Labor &amp; Industries - LNI</field>
+        <field name="supplier">1</field>
+        <field eval="0" name="customer"/>
+    </record>
+    <record id="contrib_register_wador_unemp" model="hr.contribution.register">
+        <field name="name">Washington Employment</field>
+        <field name="note">Washington Employment Security Department - Unemployment</field>
+        <field name="partner_id" ref="res_partner_wador_unemp"/>
+    </record>
+    <record id="contrib_register_wador_lni" model="hr.contribution.register">
+        <field name="name">Washington Labor &amp; Industries</field>
+        <field name="note">Washington Labor &amp; Industries - LNI</field>
+        <field name="partner_id" ref="res_partner_wador_lni"/>
+    </record>
+
+
+<!-- HR SALARY RULE CATEGORIES-->
+    <record id="hr_payroll_wa_unemp_wages" model="hr.salary.rule.category">
+        <field name="name">Wage: US-WA Unemployment</field>
+        <field name="code">WAGE_US_WA_UNEMP</field>
+    </record>
+
+    <record id="hr_payroll_wa_unemp" model="hr.salary.rule.category">
+        <field name="name">ER: US-WA Unemployment</field>
+        <field name="code">ER_US_WA_UNEMP</field>
+        <field name="parent_id" ref="hr_payroll.COMP"/>
+    </record>
+
+    <record id="hr_payroll_wa_lni" model="hr.salary.rule.category">
+        <field name="name">ER: US-WA LNI</field>
+        <field name="code">ER_US_WA_LNI</field>
+        <field name="parent_id" ref="hr_payroll.COMP"/>
+    </record>
+
+    <record id="hr_payroll_wa_lni_withhold" model="hr.salary.rule.category">
+        <field name="name">EE: US-WA LNI</field>
+        <field name="code">EE_US_WA_LNI</field>
+        <field name="parent_id" ref="hr_payroll.DED"/>
+    </record>
+
+    </data>
+</odoo>

l10n_us_wa_hr_payroll/data/final.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+    <data>
+
+<!-- HR PAYROLL STRUCTURE -->
+    <record id="hr_payroll_salary_structure_us_wa_employee" model="hr.payroll.structure">
+        <field name="code">US_WA_EMP</field>
+        <field name="name">USA Washington Employee</field>
+        <field eval="[(6, 0, [
+          ref('hr_payroll_rules_wa_unemp_wages_2018'),
+          ref('hr_payroll_rules_wa_unemp_2018'),
+          ref('hr_payroll_rules_wa_lni'),
+          ref('hr_payroll_rules_wa_lni_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>
+
+    </data>
+</odoo>

l10n_us_wa_hr_payroll/data/rates.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+    <data noupdate="1">
+        <record id="hr_payroll_rates_wa_unemp_2018" model="hr.payroll.rate">
+            <field name="name">US Washington Unemployment</field>
+            <field name="code">US_WA_UNEMP</field>
+            <field name="rate">1.16</field>
+            <field name="date_from">2018-01-01</field>
+            <field name="wage_limit_year" eval="47300.0"/>
+        </record>
+        <record id="hr_payroll_rates_wa_unemp_2019" model="hr.payroll.rate">
+            <field name="name">US Washington Unemployment</field>
+            <field name="code">US_WA_UNEMP</field>
+            <field name="rate">1.03</field>
+            <field name="date_from">2019-01-01</field>
+            <field name="wage_limit_year" eval="49800.0"/>
+        </record>
+    </data>
+</odoo>

l10n_us_wa_hr_payroll/data/rules.xml

@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+
+    <!-- HR SALARY RULES-->
+    <record id="hr_payroll_rules_wa_unemp_wages_2018" model="hr.salary.rule">
+        <field name="sequence" eval="423"/>
+        <field name="category_id" ref="hr_payroll_wa_unemp_wages"/>
+        <field name="name">Wage: US-WA Unemployment</field>
+        <field name="code">WAGE_US_WA_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">
+###
+year = payslip.dict.date_to.year
+rate = payslip.dict.get_rate('US_WA_UNEMP')
+ytd = payslip.sum('WAGE_US_WA_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_wa_unemp_2018" model="hr.salary.rule">
+        <field name="sequence" eval="443"/>
+        <field name="category_id" ref="hr_payroll_wa_unemp"/>
+        <field name="name">ER: US-WA Unemployment</field>
+        <field name="code">ER_US_WA_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_WA_UNEMP')
+result_rate = -rate.rate
+result = categories.WAGE_US_WA_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_wador_unemp"/>
+        <field name="appears_on_payslip" eval="False"/>
+    </record>
+
+    <record id="hr_payroll_rules_wa_lni_withhold" model="hr.salary.rule">
+        <field name="sequence" eval="150"/>
+        <field name="category_id" ref="hr_payroll_wa_lni_withhold"/>
+        <field name="name">EE: US-WA LNI</field>
+        <field name="code">EE_US_WA_LNI</field>
+        <field name="condition_select">none</field>
+        <field name="amount_select">code</field>
+        <field name="amount_python_compute">
+hours = worked_days.WORK100.number_of_hours
+rate = contract.wa_lni.rate_emp_withhold
+if rate:
+    result = -(hours * rate)
+
+        </field>
+        <field name="register_id" ref="contrib_register_wador_lni"/>
+    </record>
+
+    <record id="hr_payroll_rules_wa_lni" model="hr.salary.rule">
+        <field name="sequence" eval="155"/>
+        <field name="category_id" ref="hr_payroll_wa_lni"/>
+        <field name="name">ER: US-WA LNI</field>
+        <field name="code">ER_US_WA_LNI</field>
+        <field name="appears_on_payslip" eval="False"/>
+        <field name="condition_select">none</field>
+        <field name="amount_select">code</field>
+        <field name="amount_python_compute">
+hours = worked_days.WORK100.number_of_hours
+rate = contract.wa_lni.rate
+withholding = categories.EE_US_WA_LNI
+if rate:
+    result = -(hours * rate) - withholding
+
+        </field>
+        <field name="register_id" ref="contrib_register_wador_lni"/>
+    </record>
+
+</odoo>

l10n_us_wa_hr_payroll/models/__init__.py

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

l10n_us_wa_hr_payroll/models/hr_payroll.py

@@ -0,0 +1,15 @@
+from odoo import models, fields, api
+
+
+class USWAHrContract(models.Model):
+    _inherit = 'hr.contract'
+
+    wa_lni = fields.Many2one('hr.contract.lni.wa', string='WA State LNI')
+
+
+class WALNI(models.Model):
+    _name = 'hr.contract.lni.wa'
+
+    name = fields.Char(string='Name')
+    rate = fields.Float(string='Rate (per hour worked)', digits=(7, 6))
+    rate_emp_withhold = fields.Float(string='Employee Payroll Deduction Rate (per hour worked)', digits=(7, 6))

l10n_us_wa_hr_payroll/security/ir.model.access.csv

@@ -0,0 +1,3 @@
+id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
+access_hr_contract_lni_wa,access_hr_contract_lni_wa,model_hr_contract_lni_wa,base.group_user,1,0,0,0
+manage_hr_contract_lni_wa,manage_hr_contract_lni_wa,model_hr_contract_lni_wa,hr_payroll.group_hr_payroll_manager,1,1,1,1

l10n_us_wa_hr_payroll/tests/__init__.py

@@ -0,0 +1,2 @@
+from . import test_us_wa_payslip_2018
+from . import test_us_wa_payslip_2019

l10n_us_wa_hr_payroll/tests/test_us_wa_payslip_2018.py

@@ -0,0 +1,60 @@
+from odoo.addons.l10n_us_hr_payroll.tests.test_us_payslip import TestUsPayslip, process_payslip
+
+
+class TestUsWAPayslip(TestUsPayslip):
+    ###
+    #    Taxes and Rates
+    ###
+    WA_UNEMP_MAX_WAGE = 47300.0
+    WA_UNEMP_RATE = 1.16
+
+    def setUp(self):
+        super(TestUsWAPayslip, self).setUp()
+        self.lni = self.env['hr.contract.lni.wa'].create({
+            'name': '5302 Computer Consulting',
+            'rate': 0.1261,
+            'rate_emp_withhold': 0.05575,
+        })
+
+    def test_2018_taxes(self):
+        salary = 25000.0
+
+        employee = self._createEmployee()
+
+        contract = self._createContract(employee, salary, struct_id=self.ref('l10n_us_wa_hr_payroll.hr_payroll_salary_structure_us_wa_employee'))
+        self._log(str(contract.resource_calendar_id) + ' ' + contract.resource_calendar_id.name)
+        contract.wa_lni = self.lni
+
+        # tax rates
+        wa_unemp = self.WA_UNEMP_RATE / -100.0
+
+        self._log('2018 Washington tax first payslip:')
+        payslip = self._createPayslip(employee, '2018-01-01', '2018-01-31')
+        payslip.onchange_contract()
+        hours_in_period = payslip.worked_days_line_ids.filtered(lambda l: l.code == 'WORK100').number_of_hours
+        payslip.compute_sheet()
+
+
+        cats = self._getCategories(payslip)
+
+        self.assertPayrollEqual(cats['WAGE_US_WA_UNEMP'], salary)
+        self.assertPayrollEqual(cats['ER_US_WA_UNEMP'], cats['WAGE_US_WA_UNEMP'] * wa_unemp)
+        self.assertPayrollEqual(cats['EE_US_WA_LNI'], -(self.lni.rate_emp_withhold * hours_in_period))
+        self.assertPayrollEqual(cats['ER_US_WA_LNI'], -(self.lni.rate * hours_in_period) - cats['EE_US_WA_LNI'])
+
+        process_payslip(payslip)
+
+        # Make a new payslip, this one will have maximums
+
+        remaining_wa_unemp_wages = self.WA_UNEMP_MAX_WAGE - salary if (self.WA_UNEMP_MAX_WAGE - 2*salary < salary) \
+            else salary
+
+        self._log('2018 Washington tax second payslip:')
+        payslip = self._createPayslip(employee, '2018-02-01', '2018-02-28')
+        payslip.onchange_contract()
+        payslip.compute_sheet()
+
+        cats = self._getCategories(payslip)
+
+        self.assertPayrollEqual(cats['WAGE_US_WA_UNEMP'], remaining_wa_unemp_wages)
+        self.assertPayrollEqual(cats['ER_US_WA_UNEMP'], remaining_wa_unemp_wages * wa_unemp)

l10n_us_wa_hr_payroll/tests/test_us_wa_payslip_2019.py

@@ -0,0 +1,60 @@
+from odoo.addons.l10n_us_hr_payroll.tests.test_us_payslip import TestUsPayslip, process_payslip
+
+
+class TestUsWAPayslip(TestUsPayslip):
+    ###
+    #    Taxes and Rates
+    ###
+    WA_UNEMP_MAX_WAGE = 49800.0
+    WA_UNEMP_RATE = 1.03
+
+    def setUp(self):
+        super(TestUsWAPayslip, self).setUp()
+        self.lni = self.env['hr.contract.lni.wa'].create({
+            'name': '5302 Computer Consulting',
+            'rate': 0.1261,
+            'rate_emp_withhold': 0.05575,
+        })
+
+    def test_2019_taxes(self):
+        salary = 25000.0
+
+        employee = self._createEmployee()
+
+        contract = self._createContract(employee, salary, struct_id=self.ref('l10n_us_wa_hr_payroll.hr_payroll_salary_structure_us_wa_employee'))
+        self._log(str(contract.resource_calendar_id) + ' ' + contract.resource_calendar_id.name)
+        contract.wa_lni = self.lni
+
+        # tax rates
+        wa_unemp = self.WA_UNEMP_RATE / -100.0
+
+        self._log('2019 Washington tax first payslip:')
+        payslip = self._createPayslip(employee, '2019-01-01', '2019-01-31')
+        payslip.onchange_contract()
+        hours_in_period = payslip.worked_days_line_ids.filtered(lambda l: l.code == 'WORK100').number_of_hours
+        payslip.compute_sheet()
+
+
+        cats = self._getCategories(payslip)
+
+        self.assertPayrollEqual(cats['WAGE_US_WA_UNEMP'], salary)
+        self.assertPayrollEqual(cats['ER_US_WA_UNEMP'], cats['WAGE_US_WA_UNEMP'] * wa_unemp)
+        self.assertPayrollEqual(cats['EE_US_WA_LNI'], -(self.lni.rate_emp_withhold * hours_in_period))
+        self.assertPayrollEqual(cats['ER_US_WA_LNI'], -(self.lni.rate * hours_in_period) - cats['EE_US_WA_LNI'])
+
+        process_payslip(payslip)
+
+        # Make a new payslip, this one will have maximums
+
+        remaining_wa_unemp_wages = self.WA_UNEMP_MAX_WAGE - salary if (self.WA_UNEMP_MAX_WAGE - 2*salary < salary) \
+            else salary
+
+        self._log('2019 Washington tax second payslip:')
+        payslip = self._createPayslip(employee, '2019-02-01', '2019-02-28')
+        payslip.onchange_contract()
+        payslip.compute_sheet()
+
+        cats = self._getCategories(payslip)
+
+        self.assertPayrollEqual(cats['WAGE_US_WA_UNEMP'], remaining_wa_unemp_wages)
+        self.assertPayrollEqual(cats['ER_US_WA_UNEMP'], remaining_wa_unemp_wages * wa_unemp)

l10n_us_wa_hr_payroll/views/hr_payroll_views.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+    <data>
+        <record id="hr_contract_form_l10n_us_wa_inherit" model="ir.ui.view">
+            <field name="name">hr.contract.form.inherit</field>
+            <field name="model">hr.contract</field>
+            <field name="priority">148</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="Washington" name="wa">
+                        <field name="wa_lni" string="LNI"/>
+                    </group>
+                </xpath>
+            </data>
+            </field>
+        </record>
+    </data>
+</odoo>