Files
enterprise-addons/l10n_hk_hr_payroll/models/l10n_hk_ir56b.py
T

221 lines
9.6 KiB
Python

# Part of Odoo. See LICENSE file for full copyright and licensing details.
import base64
from codecs import BOM_UTF8
from collections import defaultdict
from lxml.html import etree
from odoo import api, fields, models
from odoo.exceptions import UserError
from odoo.fields import Command
from odoo.tools import format_date
class L10n_HkIr56b(models.Model):
_name = 'l10n_hk.ir56b'
_inherit = ['l10n_hk.ird']
_description = 'IR56B Sheet'
_order = 'start_period'
type_of_form = fields.Selection(selection_add=[('S', "Supplementary")], ondelete={'S': 'cascade'})
@api.depends('xml_file')
def _compute_validation_state(self):
annual_xsd_schema_file_path = self._get_xml_resource('ir56b_annual.xsd')
extra_xsd_schema_file_path = self._get_xml_resource('ir56b_additional_replacement_supplementary.xsd')
annual_xsd_root = etree.parse(annual_xsd_schema_file_path)
extra_xsd_root = etree.parse(extra_xsd_schema_file_path)
annual_schema = etree.XMLSchema(annual_xsd_root)
extra_schema = etree.XMLSchema(extra_xsd_root)
no_xml_file_records = self.filtered(lambda record: not record.xml_file)
no_xml_file_records.update({
'xml_validation_state': 'normal',
'error_message': False,
})
for record in self - no_xml_file_records:
xml_root = etree.fromstring(base64.b64decode(record.xml_file))
schema = annual_schema if record.type_of_form == 'O' else extra_schema
try:
schema.assertValid(xml_root)
record.xml_validation_state = 'done'
except etree.DocumentInvalid as err:
record.xml_validation_state = 'invalid'
record.error_message = str(err)
def action_generate_declarations(self):
for sheet in self:
all_payslips = self.env['hr.payslip'].search([
('state', 'in', ['validated', 'paid']),
('company_id', '=', sheet.company_id.id),
('date_from', '>=', sheet.start_period),
('date_to', '<=', sheet.end_period),
])
valid_employees = all_payslips.employee_id.filtered(lambda e: e.is_in_contract)
line_item_values = []
# Due to the usage of Many2oneReference, we cannot rely on Command.Clear to unlink the values.
sheet.line_ids.unlink()
for employee in valid_employees:
line_item_values.append(Command.create({
'employee_id': employee.id,
'res_model': 'l10n_hk.ir56b',
'res_id': sheet.id,
}))
sheet.line_ids = line_item_values
return super().action_generate_declarations()
@api.depends('start_period', 'end_period')
def _compute_display_name(self):
lang_code = self.env.user.lang or 'en_US'
for sheet in self:
if sheet.start_period and sheet.end_period:
sheet.display_name = sheet.env._(
"From %(start_period)s to %(end_period)s",
start_period=format_date(self.env, sheet.start_period, date_format="MMMM y", lang_code=lang_code),
end_period=format_date(self.env, sheet.end_period, date_format="MMMM y", lang_code=lang_code),
)
else:
sheet.display_name = sheet.env._("IR56B Sheet")
def _get_rendering_data(self, employees):
self.ensure_one()
employees_error = self._check_employees(employees)
if employees_error:
return {'error': employees_error}
report_info = self._get_report_info_data()
try:
payslip_info = self._get_employees_payslip_data(employees)
except UserError as e:
return {'error': str(e)}
all_payslips = payslip_info['all_payslips']
employee_payslips = defaultdict(lambda: self.env['hr.payslip'])
for payslip in all_payslips:
employee_payslips[payslip.employee_id] |= payslip
line_codes = ['BASIC', 'COMMISSION', 'REFERRAL_FEE', 'END_OF_YEAR_PAYMENT', 'BACKPAY', 'ALW.INT', 'HRA', 'MPF_GROSS', 'EEMC', 'ERMC', 'EEVC', 'ERVC', 'GLOBAL_REIMBURSEMENT', 'GLOBAL_DEDUCTION']
all_line_values = all_payslips._get_line_values(line_codes, vals_list=['total', 'quantity'])
sequence = 0
employees_data = []
for employee in employee_payslips:
payslips = employee_payslips[employee]
sequence += 1
mapped_total = {
code: sum(all_line_values[code][p.id]['total'] for p in payslips)
for code in line_codes}
start_date = self.start_period if self.start_period > employee._get_first_version_date() else employee._get_first_version_date()
rental_ids = employee.l10n_hk_rental_ids.filtered_domain([
('state', 'in', ['open', 'close']),
('date_start', '<=', self.end_period),
'|', ('date_end', '>', start_date), ('date_end', '=', False),
]).sorted('date_start')
sheet_values = {
**self._get_employee_data(employee),
**self._get_employee_spouse_data(employee),
'date_from': self.start_period,
'date_to': self.end_period,
'SheetNo': sequence,
'TypeOfForm': self.type_of_form,
'RTN_ASS_YR': self.end_year,
'StartDateOfEmp': start_date,
'EndDateOfEmp': self.end_period,
'AmtOfSalary': int(mapped_total['BASIC'] + mapped_total['GLOBAL_REIMBURSEMENT'] + mapped_total['GLOBAL_DEDUCTION']),
'AmtOfCommFee': int(mapped_total['COMMISSION']) + int(mapped_total['REFERRAL_FEE']),
'AmtOfBonus': int(mapped_total['END_OF_YEAR_PAYMENT']),
'AmtOfBpEtc': int(mapped_total['BACKPAY']),
'NatureOtherRAP1': 'Internet Allowance' if int(mapped_total['ALW.INT']) else '',
'AmtOfOtherRAP1': int(mapped_total['ALW.INT']),
'TotalIncome': int(mapped_total['MPF_GROSS'] - mapped_total['HRA']),
'PlaceOfResInd': int(bool(rental_ids)),
'AddrOfPlace1': '',
'NatureOfPlace1': '',
'PerOfPlace1': '',
'RentPaidEe1': 0,
'RentRefund1': 0,
'AddrOfPlace2': '',
'NatureOfPlace2': '',
'PerOfPlace2': '',
'RentPaidEe2': 0,
'RentRefund2': 0,
'AmtOfEEMC': int(mapped_total['EEMC']),
'AmtOfERMC': int(mapped_total['ERMC']),
'AmtOfEEVC': int(mapped_total['EEVC']),
'AmtOfERVC': int(mapped_total['ERVC']),
}
for count, rental in enumerate(rental_ids):
payslips_rental = payslips.filtered_domain([
('date_from', '>=', rental.date_start),
('date_to', '<=', rental.date_end or self.end_period),
])
date_start_rental = rental.date_start if rental.date_start > start_date else start_date
date_end_rental = rental.date_end or self.end_period
date_start_rental_str = date_start_rental.strftime('%Y%m%d') if date_start_rental else ''
date_end_rental_str = date_end_rental.strftime('%Y%m%d') if date_end_rental else ''
period_rental_str = '{} - {}'.format(date_start_rental_str, date_end_rental_str)
amount_rental = sum(all_line_values['HRA'][p.id]['total'] for p in payslips_rental)
sheet_values.update({
'AddrOfPlace%s' % (count + 1): rental.address,
'NatureOfPlace%s' % (count + 1): rental.nature,
'PerOfPlace%s' % (count + 1): period_rental_str,
'RentPaidEe%s' % (count + 1): int(amount_rental),
'RentRefund%s' % (count + 1): int(amount_rental),
})
employees_data.append(sheet_values)
sheets_count = len(employees_data)
total_data = {
'NoRecordBatch': '{:05}'.format(sheets_count),
'TotIncomeBatch': int(sum(ed['TotalIncome'] for ed in employees_data)),
}
return {'data': report_info, 'employees_data': employees_data, 'total_data': total_data}
def action_generate_xml(self):
self.ensure_one()
self.xml_filename = f'IR56B_-_{self.start_year}.xml'
data = self._get_rendering_data(self.line_ids.employee_id)
if 'error' in data:
raise UserError(data['error'])
xml_str = self.env['ir.qweb']._render('l10n_hk_hr_payroll.ir56b_xml_report', data)
# Prettify xml string
root = etree.fromstring(xml_str, parser=etree.XMLParser(remove_blank_text=True))
xml_formatted_str = etree.tostring(root, pretty_print=True, encoding='UTF-8', xml_declaration=True, standalone=True)
# Make sure to include BOMs as per the requirements to upload to the IRD platform.
self.xml_file = base64.encodebytes(BOM_UTF8 + xml_formatted_str)
self.state = 'waiting'
def _get_pdf_report(self):
return self.env.ref('l10n_hk_hr_payroll.action_report_employee_ir56b')
def _get_pdf_filename(self, employee):
self.ensure_one()
return self.env._('%(employee_name)s_-_IR56B_-_%(start_year)s', employee_name=employee.name, start_year=self.start_year)
def _post_process_rendering_data_pdf(self, rendering_data):
result = {}
for sheet_values in rendering_data['employees_data']:
result[sheet_values['employee']] = {**sheet_values, **rendering_data['data']}
return result