hr.version: fields, relations and API
The hr.version model ("Employee Contract") is a persistent model declared by the Employees module, then extended by 6 other modules. It exposes 96 fields, 67 of them declared directly on the model; 5 fields from other models point to it. Below you will find every field with its technical name, type, label and relations, followed by an Odoo 20 JSON-2 API call.
Model identity
- Technical name
hr.version- Label
- Employee Contract
- Type
- Persistent (models.Model)
- SQL table
hr_version- Origin module
- Employees (
hr) - Extended by
- hr_address_extended, hr_work_entry, hr_attendance, hr_holidays, hr_holidays_attendance, l10n_fr_hr_holidays
- Default order (_order)
date_version- Display field (_rec_name)
name- Inherits from (mixins)
- mail.threadmail.activity.mixin
Model fields
67 own fields, 24 inherited from mixins and 5 automatic ORM fields. Click a name to get a direct link to that field.
96 of 96 fields shown
| Technical name | Label | Type | Details |
|---|---|---|---|
| active | Active | boolean | |
| active_employee | Active Employee | boolean | related: |
| address_id | Work Address | many2one | |
| allocation_from_working_schedule_id | Allocation from working schedule | many2one | added by Time Off ( |
| allowed_country_state_ids | Allowed Country State | many2many | computed |
| attendance_based | Attendance Based When enabled, payslips are computed from badge records rather than the employee's work schedule. Time off is always accounted for. | boolean | added by Attendances ( |
| children | Dependent Children | integer | |
| company_country_id | Company country | many2one | read-only related: |
| company_id | Company | many2one | computed, stored |
| contract_date_end | Contract End Date End date of the contract (if it's a fixed-term contract). | date | |
| contract_date_start | Contract Start Date | date | |
| contract_template_id | Contract Template Select a contract template to auto-fill the contract form with predefined values. You can still edit the fields as needed after applying the template. | many2one | |
| country_code | Country Code | char | read-only related: |
| country_id | Nationality (Country) | many2one | |
| currency_id | Currency | many2one | read-only related: |
| date_end | Date End | date | computed |
| date_start | Date Start | date | computed |
| date_version | Effective Date | date | required |
| department_id | Department | many2one | |
| departure_action_date | Departure Action Date | date | related: |
| departure_apply_date | Departure Apply Date | date | related: |
| departure_apply_immediately | Departure Apply Immediately | boolean | related: |
| departure_date | Departure Date | date | related: |
| departure_description | Departure Description | html | related: |
| departure_id | Departure | many2one | |
| departure_reason_id | Departure Reason | many2one | related: |
| dismissal_date | Dismissal Date | date | related: |
| display_name | Display Name | char | computed |
| distance_home_work | Home-Work Distance | integer | |
| distance_home_work_unit | Home-Work Distance unit | selection | required Values: |
| employee_id | Employee | many2one | |
| employee_type_id | Employee Type | many2one | |
| fixed_term | Fixed Term | boolean | |
| hr_responsible_id | HR Responsible Person responsible for validating the employee's contracts. | many2one | required |
| identification_id | Identification No Enter the employee's National Identification Number issued by the government (e.g., Aadhaar, SIN, NIN). This is used for official records and statutory compliance. | char | |
| is_current | Is Current | boolean | computed |
| is_custom_job_title | Is Custom Job Title | boolean | computed, stored |
| is_future | Is Future | boolean | computed |
| is_in_contract | Is In Contract | boolean | computed |
| is_past | Is Past | boolean | computed |
| job_id | Job | many2one→ hr.job | |
| job_title | Job Title | char | computed, stored |
| km_home_work | Home-Work Distance in Km | integer | computed, stored |
| last_modified_date | Last Modified on | datetime | required |
| last_modified_uid | Last Modified by | many2one | required |
| marital | Marital Status | selection | required Values computed at runtime |
| member_of_department | Member of department Whether the employee is a member of the active user's department or one of it's child department. | boolean | computed |
| name | Name | char | |
| passport_expiration_date | Passport Expiration Date | date | |
| passport_id | Passport No | char | |
| private_city | Private City | char | |
| private_city_id | Private City ID | many2one→ res.city | computed, stored added by HR Address Extended ( |
| private_country_enforce_cities | Private Country Enforce Cities | boolean | read-only related: added by HR Address Extended ( |
| private_country_id | Private Country | many2one | |
| private_state_id | Private State | many2one | |
| private_street | Private Street | char | |
| private_street2 | Private Street2 | char | |
| private_zip | Private Zip | char | |
| resource_calendar_id | Working Hours | many2one | required |
| sex | Sex This is the legal sex as recognized by the state, used for official and statutory purposes. | selection | Values: |
| spouse_birthdate | Spouse Birthdate | date | |
| spouse_complete_name | Spouse Legal Name | char | |
| structure_type_id | Salary Structure Type | many2one | computed, stored |
| trial_date_end | End of Trial Period End date of the trial period (if there is one). | date | |
| tz | Timezone | selection | required Values computed at runtime |
| wage | Wage Employee's monthly gross wage. | monetary | |
| work_location_id | Work Location | many2one | |
| activity_calendar_event_id | Next Activity Calendar Event | many2one | computed inherited from mail.activity.mixin |
| activity_date_deadline | Next Activity Deadline | date | read-onlycomputed inherited from mail.activity.mixin |
| activity_exception_decoration | Activity Exception Decoration Type of the exception activity on record. | selection | computed Values: inherited from mail.activity.mixin |
| activity_exception_icon | Icon Icon to indicate an exception activity. | char | computed inherited from mail.activity.mixin |
| activity_ids | Activities | one2many | inverse: inherited from mail.activity.mixin |
| activity_plans_ids | Activity Plans | many2many | computed inherited from mail.activity.mixin |
| activity_state | Activity State Status based on activities Overdue: Due date is already passed Today: Activity date is today Planned: Future activities. | selection | computed Values: inherited from mail.activity.mixin |
| activity_summary | Next Activity Summary | char | related: inherited from mail.activity.mixin |
| activity_type_icon | Activity Type Icon | char | related: inherited from mail.activity.mixin |
| activity_type_id | Next Activity Type | many2one | related: inherited from mail.activity.mixin |
| activity_user_id | Responsible User | many2one | read-onlycomputed inherited from mail.activity.mixin |
| has_message | Has Message | boolean | computed inherited from mail.thread |
| message_attachment_count | Attachment Count | integer | computed inherited from mail.thread |
| message_follower_ids | Followers | one2many | inverse: inherited from mail.thread |
| message_has_error | Message Delivery error If checked, some messages have a delivery error. | boolean | computed inherited from mail.thread |
| message_has_error_counter | Number of errors Number of messages with delivery error | integer | computed inherited from mail.thread |
| message_has_sms_error | SMS Delivery error If checked, some messages have a delivery error. | boolean | computed inherited from mail.thread |
| message_ids | Messages | one2many | inverse: inherited from mail.thread |
| message_is_follower | Is Follower | boolean | computed inherited from mail.thread |
| message_needaction | Action Needed If checked, new messages require your attention. | boolean | computed inherited from mail.thread |
| message_needaction_counter | Number of Actions Number of messages requiring action | integer | computed inherited from mail.thread |
| message_partner_ids | Followers (Partners) | many2many | computed inherited from mail.thread |
| my_activity_date_deadline | My Activity Deadline | date | read-onlycomputed inherited from mail.activity.mixin |
| rating_ids | Ratings | one2many | inverse: inherited from mail.thread |
| create_date | Created on | datetime | read-onlyautomatic |
| create_uid | Created by | many2one | read-onlyautomatic |
| id | ID | integer | read-onlyautomatic |
| write_date | Last Updated on | datetime | read-onlyautomatic |
| write_uid | Last Updated by | many2one | read-onlyautomatic |
Relations
Models linked from this model
- hr.department: department_id
- hr.departure.reason: departure_reason_id
- hr.employee: employee_id
- hr.employee.departure: departure_id
- hr.employee.type: employee_type_id
- hr.job: job_id
- hr.leave.allocation: allocation_from_working_schedule_id
- hr.payroll.structure.type: structure_type_id
- hr.version: contract_template_id
- hr.work.location: work_location_id
- res.city: private_city_id
- res.company: company_id
- res.country: company_country_id, country_id, private_country_id
- res.country.state: allowed_country_state_ids, private_state_id
- res.currency: currency_id
- res.partner: address_id
- res.users: hr_responsible_id, last_modified_uid
- resource.calendar: resource_calendar_id
Fields of other models pointing here
- hr.employee: contract_template_id, current_version_id, version_id
- hr.export.work.entries.employee: version_ids
- hr.version: contract_template_id
Reading this model through the API
Odoo 20 JSON-2 API call reading the first five records with real fields of the model. Replace the instance, database and API key with your own.
curl -X POST "https://your-instance.odoo.com/json/2/hr.version/search_read" \
-H "Authorization: bearer $ODOO_API_KEY" \
-H "X-Odoo-Database: your-db" \
-H "Content-Type: application/json" \
-d '{"domain":[],"fields":["name","date_version","distance_home_work_unit","hr_responsible_id","last_modified_date"],"limit":5}'import requests
BASE_URL = "https://your-instance.odoo.com/json/2"
headers = {"Authorization": f"bearer {API_KEY}", "X-Odoo-Database": "your-db"}
res = requests.post(
f"{BASE_URL}/hr.version/search_read",
headers=headers,
json={"domain": [], "fields": ["name","date_version","distance_home_work_unit","hr_responsible_id","last_modified_date"], "limit": 5},
)
res.raise_for_status()
print(res.json())- External API access requires Odoo's Custom plan.
- XML-RPC and JSON-RPC will be removed in Odoo 22 (fall 2028): use JSON-2.
- The access rights and record rules of the key's user apply.
Cite this tool
Writing a tutorial, internal documentation or a forum answer? Copy this link to send your readers to the up-to-date reference.
<a href="https://aidoo.ai/en/outils/explorateur-modeles-odoo/hr-version">hr.version (Odoo 20.0)</a>Sources
Data verified on September 25, 2026 · Odoo 20.0 Community
Have an Odoo project, or want to put your ERP to work with AI? Let's talk
Implementation, custom module development, connecting Claude or ChatGPT to your data: tell us about your context and we will reply within 24 business hours.