[ADD] hr_payroll_overtime: for Odoo 13.0

hr_payroll_overtime/__init__.py

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

hr_payroll_overtime/__manifest__.py

@@ -0,0 +1,19 @@
+{
+    'name': 'Payroll Overtime',
+    'description': 'Provide mechanisms to calculate overtime.',
+    'version': '13.0.1.0.0',
+    'website': 'https://hibou.io/',
+    'author': 'Hibou Corp. <hello@hibou.io>',
+    'license': 'AGPL-3',
+    'category': 'Human Resources',
+    'data': [
+        'security/ir.model.access.csv',
+        'data/overtime_data.xml',
+        'views/hr_work_entry_views.xml',
+        'views/resource_calendar_views.xml',
+    ],
+    'depends': [
+        'hr_payroll',
+        'hr_work_entry',
+    ],
+}

hr_payroll_overtime/data/overtime_data.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+
+    <data noupdate="1">
+        <record id="work_entry_overtime_type" model="hr.work.entry.overtime.type">
+            <field name="name">Default Rules</field>
+            <field name="hours_per_week">40.0</field>
+            <field name="multiplier">1.5</field>
+        </record>
+    </data>
+
+</odoo>

hr_payroll_overtime/models/__init__.py

@@ -0,0 +1,3 @@
+from . import hr_payslip
+from . import hr_work_entry
+from . import resource_calendar

hr_payroll_overtime/models/hr_payslip.py

@@ -0,0 +1,106 @@
+from collections import defaultdict
+from odoo import models
+
+
+class HRPayslip(models.Model):
+    _inherit = 'hr.payslip'
+
+    def aggregate_overtime(self, work_data, day_week_start=None):
+        """
+
+        :param work_data: list(tuple(iso_date, list(tuple(hr.work.entry.type(), hours, original_record))
+        :param day_week_start: day of the week to start (otherwise employee's resource calendar start day of week)
+        :return: dict(hr.work.entry.type(): list(days_worked, hours_worked, ))
+        """
+        if not day_week_start:
+            if self.employee_id.resource_calendar_id.day_week_start:
+                day_week_start = self.employee_id.resource_calendar_id.day_week_start
+            else:
+                day_week_start = '1'
+        day_week_start = int(day_week_start)
+        if day_week_start < 1 or day_week_start > 7:
+            day_week_start = 1
+
+        def _adjust_week(isodate):
+            if isodate[2] < day_week_start:
+                return (isodate[0], isodate[1] + 1, isodate[2])
+            return isodate
+
+        result = defaultdict(lambda: [0.0, 0.0, 1.0])
+        day_hours = defaultdict(float)
+        week_hours = defaultdict(float)
+        iso_days = set()
+        for iso_date, entries in work_data:
+            iso_date = _adjust_week(iso_date)
+            week = iso_date[1]
+            for work_type, hours, _ in entries:
+                if work_type.overtime_work_type_id and work_type.overtime_type_id:
+                    ot_h_w = work_type.overtime_type_id.hours_per_week
+                    ot_h_d = work_type.overtime_type_id.hours_per_day
+                    if ot_h_d and (day_hours[iso_date] + hours) > ot_h_d:
+                        if day_hours[iso_date] >= ot_h_d:
+                            # no time is regular time
+                            if iso_date not in iso_days:
+                                iso_days.add(iso_date)
+                                result[work_type.overtime_work_type_id][0] += 1.0
+                            result[work_type.overtime_work_type_id][1] += hours
+                            result[work_type.overtime_work_type_id][2] = work_type.overtime_type_id.multiplier
+                        else:
+                            remaining_regular_hours = ot_h_d - day_hours[iso_date]
+                            if remaining_regular_hours - hours < 0.0:
+                                # some time is regular time
+                                regular_hours = remaining_regular_hours
+                                overtime_hours = hours - remaining_regular_hours
+                                if iso_date not in iso_days:
+                                    iso_days.add(iso_date)
+                                    result[work_type][0] += 1.0
+                                result[work_type][1] += regular_hours
+                                result[work_type.overtime_work_type_id][1] += overtime_hours
+                                result[work_type.overtime_work_type_id][2] = work_type.overtime_type_id.multiplier
+                            else:
+                                # all time is regular time
+                                if iso_date not in iso_days:
+                                    iso_days.add(iso_date)
+                                    result[work_type][0] += 1.0
+                                result[work_type][1] += hours
+                    elif ot_h_w:
+                        if week_hours[week] > ot_h_w:
+                            # no time is regular time
+                            if iso_date not in iso_days:
+                                iso_days.add(iso_date)
+                                result[work_type.overtime_work_type_id][0] += 1.0
+                            result[work_type.overtime_work_type_id][1] += hours
+                            result[work_type.overtime_work_type_id][2] = work_type.overtime_type_id.multiplier
+                        else:
+                            remaining_regular_hours = ot_h_w - week_hours[week]
+                            if remaining_regular_hours - hours < 0.0:
+                                # some time is regular time
+                                regular_hours = remaining_regular_hours
+                                overtime_hours = hours - remaining_regular_hours
+                                if iso_date not in iso_days:
+                                    iso_days.add(iso_date)
+                                    result[work_type][0] += 1.0
+                                result[work_type][1] += regular_hours
+                                result[work_type.overtime_work_type_id][1] += overtime_hours
+                                result[work_type.overtime_work_type_id][2] = work_type.overtime_type_id.multiplier
+                            else:
+                                # all time is regular time
+                                if iso_date not in iso_days:
+                                    iso_days.add(iso_date)
+                                    result[work_type][0] += 1.0
+                                result[work_type][1] += hours
+                    else:
+                        # all time is regular time
+                        if iso_date not in iso_days:
+                            iso_days.add(iso_date)
+                            result[work_type][0] += 1.0
+                        result[work_type][1] += hours
+                else:
+                    if iso_date not in iso_days:
+                        iso_days.add(iso_date)
+                        result[work_type][0] += 1.0
+                    result[work_type][1] += hours
+                # Always
+                day_hours[iso_date] += hours
+                week_hours[week] += hours
+        return result

