hr.time.rule: fields, relations and API
The hr.time.rule model ("Time Rule") is a persistent model declared by the Work Entries module, then extended by 3 other modules. It exposes 40 fields, 34 of them declared directly on the model; 2 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.time.rule- Label
- Time Rule
- Type
- Persistent (models.Model)
- SQL table
hr_time_rule- Origin module
- Work Entries (
hr_work_entry) - Extended by
- hr_attendance, hr_holidays, hr_holidays_attendance
- Default order (_order)
sequence, id
Model fields
34 own fields, 0 inherited from mixins and 6 automatic ORM fields. Click a name to get a direct link to that field.
40 of 40 fields shown
| Technical name | Label | Type | Details |
|---|---|---|---|
| active | Active | boolean | |
| allocation_type_id | Allocate to | many2one | added by Time Off ( |
| amount_rate | Salary Rate | float | computed, stored |
| apply_friday | Apply Friday | boolean | |
| apply_monday | Apply Monday Define a condition based on the timing of the time entry. | boolean | |
| apply_on_public_holidays | Apply On Public Holidays | boolean | |
| apply_saturday | Apply Saturday | boolean | |
| apply_sunday | Apply Sunday | boolean | |
| apply_thursday | Apply Thursday | boolean | |
| apply_tuesday | Apply Tuesday | boolean | |
| apply_wednesday | Apply Wednesday | boolean | |
| calendar_source | Calendar Source Which schedule to use as the expected-hours baseline. | selection | computed, stored Values: |
| company_id | Company | many2one | |
| condition_label | Condition | char | computed |
| condition_work_entry_type_ids | Time Type If set, only the selected types will be considered by this rule. | many2many | required |
| country_code | Country Code | char | related: |
| country_id | Country | many2one | computed, stored |
| country_work_entry_type_ids | Country Work Entry Type | many2many | computed |
| description | Description | text | |
| employee_domain | Employees The rule will automatically apply to all time entries for matching employees. | char | |
| employee_tolerance | Employee Tolerance | float | |
| employer_tolerance | Employer Tolerance | float | |
| expected_hours | Usual work hours | float | computed, stored |
| leave_compensation_rate | Allocate % Leave allocated or taken at this rate of the excess or deficit. 100% = 1:1. | float | added by Time Off ( |
| name | Name | char | required |
| quantity_period | Quantity Period | selection | computed, stored Values: |
| resource_calendar_id | Schedule | many2one | |
| sequence | Sequence | integer | |
| threshold_operator | Threshold Operator | selection | required Values: |
| timing_start | From | float | |
| timing_stop | To | float | |
| week_start | Week Starts On | selection | Values: |
| work_entry_type_id | Set Excess to Define a time type that will be created to count the amount of time in excess or missing. | many2one | |
| working_hours_mode | Working Hours Mode Define a condition based on the quantity of work made by the employee on a specific period of time. | selection | required Values: |
| create_date | Created on | datetime | read-onlyautomatic |
| create_uid | Created by | many2one | read-onlyautomatic |
| display_name | Display Name | char | read-onlycomputedautomatic |
| 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.work.entry.type: allocation_type_id, condition_work_entry_type_ids, country_work_entry_type_ids, work_entry_type_id
- res.company: company_id
- res.country: country_id
- resource.calendar: resource_calendar_id
Fields of other models pointing here
- hr.attendance: time_rule_id
- hr.leave: time_rule_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.time.rule/search_read" \
-H "Authorization: bearer $ODOO_API_KEY" \
-H "X-Odoo-Database: your-db" \
-H "Content-Type: application/json" \
-d '{"domain":[],"fields":["name","threshold_operator","working_hours_mode","allocation_type_id","company_id"],"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.time.rule/search_read",
headers=headers,
json={"domain": [], "fields": ["name","threshold_operator","working_hours_mode","allocation_type_id","company_id"], "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-time-rule">hr.time.rule (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.