Employment Hero New Zealand
The New Zealand localisation for your Employment Hero connector: IRD number, PAYE tax code, and KiwiSaver rate on the employee, wired into the field mapping.
Store price is USD 175 all-in: installing this also pulls the 4 paid ERP Heritage modules it depends on.
Why this module
Employment Hero New Zealand
New Zealand fields where payroll expects them
Adds the IRD number, the PAYE tax code, and the KiwiSaver rate to the employee record, surfaced under the HR Settings page so the New Zealand identifiers sit alongside the rest of the employment data.
Mapped to the connector, not bolted on
Three mapping lines extend the base employee mapping so the connector reads the New Zealand source paths into the new fields on pull. Mapping is data, so which payload key feeds which field is configurable, not hard coded.
Sensitive identifiers kept to HR
The IRD number and the PAYE tax code are restricted to HR users at the field level, so a national tax identifier is not readable by every back office user who can open an employee form.
Day in the life
A New Zealand employee syncs in
The connector pulls an employee from Employment Hero. Its mapper walks the payload, and because this pack registered the New Zealand mapping lines, the IRD number, the PAYE tax code, and the KiwiSaver rate are read from their source paths and written onto the employee. If a value is absent the line skips it rather than overwriting good data with a blank. The IRD number and tax code show only to HR users. The New Zealand profile sits in the country profile list so an operator can confirm at a glance that the localisation is installed and active.
Edge cases
The cases most modules quietly ignore.
In the shipped code today, each one a place where a cheaper module silently does the wrong thing.
Mapping lines default to skip if empty, so a missing IRD number, tax code, or KiwiSaver rate in the payload leaves the existing Odoo value untouched instead of clearing it.
The mapping source paths ship with no update set, so you can repoint them at the exact key in your Employment Hero payload from the user interface without a code change or losing the edit on upgrade.
The connector resolves dotted source paths, so a New Zealand field buried inside a nested object in the payload still reads through to the employee field without bespoke parsing.
The connector's mapper drops display masks and the key unavailable placeholder before any push, so a restricted identifier rendered as a mask in Odoo can never overwrite the real upstream value.
A unique constraint guarantees exactly one New Zealand profile, so reinstalling or reloading data cannot create a duplicate country entry.
The IRD number and PAYE tax code carry an HR user group, so users without HR rights do not see the values even though the fields exist on the model.
What is inside
Built to do the job, end to end.
- Employee fields. Adds eh_ird_number and eh_tax_code, both restricted to the HR user group, and eh_kiwisaver_rate, on hr.employee, shown in a New Zealand group under the HR Settings page of the employee form.
- Country profile. Registers one eh.country.profile for New Zealand with the stable code NZ, linked to the base New Zealand country, and protected by a unique per country constraint.
- Mapping lines. Ships three eh.mapping.line records that extend the base employee mapping, pointing the ird_number, tax_code, and kiwisaver_rate source paths at the new fields, all marked no update so deployments can tune them.
- Tests. Includes tests that assert the New Zealand profile resolves to the correct country and code and that the IRD field is present on the employee model after install.
Honest about the edges
What this does not do, so nothing surprises you.
- This is a localisation pack, not the connector. The sync engine, webhook handling, queue, and retry logic live in the Employment Hero connector modules it depends on. It will not move data on its own.
- It adds and maps three New Zealand fields, the IRD number, the PAYE tax code, and the KiwiSaver rate. It does not calculate PAYE, run KiwiSaver deductions, file with Inland Revenue, or perform any payroll computation.
- The shipped mapping lines are pull direction defaults aligned to a typical Employment Hero employee payload. The exact source paths are tunable and should be confirmed against your own payload shape.
- Built for Odoo 17 Community. It depends on the Employment Hero country base and HR connector modules and is not a standalone install.
- It does not add a New Zealand chart of accounts, tax settings, or any general accounting localisation. Its scope is the Employment Hero employee identifiers.
Employment Hero New Zealand Odoo, Odoo 17 Employment Hero connector, IRD number Odoo, PAYE tax code Odoo, KiwiSaver Odoo, New Zealand payroll integration Odoo, hr.employee New Zealand fields, Employment Hero country pack, Odoo HR New Zealand localisation, data driven field mapping Odoo, ERP Heritage Employment Hero, Inland Revenue number employee
Need this fitted to the way you work?
ERP Heritage delivers end to end Odoo work: Odoo Implementation, Customization and Development, Integration, Migration, Consultation, Support and Training. We help teams put this module into production, shape it to their process, and keep it running.
We work with businesses across Australia (Melbourne, Sydney, Brisbane, Perth, Adelaide, Canberra) and the Middle East (Dubai, Abu Dhabi, Riyadh, Jeddah, Doha, Kuwait City, Muscat). Start a conversation at erpheritage.com.au or email info@erpheritage.com.au.
Languages
Available in 19 languages
The interface ships translated out of the box. Switch language in Odoo and the fields, menus, and messages follow.
Modules teams pair with this one.
Premium ERP Heritage modules that extend the same stack, each built to the same engineering bar.
Sync attendance clock events from the Employment Hero people platform into the stock Odoo Attendances app, keyed...
The United Kingdom country pack for the ERP Heritage Employment Hero integration
Sync Employment Hero employees, departments and payroll bank details into standard Odoo Community HR over the pla...
Inbound webhook receiver for the Employment Hero people and payroll platform on Odoo 17 Community
Real-time fiscalisation of customer invoices and credit notes with the Mauritius Revenue Authority e-Invoicing (E...
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Discuss (mail)
• Employees (hr) |
| Community Apps Dependencies | Show |
| Lines of code | 4171 |
| Technical Name |
eh_hero_country_nz |
| License | OPL-1 |
| Website | https://www.erpheritage.com.au/ |
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