hr_payroll_overtime/models/hr_work_entry.py

@@ -0,0 +1,21 @@
+from odoo import fields, models
+
+
+class HRWorkEntryType(models.Model):
+    _inherit = 'hr.work.entry.type'
+
+    overtime_work_type_id = fields.Many2one('hr.work.entry.type', string='Overtime Work Type')
+    overtime_type_id = fields.Many2one('hr.work.entry.overtime.type', string='Overtime Rules')
+
+
+class HRWorkEntryOvertime(models.Model):
+    _name = 'hr.work.entry.overtime.type'
+    _description = 'Overtime Rules'
+
+    name = fields.Char(string='Name')
+    hours_per_day = fields.Float(string='Hours/Day',
+                                 help='Number of hours worked in a single day to trigger overtime.')
+    hours_per_week = fields.Float(string='Hours/Week',
+                                  help='Number of hours worked in a week to trigger overtime.')
+    multiplier = fields.Float(string='Multiplier',
+                              help='Rate for when overtime is reached.')

hr_payroll_overtime/models/resource_calendar.py

@@ -0,0 +1,15 @@
+from odoo import fields, models
+
+
+class ResourceCalendar(models.Model):
+    _inherit = 'resource.calendar'
+
+    day_week_start = fields.Selection([
+        ('1', 'Monday'),
+        ('2', 'Tuesday'),
+        ('3', 'Wednesday'),
+        ('4', 'Thursday'),
+        ('5', 'Friday'),
+        ('6', 'Saturday'),
+        ('7', 'Sunday'),
+    ], string='Day Week Starts', required=True, default='1')

