| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Discuss (mail)
• Employees (hr) |
| Community Apps Dependencies | Show |
| Lines of code | 2307 |
| Technical Name |
l10n_hk_ir56_series |
| License | OPL-1 |
| Website | https://gencbaris.com/odoo_plugins/ |
| Versions | 18.0 19.0 |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Discuss (mail)
• Employees (hr) |
| Community Apps Dependencies | Show |
| Lines of code | 2307 |
| Technical Name |
l10n_hk_ir56_series |
| License | OPL-1 |
| Website | https://gencbaris.com/odoo_plugins/ |
| Versions | 18.0 19.0 |
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.
Odoo Proprietary License v1.0 This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file). You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one). It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software. The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module