Employment Hero New Zealand
The New Zealand layer for the Employment Hero connector: IRD number, PAYE tax code, and KiwiSaver rate on the employee, mapped into the sync engine.
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
The three New Zealand identifiers that payroll needs
Adds the IRD number, PAYE tax code, and KiwiSaver contribution rate to hr.employee. The IRD number and tax code are access restricted to HR users through the standard Odoo group, so a national id is never exposed on a record an ordinary user can read.
The fields feed off the live sync
Each field is registered as a mapping line on the shared employee mapping. When the connector pulls an employee, these values are written by the same external-id keyed, idempotent engine that handles name, email, and department, with no extra job to schedule.
Source paths you can retune in place
The mapping source paths ship with noupdate set, so a deployment adjusts them to match the exact shape of its own Employment Hero payload, and a later module upgrade will not overwrite that change.
Day in the life
A New Zealand employee syncs in with their statutory details
The HR sync job pulls the employee list from Employment Hero on its schedule. For each record the engine resolves the external id, applies the conflict policy, and writes the mapped fields in its own savepoint. With this pack installed, that same write now also lands the IRD number, the PAYE tax code, and the KiwiSaver rate onto the New Zealand employee, the two national id fields visible only to HR users. An operator opens the employee form, sees the Employment Hero (New Zealand) group under HR Settings populated, and has the local detail a payroll process needs without retyping it. If the organisation's payload names a field differently, the operator edits the mapping line source path once and the next run picks it up.
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.
Sync is keyed by external id through the engine cross-reference, so re-running a job or replaying the same employee does not duplicate the record. The New Zealand fields are simply rewritten to the same values.
The shared HTTP client retries only transient failures and rate-limit responses with exponential backoff plus jitter, honouring a Retry-After header up to a safe ceiling, so a busy New Zealand employee pull does not turn into a request storm.
Each employee is written inside its own savepoint. A single bad record, for example one whose mapped value violates a constraint, is logged and skipped without rolling back the rest of the batch.
A mapping line set to skip on empty leaves the existing value untouched when Employment Hero returns nothing for that field, so a blank IRD number in the payload does not wipe a populated one in Odoo.
Source paths ship as sensible defaults with noupdate set. If an organisation's payload uses a different key for the IRD number, tax code, or KiwiSaver rate, the path is retuned on the mapping line and survives upgrades.
The connection model supplies a lazy OAuth refresh callback, so a long pull that outlives an access token transparently refreshes it rather than failing mid-batch.
Employee pulls are paginated by the engine, so an organisation with many New Zealand employees is fetched page by page rather than in a single unbounded request.
The sync job carries a company and resolves the connection for that company, so the New Zealand fields are populated from the connection that belongs to the right company in a multi-company database.
What is inside
Built to do the job, end to end.
- One New Zealand country profile. A single eh.country.profile record linked to the New Zealand country with the stable code NZ, the anchor a deployment reads to see that the New Zealand localisation is active. Tracked on the mail thread.
- Three employee fields. eh_ird_number (IRD Number) and eh_tax_code (PAYE Tax Code) restricted to the HR user group, plus eh_kiwisaver_rate (KiwiSaver Rate) on hr.employee, shown in an Employment Hero (New Zealand) group under HR Settings.
- Three mapping lines. Each field is registered as an eh.mapping.line on the shared HR employee mapping, with source paths ird_number, tax_code, and kiwisaver_rate, all shipped with noupdate so a deployment can retune them.
- Tests. Bundled tests assert the New Zealand profile resolves to the correct country and code, and that the IRD number field is present on the employee model.
Honest about the edges
What this does not do, so nothing surprises you.
- This is a field and mapping pack, not a payroll engine. It does not calculate PAYE, KiwiSaver, or any New Zealand statutory deduction, and it does not file with Inland Revenue.
- It contains no sync engine, queue worker, or webhook endpoint of its own. It relies entirely on the connector base and HR layer it depends on for transport, scheduling, and conflict handling.
- The IRD number, tax code, and KiwiSaver rate are stored as plain text fields. There is no checksum or format validation on the IRD number, and no masking beyond the HR group restriction on the two national id fields.
- The mapping source paths are defaults aimed at a typical Employment Hero payload. They are not guaranteed to match every organisation's field names and may need retuning before the New Zealand fields populate.
- The fields are written on the inbound pull. This pack adds no New Zealand-specific push of these values back to Employment Hero.
- Requires the Employment Hero connector base and HR modules from this suite, plus a configured connection. It does nothing on its own.
- Targets Odoo 18 Community. It is not tested or supported on other major versions from this package.
Employment Hero New Zealand, Employment Hero Odoo connector, NZ payroll integration Odoo, IRD number Odoo employee, KiwiSaver rate field, PAYE tax code Odoo, New Zealand HR localisation Odoo 18, eh.country.profile, employee data sync New Zealand, Odoo 18 Community HR integration, hr.employee New Zealand fields, people platform connector Odoo
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 18 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 | 4155 |
| 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