Employment Hero Canada Country Pack
Canadian payroll identifiers on the employee, ready to fill from your Employment Hero sync.
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 Canada Country Pack
The fields a Canada payroll sync needs
Adds Social Insurance Number, Province of Employment, and the TD1 federal claim code to the employee, instead of a generic catch-all field you have to repurpose.
Sensitive identifiers stay with HR
The SIN and TD1 claim code are limited to HR users through the hr.group_hr_user group, so national id data does not render for every internal user who can open a contact.
Mapping you can adjust without code
Each field ships a mapping line that names a source path in your Employment Hero payload. The lines are noupdate data, so you can retune the source path to match your actual payload shape and keep your edits across upgrades.
Day in the life
How it behaves in a live sync
Install the pack and Canada is registered as a country profile and three new fields appear under the HR Settings tab of the employee form. When the connector pulls an employee from Employment Hero, the mapping lines read the SIN, province, and TD1 code from the payload and write them onto the matching Odoo employee, keyed by external id so a repeated pull updates rather than duplicates. The SIN and TD1 values stay hidden from users outside the HR group. If a value is missing from a given payload, the field is simply left as it is. You retune a source path once if your payload names a field differently, and every later sync follows the new mapping.
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.
Records are keyed by external id through the connector, so pulling the same Employment Hero employee again updates the existing Odoo employee rather than creating a duplicate.
When the SIN, province, or TD1 value is absent from a payload, the engine leaves the existing employee value untouched rather than blanking it, since the mapping is tolerant of empty source values.
The three mapping lines are noupdate data with tunable source paths, so a deployment whose Employment Hero payload names a field differently can repoint the source path without touching code and keep it through upgrades.
The Social Insurance Number and TD1 claim code are bound to the HR user group, so they do not appear for non-HR users who can otherwise read the employee.
Because the country pack rides the connector queue, a transient failure on one employee is retried with exponential backoff by the engine and does not stop the rest of the batch.
External id links and mappings carry a company scope through the connector, so the same Employment Hero account can feed the right company without crossing records.
What is inside
Built to do the job, end to end.
- Three Canadian employee fields. eh_sin (Social Insurance Number), eh_province_code (Province of Employment, for example ON, BC, QC), and eh_td1_federal_code (federal TD1 personal tax credits claim code), all added by inheriting hr.employee.
- Canada country profile record. Registers one eh.country.profile for Canada (base.ca, code CA), the anchor the connector uses to see that the Canada localisation is active.
- Three mapping lines. One eh.mapping.line per field, attached to the base employee mapping from the HR connector module, naming a source path in the Employment Hero payload for sin, province_of_employment, and td1_federal_code.
- Employee form group. An Employment Hero (Canada) group under the HR Settings page of the standard employee form, showing the three fields in place.
- Access control on the model. The groups attribute on the SIN and TD1 fields restricts them to hr.group_hr_user at the field level.
- Tests. Unit tests assert the Canada profile is registered against base.ca with code CA and that the eh_sin field is present on hr.employee.
Honest about the edges
What this does not do, so nothing surprises you.
- This pack is the Canada localisation layer only. It does not contain the sync engine, webhook handling, retry queue, or mapping framework, which live in the connector modules it depends on (eh_hero_country_base and eh_hero_hr and their dependencies).
- Direction is pull. These three fields are filled from Employment Hero into Odoo through the inherited employee mapping. The pack does not push SIN, province, or TD1 changes back to Employment Hero.
- It adds and maps three employee identifiers. It does not calculate Canadian tax, run payroll, file with the CRA, or validate SIN check digits.
- The mapping source paths are sensible defaults that you may need to tune to match your actual Employment Hero payload, since payload shapes vary by account.
- The Province of Employment field is a plain code field and is not access restricted, unlike the SIN and TD1 fields.
- It targets Odoo 17 Community. It is not a standalone integration and requires the Employment Hero connector base to be installed.
Employment Hero Canada, Odoo 17 Canada payroll, Social Insurance Number Odoo, SIN field hr employee, Province of Employment Odoo, TD1 federal claim code, Canada country pack Odoo, Employment Hero connector, Canadian payroll integration, CRA TD1 Odoo, hr employee tax fields Canada, Odoo Community HR Canada
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_ca |
| 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