hr_payroll_overtime/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_work_entry_overtime_type,access_hr_work_entry_overtime_type,model_hr_work_entry_overtime_type,base.group_user,1,0,0,0
+manage_hr_work_entry_overtime_type,manage_hr_work_entry_overtime_type,model_hr_work_entry_overtime_type,hr_payroll.group_hr_payroll_manager,1,1,1,1

hr_payroll_overtime/tests/__init__.py

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

hr_payroll_overtime/tests/test_overtime.py

@@ -0,0 +1,271 @@
+from odoo.tests import common
+
+
+class TestOvertime(common.TransactionCase):
+
+    def setUp(self):
+        super().setUp()
+        self.overtime_rules = self.env['hr.work.entry.overtime.type'].create({
+            'name': 'Test',
+            'hours_per_week': 40.0,
+            'multiplier': 1.5,
+        })
+        self.work_type_overtime = self.env['hr.work.entry.type'].create({
+            'name': 'Test Overtime',
+            'code': 'TEST_OT'
+        })
+        self.work_type = self.env['hr.work.entry.type'].create({
+            'name': 'Test',
+            'code': 'TEST',
+            'overtime_type_id': self.overtime_rules.id,
+            'overtime_work_type_id': self.work_type_overtime.id,
+        })
+        self.employee = self.env.ref('hr.employee_hne')
+        self.payslip = self.env['hr.payslip'].create({
+            'name': 'test slip',
+            'employee_id': self.employee.id,
+            'date_from': '2020-06-11',
+            'date_to': '2020-06-15',
+        })
+
+    def test_02_overtime_aggregation(self):
+        # 38 hours in 1 week
+        work_data = [
+            ((2020, 24, 1), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 4.0, None),
+            ]),
+            ((2020, 24, 2), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+            ((2020, 24, 3), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+            ((2020, 24, 4), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+        ]
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertTrue(self.work_type_overtime not in result_data)
+        self.assertEqual(result_data[self.work_type][0], 4)
+        self.assertEqual(result_data[self.work_type][1], 38.0)
+
+        # 48 hours in 1 week
+        work_data += [
+            ((2020, 24, 5), [
+                (self.work_type, 10.0, None),
+            ]),
+        ]
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertEqual(result_data[self.work_type][0], 5)
+        self.assertEqual(result_data[self.work_type][1], 40.0)
+        self.assertTrue(self.work_type_overtime in result_data)
+        self.assertEqual(result_data[self.work_type_overtime][0], 0)
+        self.assertEqual(result_data[self.work_type_overtime][1], 8.0)
+
+        # 52 hours in 1 week
+        work_data += [
+            ((2020, 24, 6), [
+                (self.work_type, 4.0, None),
+            ]),
+        ]
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertEqual(result_data[self.work_type][0], 5)
+        self.assertEqual(result_data[self.work_type][1], 40.0)
+        self.assertTrue(self.work_type_overtime in result_data)
+        self.assertEqual(result_data[self.work_type_overtime][0], 1)
+        self.assertEqual(result_data[self.work_type_overtime][1], 12.0)
+
+        # reset and make two weeks
+        # 38 hours in 1 week x 2
+        input_work_data = [
+            ((2020, 24, 1), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 4.0, None),
+            ]),
+            ((2020, 24, 2), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+            ((2020, 24, 3), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+            ((2020, 24, 4), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+        ]
+        work_data = []
+        for data in input_work_data:
+            work_data.append(data)
+            work_data.append(((data[0][0], data[0][1]+1, data[0][2]), data[1]))
+
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertTrue(self.work_type_overtime not in result_data)
+        self.assertEqual(result_data[self.work_type][0], 8)
+        self.assertEqual(result_data[self.work_type][1], 76.0)
+
+        # 48 hours in 1 week, 38 hours in 1 week
+        work_data += [
+            ((2020, 24, 5), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+        ]
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertEqual(result_data[self.work_type][0], 9)
+        self.assertEqual(result_data[self.work_type][1], 78.0)
+        self.assertTrue(self.work_type_overtime in result_data)
+        self.assertEqual(result_data[self.work_type_overtime][0], 0)
+        self.assertEqual(result_data[self.work_type_overtime][1], 8.0)
+
+        # 52 hours in 1 week, 38 hours in 1 week
+        work_data += [
+            ((2020, 24, 6), [
+                (self.work_type, 4.0, None),
+            ]),
+        ]
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertEqual(result_data[self.work_type][0], 9)
+        self.assertEqual(result_data[self.work_type][1], 78.0)
+        self.assertTrue(self.work_type_overtime in result_data)
+        self.assertEqual(result_data[self.work_type_overtime][0], 1)
+        self.assertEqual(result_data[self.work_type_overtime][1], 12.0)
+
+    def test_03_overtime_aggregation_week_start(self):
+        self.employee.resource_calendar_id.day_week_start = '7'
+        self.test_02_overtime_aggregation()
+
+    def test_10_overtime_aggregation_daily(self):
+        self.overtime_rules.hours_per_day = 8.0
+        self.overtime_rules.multiplier_per_day = 1.5
+        # 38 hours in 1 week
+        work_data = [
+            ((2020, 24, 1), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 4.0, None),
+            ]),
+            ((2020, 24, 2), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+            ((2020, 24, 3), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+            ((2020, 24, 4), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+        ]
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertEqual(result_data[self.work_type][0], 4)
+        self.assertEqual(result_data[self.work_type][1], 32.0)
+        self.assertTrue(self.work_type_overtime in result_data)
+        self.assertEqual(result_data[self.work_type_overtime][0], 0)
+        self.assertEqual(result_data[self.work_type_overtime][1], 6.0)
+
+        # 48 hours in 1 week
+        work_data += [
+            ((2020, 24, 5), [
+                (self.work_type, 10.0, None),
+            ]),
+        ]
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertEqual(result_data[self.work_type][0], 5)
+        self.assertEqual(result_data[self.work_type][1], 40.0)
+        self.assertTrue(self.work_type_overtime in result_data)
+        self.assertEqual(result_data[self.work_type_overtime][0], 0)
+        self.assertEqual(result_data[self.work_type_overtime][1], 8.0)
+
+        # 52 hours in 1 week
+        work_data += [
+            ((2020, 24, 6), [
+                (self.work_type, 4.0, None),
+            ]),
+        ]
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertEqual(result_data[self.work_type][0], 5)
+        self.assertEqual(result_data[self.work_type][1], 40.0)
+        self.assertTrue(self.work_type_overtime in result_data)
+        self.assertEqual(result_data[self.work_type_overtime][0], 1)
+        self.assertEqual(result_data[self.work_type_overtime][1], 12.0)
+
+        # reset and make two weeks
+        # 38 hours in 1 week x 2
+        input_work_data = [
+            ((2020, 24, 1), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 4.0, None),
+            ]),
+            ((2020, 24, 2), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+            ((2020, 24, 3), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+            ((2020, 24, 4), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+        ]
+        work_data = []
+        for data in input_work_data:
+            work_data.append(data)
+            work_data.append(((data[0][0], data[0][1]+1, data[0][2]), data[1]))
+
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertTrue(self.work_type_overtime in result_data)
+        self.assertEqual(result_data[self.work_type][0], 8)
+        self.assertEqual(result_data[self.work_type][1], 64.0)
+        self.assertEqual(result_data[self.work_type_overtime][0], 0)
+        self.assertEqual(result_data[self.work_type_overtime][1], 12.0)
+
+        # 48 hours in 1 week, 38 hours in 1 week
+        work_data += [
+            ((2020, 24, 5), [
+                (self.work_type, 4.0, None),
+                (self.work_type, 6.0, None),
+            ]),
+        ]
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertEqual(result_data[self.work_type][0], 9)
+        self.assertEqual(result_data[self.work_type][1], 70.0)
+        self.assertTrue(self.work_type_overtime in result_data)
+        self.assertEqual(result_data[self.work_type_overtime][0], 0)
+        self.assertEqual(result_data[self.work_type_overtime][1], 16.0)
+
+        # 52 hours in 1 week, 38 hours in 1 week
+        work_data += [
+            ((2020, 24, 6), [
+                (self.work_type, 4.0, None),
+            ]),
+        ]
+        result_data = self.payslip.aggregate_overtime(work_data)
+        self.assertTrue(self.work_type in result_data)
+        self.assertEqual(result_data[self.work_type][0], 9)
+        self.assertEqual(result_data[self.work_type][1], 70.0)
+        self.assertTrue(self.work_type_overtime in result_data)
+        self.assertEqual(result_data[self.work_type_overtime][0], 1)
+        self.assertEqual(result_data[self.work_type_overtime][1], 20.0)
+
+    def test_11_overtime_aggregation_daily_week_start(self):
+        self.employee.resource_calendar_id.day_week_start = '7'
+        self.test_10_overtime_aggregation_daily()

hr_payroll_overtime/views/hr_work_entry_views.xml

@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+
+    <!-- Work Entry Type -->
+    <record id="hr_work_entry_type_view_form_inherit" model="ir.ui.view">
+        <field name="name">hr.work.entry.type.form.inherit</field>
+        <field name="model">hr.work.entry.type</field>
+        <field name="inherit_id" ref="hr_work_entry.hr_work_entry_type_view_form"/>
+        <field name="arch" type="xml">
+            <xpath expr="//group[@name='main_group']" position="after">
+                <group name="overtime_group">
+                    <field name="overtime_work_type_id" attrs="{'required': [('overtime_type_id', '!=', False)]}"/>
+                    <field name="overtime_type_id" attrs="{'required': [('overtime_work_type_id', '!=', False)]}"/>
+                </group>
+            </xpath>
+        </field>
+    </record>
+    
+    <!-- Work Entry Overtime Type -->
+    <record id="hr_work_entry_overtime_type_tree" model="ir.ui.view">
+        <field name="name">hr.work.entry.overtime.type.tree</field>
+        <field name="model">hr.work.entry.overtime.type</field>
+        <field name="arch" type="xml">
+            <tree string="Overtime Rules" editable="bottom">
+                <field name="name"/>
+                <field name="hours_per_day"/>
+                <field name="hours_per_week"/>
+                <field name="multiplier"/>
+            </tree>
+        </field>
+    </record>
+
+    <record id="hr_work_entry_overtime_type_search" model="ir.ui.view">
+        <field name="name">hr.work.entry.overtime.type.search</field>
+        <field name="model">hr.work.entry.overtime.type</field>
+        <field name="arch" type="xml">
+            <search string="Overtime Rules Search">
+                <field name="name"/>
+            </search>
+        </field>
+    </record>
+
+    <record id="hr_work_entry_overtime_type_action_main" model="ir.actions.act_window">
+        <field name="name">Overtime Rules</field>
+        <field name="res_model">hr.work.entry.overtime.type</field>
+        <field name="view_mode">tree,form</field>
+        <field name="help" type="html">
+            <p>
+                No Overtime Rules
+            </p>
+        </field>
+    </record>
+
+    <menuitem id="hr_work_entry_overtime_type_menu_main" name="Overtime Rules"
+              action="hr_work_entry_overtime_type_action_main"
+              sequence="11" parent="hr_payroll.menu_hr_work_entry_confirguration"/>
+
+</odoo>

hr_payroll_overtime/views/resource_calendar_views.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+
+    <record id="resource_calendar_form_inherit" model="ir.ui.view">
+        <field name="name">resource.calendar.form.inherit</field>
+        <field name="model">resource.calendar</field>
+        <field name="inherit_id" ref="resource.resource_calendar_form"/>
+        <field name="arch" type="xml">
+            <xpath expr="//field[@name='tz']" position="after">
+                <field name="day_week_start"/>
+            </xpath>
+        </field>
+    </record>
+
+</odoo>