Hong Kong IR56 Series
IR56B / IR56E / IR56F / IR56G employer's return data and IRD e-filing XML — straight from your Hong Kong payroll
Build the full Inland Revenue Department (IRD) IR56 series in Odoo. The annual IR56B return is assembled by aggregating a year of Hong Kong payroll runs into one record per employee; the IR56E (new hire), IR56F (cessation) and IR56G (departure from Hong Kong) notifications are one-click. Export the computerised Employer's Return data file (XML) and a review CSV, then upload through the IRD's own Employer's Return e-Filing Services with your own credentials — nothing is transmitted by the module.
IR56B from a year of payroll
An annual-return batch pulls every payroll run in the year of assessment (1 Apr → 31 Mar) and aggregates each employee's salary, allowances, bonus / end-of-year payment, statutory 713 leave pay, back pay and MPF into a single record. The record count and grand total match the BIR56A control form you sign.
IR56E / F / G notifications
Notify the IRD of a new employee (IR56E), an employee about to cease employment (IR56F) or an employee about to depart Hong Kong (IR56G) - including the money-withheld field held back pending the IRD's letter of release. A quick wizard pre-fills the form from the employee record.
Real IRD data-file XML
A pure-Python builder renders a well-formed envelope: a control block
carrying the employer file number, year of assessment, record count and
grand total, one EmployeeRecord per person with the income
breakdown, and the series-specific cessation / departure blocks. The XML
namespace and software-provider tag are editable so the file can track
IRD schema revisions without a code change.
Correct income classification
Payroll components are mapped to the IRD income types — Salary/Wages, Leave Pay, Commission/Fees, Bonus, Back Pay/Gratuities, Allowances, Pensions and Share Option Gain — and the reportable total is computed for you. Capacity (employee / director), marital status, spouse and place-of-residence (quarters) fields are captured per record.
HKID validation built in
Every HKID on a record or notification is checked with the genuine
weighted modulo-11 check digit, so mistyped identity-card numbers are
caught before the return is filed. The canonical
LLNNNNNN(C) form is written into the data file.
BYOK — you file, with your credentials
The module produces the return and data files locally and never transmits anything. You upload through the IRD's Employer's Return e-Filing Services / GovHK channel yourself. Employer-identity defaults (file number, signer, designation, XML namespace) live on the company and are fully editable.
Built on Hong Kong Payroll MPF
This module depends on Hong Kong Payroll MPF
(l10n_hk_payroll) and reuses its payslip models and HKID
validator. Run your Hong Kong payroll there, then assemble and file the
IR56 series here. The pure-Python computation engine is fully unit
tested.
Compatible with Odoo 18 and Odoo 19 (Community). Confirm the current IRD data-file specification and filing thresholds against official IRD guidance before filing.
Screenshots
Generated Ir56B Annual Retur
Ir56E New Employee Notificat
Update date: 2026-07-02