| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Discuss (mail)
• Employees (hr) |
| Community Apps Dependencies | Show |
| Lines of code | 4128 |
| Technical Name |
eh_hero_country_uk |
| License | OPL-1 |
| Website | https://www.erpheritage.com.au/ |
| Versions | 16.0 17.0 18.0 19.0 |
Employment Hero UK
The United Kingdom country pack that gives the Employment Hero connector the local payroll identifiers a UK workforce needs.
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 UK
The three UK fields, on the employee record
Adds National Insurance Number, PAYE Tax Code and Student Loan Plan to hr.employee. The two sensitive identifiers are restricted to HR users; all three live in a dedicated United Kingdom group on the employee form.
Maps to the connector without code
Ships one mapping line per field over the shared employee mapping. Source paths into the Employment Hero payload are sensible defaults you can retune from the user interface, so you adapt to your tenant's shape without a deployment.
A blank upstream value never overwrites
Each mapping line skips an empty source value rather than writing it, so a missing field on the people platform leaves the value already held in Odoo intact. The sensitive identifiers stay behind the HR user group.
Day in the life
A UK employee syncs from the people platform
HR runs the employee sync job from the connector. For each record the engine reads the mapping lines this pack added, digs the National Insurance number, PAYE tax code and student loan plan out of the incoming payload, and writes them to the matching Odoo fields. Empty values are skipped, so a record with no tax code yet keeps whatever Odoo already holds. Because the upsert matches on the external id cross reference, running the job again updates the same employee instead of creating a duplicate. An HR user opens the employee, sees the United Kingdom group on HR Settings populated, and the two sensitive identifiers are hidden from non HR staff.
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.
The sync upserts against an external id cross reference in the engine this pack feeds, so running the employee job twice updates the same UK record rather than duplicating it.
Mapping lines default to skip when empty, so a blank National Insurance number, tax code or student loan plan in the payload does not overwrite a value already stored in Odoo.
Source paths are read with a dotted path reader, so a field nested inside the Employment Hero payload resolves without bespoke parsing, and a missing path simply yields nothing rather than erroring.
If your tenant returns these fields under different keys, the three source paths are editable from the user interface (shipped with noupdate so your edits survive upgrades) without touching code.
National Insurance Number and PAYE Tax Code are bound to the HR user group, so non HR users never see them on the employee form or in exports.
On a write back, the engine drops a display mask or key unavailable placeholder before it leaves, so a masked identifier can never overwrite the real upstream value.
What is inside
Built to do the job, end to end.
- Three UK employee fields. eh_ni_number (National Insurance Number) and eh_paye_tax_code (PAYE Tax Code, for example 1257L), both restricted to the HR user group, plus eh_student_loan_plan (Plan 1, 2, 4 or Postgraduate), added by inheriting hr.employee.
- UK country profile. One eh.country.profile record for the United Kingdom (code UK), registered in the suite's shared registry so a deployment can see the localisation is active and point sync jobs at the UK variant.
- Three mapping lines. One eh.mapping.line per field over the shared employee mapping, each with a default source path and target field, shipped noupdate so your retuning is preserved across updates.
- Employee form group. A view extension placing the three fields in an Employment Hero (United Kingdom) group on the HR Settings page of the standard employee form.
- Automated tests. A test suite that asserts the UK country profile is registered against the correct country and that the National Insurance field is present on hr.employee.
Honest about the edges
What this does not do, so nothing surprises you.
- This is a localisation pack, not the connector. It adds fields, a country profile and mapping rows; the actual sync, webhook handling, queue, retries and audit logging live in the connector and sync engine modules it depends on (eh_hero_country_base and eh_hero_hr).
- It does not validate the format of the National Insurance number, PAYE tax code or student loan plan. The fields are free text and accept whatever the payload or a user supplies.
- It does not calculate PAYE, National Insurance or student loan deductions and is not a payroll engine. It carries the identifiers; it does not run UK statutory payroll.
- There is no HMRC, RTI or Real Time Information filing here. Statutory submission stays with your payroll platform.
- The mapped source paths are starting defaults tuned to a typical Employment Hero payload. If your tenant returns these fields under other keys you adjust the mapping lines to match.
- Built for Odoo 17 Community. The two sensitive identifiers depend on the standard hr.group_hr_user security group being present.
Employment Hero UK, Odoo UK payroll integration, National Insurance number Odoo, PAYE tax code Odoo, student loan plan Odoo, Odoo 17 HR localisation, Employment Hero connector, UK country pack, hr.employee UK fields, Employment Hero Odoo sync, Odoo Community HR UK, HMRC PAYE Odoo, people platform integration Odoo
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