Technical Guide
Technical Guide
This application controls the time off schedule of your company. It allows employees to request time off. Then, managers can review
requests for time off and approve or reject them. This way you can control the overall time off planning for the company or
department.
You can configure several kinds of time off (sickness, paid days, ...) and allocate time off to an employee or department quickly using
time off allocation. An employee can also make a request for more days off by making a new time off allocation. It will increase the
total of available days for that time off type (if the request is accepted).
You can keep track of time off in different ways by following reports:
A synchronization with an internal agenda (Meetings of the CRM module) is also possible in order to automatically create a meeting
when a time off request is accepted by setting up a type of meeting in time off Type.
Reports:
Time Off Summary
Menu:
Time Off
Time Off/Configuration
Time Off/Configuration/Accrual Plans
Time Off/Configuration/Activity Types
Time Off/Configuration/Mandatory Days
Time Off/Configuration/Public Holidays
Time Off/Configuration/Time Off Types
Time Off/Management
Time Off/Management/Allocations
Time Off/Management/Time Off
Time Off/My Time
Time Off/My Time/Dashboard
2025-06-12 14:35 YourCompany 2 / 21
hr.holidays.report_graph (graph)
hr.holidays.report_list (list)
hr.holidays.report_pivot (pivot)
hr.holidays.summary.employee.form (form)
hr.holidays.view.list (list)
hr.leave.accrual.level.form (form)
hr.leave.accrual.plan.form (form)
hr.leave.accrual.plan.list (list)
hr.leave.accrual.plan.search (search)
hr.leave.allocation.generate.multi.wizard form (form)
hr.leave.allocation.view.activity (activity)
hr.leave.allocation.view.form (form)
hr.leave.allocation.view.kanban (kanban)
hr.leave.allocation.view.list (list)
hr.leave.employee.type.report.view.pivot (pivot)
hr.leave.generate.multi.wizard form (form)
hr.leave.mandatory.day form (form)
hr.leave.mandatory.day list (list)
hr.leave.mandatory.day search (search)
hr.leave.report.calendar.view (calendar)
hr.leave.report.calendar.view.form (form)
hr.leave.report.calendar.view.search (search)
hr.leave.type.filter (search)
hr.leave.type.form (form)
hr.leave.type.kanban (kanban)
hr.leave.type.normal.list (list)
hr.leave.view.activity (activity)
hr.leave.view.calendar (calendar)
hr.leave.view.dashboard (calendar)
hr.leave.view.dashboard (calendar)
hr.leave.view.form (form)
hr.leave.view.kanban (kanban)
report.hr.holidays.report.leave_all.graph (graph)
report.hr.holidays.report.leave_all.list (list)
report.hr.holidays.report.leave_all.pivot (pivot)
report_holidayssummary (qweb)
Dependencies:
hr - Installed
calendar - Installed
resource - Installed
2025-06-12 14:35 YourCompany 4 / 21
Object: calendar.event
Object: hr.department
absence_of_today Absence by Today, integer, readonly
allocation_to_approve_count Allocation to Approve, integer, readonly
leave_to_approve_count Time Off to Approve, integer, readonly
Object: hr.departure.wizard
Object: hr.employee
allocation_count Total number of days allocated., float, readonly
allocation_display Allocation Display, char, readonly
allocation_remaining_display Allocation Remaining Display, char, readonly
allocations_count Total number of allocations, integer, readonly
current_leave_id Current Time Off Type, many2one, readonly
current_leave_state Current Time Off Status, selection, readonly
hr_icon_display Hr Icon Display, selection, readonly
is_absent Absent Today, boolean, readonly
leave_date_from From Date, date, readonly
leave_date_to To Date, date, readonly
leave_manager_id Time Off, many2one
Select the user responsible for approving "Time Off" of this employee. If empty, the approval is
done by an Administrator or Approver (determined in settings/users).
leaves_count Number of Time Off, float, readonly
remaining_leaves Available Time Off Days, float, readonly
Total number of paid time off allocated to this employee, change this value to create
allocation/time off request. Total based on all the time off types without overriding limit.
show_leaves Able to see Remaining Time Off, boolean, readonly
Object: hr.employee.base
allocation_count Total number of days allocated., float, readonly
allocation_display Allocation Display, char, readonly
2025-06-12 14:35 YourCompany 5 / 21
Object: hr.holidays.cancel.leave
create_date Created on, datetime, readonly
create_uid Created by, many2one, readonly
display_name Display Name, char, readonly
id ID, integer, readonly
leave_id Time Off Request, many2one, required
reason Reason, text, required
write_date Last Updated on, datetime, readonly
write_uid Last Updated by, many2one, readonly
Object: hr.holidays.summary.employee
create_date Created on, datetime, readonly
create_uid Created by, many2one, readonly
date_from From, date, required
display_name Display Name, char, readonly
emp Employee(s), many2many
2025-06-12 14:35 YourCompany 6 / 21
Object: hr.leave
active_employee Employee Active, boolean, readonly
If the active field is set to False, it will allow you to hide the resource record without removing it.
activity_calendar_event_id Next Activity Calendar Event, many2one, readonly
activity_date_deadline Next Activity Deadline, date, readonly
activity_exception_decoration Activity Exception Decoration, selection, readonly
Type of the exception activity on record.
activity_exception_icon Icon, char, readonly
Icon to indicate an exception activity.
activity_ids Activities, one2many
activity_state Activity State, selection, readonly
Status based on activities Overdue: Due date is already passed Today: Activity date is today
Planned: Future activities.
activity_summary Next Activity Summary, char
activity_type_icon Activity Type Icon, char, readonly
Font awesome icon e.g. fa-tasks
activity_type_id Next Activity Type, many2one
activity_user_id Responsible User, many2one, readonly
attachment_ids Attachments, one2many
can_approve Can Approve, boolean, readonly
can_cancel Can Cancel, boolean, readonly
can_reset Can reset, boolean, readonly
color Color, integer, readonly
The color selected here will be used in every screen with the time off type.
company_id Company, many2one, readonly
create_date Created on, datetime, readonly
create_uid Created by, many2one, readonly
date_from Start Date, datetime, readonly
2025-06-12 14:35 YourCompany 7 / 21
Object: hr.leave.accrual.level
accrual_plan_id Accrual Plan, many2one, required
accrual_validity Accrual Validity, boolean
accrual_validity_count Accrual Validity Count, integer
You can define a period of time where the days carried over will be available
accrual_validity_type Accrual Validity Type, selection, required
This field defines the unit of time after which the accrual ends.
accrued_gain_time Accrued Gain Time, selection, readonly
action_with_unused_accruals Carry over, selection, required
When the Carry-Over Time is reached, according to Plan's setting, select what you want to happen
with the unused time off: None (time will be reset to zero), All accrued time carried over to the next
period; or Carryover with a maximum).
added_value Rate, float, required
The number of hours/days that will be incremented in the specified Time Off Type for every period
added_value_type Added Value Type, selection, required
can_modify_value_type Can Modify Value Type, boolean, readonly
cap_accrued_time Cap accrued time, boolean
When the field is checked the balance of an allocation using this accrual plan will never exceed the
specified amount.
cap_accrued_time_yearly Milestone cap, boolean
When the field is checked the total amount accrued each year will be capped at the specified
amount
create_date Created on, datetime, readonly
create_uid Created by, many2one, readonly
display_name Display Name, char, readonly
first_day First Day, integer
2025-06-12 14:35 YourCompany 10 / 21
Object: hr.leave.accrual.plan
accrued_gain_time Accrued Gain Time, selection, required
2025-06-12 14:35 YourCompany 11 / 21
Object: hr.leave.allocation
accrual_plan_id Accrual Plan, many2one
2025-06-12 14:35 YourCompany 12 / 21
Object: hr.leave.allocation.generate.multi.wizard
accrual_plan_id Accrual Plan, many2one
2025-06-12 14:35 YourCompany 15 / 21
Object: hr.leave.employee.type.report
active_employee Active Employee, boolean, readonly
company_id Company, many2one, readonly
date_from Start Date, datetime, readonly
date_to End Date, datetime, readonly
department_id Department, many2one, readonly
display_name Display Name, char, readonly
employee_id Employee, many2one, readonly
2025-06-12 14:35 YourCompany 16 / 21
Object: hr.leave.generate.multi.wizard
allocation_mode Allocation Mode, selection, required
Allow to create requests in batchs: - By Employee: for a specific employee - By Company: all
employees of the specified company - By Department: all employees of the specified department -
By Employee Tag: all employees of the specific employee group category
category_id Employee Tag, many2one
company_id Company, many2one, required
create_date Created on, datetime, readonly
create_uid Created by, many2one, readonly
date_from Start Date, date, required
date_to End Date, date, required
department_id Department, many2one
display_name Display Name, char, readonly
employee_ids Employees, many2many
holiday_status_id Time Off Type, many2one, required
id ID, integer, readonly
name Description, char
write_date Last Updated on, datetime, readonly
Object: hr.leave.mandatory.day
color Color, integer
company_id Company, many2one, required
create_date Created on, datetime, readonly
2025-06-12 14:35 YourCompany 17 / 21
Object: hr.leave.report
allocation_id Allocation Request, many2one, readonly
company_id Company, many2one, readonly
date_from Start Date, datetime, readonly
date_to End Date, datetime, readonly
department_id Department, many2one, readonly
display_name Display Name, char, readonly
employee_id Employee, many2one, readonly
has_department_manager_access Has Department Manager Access, boolean, readonly
holiday_status_id Time Off Type, many2one, readonly
id ID, integer, readonly
leave_id Time Off Request, many2one, readonly
leave_type Request Type, selection, readonly
name Description, char, readonly
number_of_days Number of Days, float, readonly
number_of_hours Number of Hours, float, readonly
state Status, selection, readonly
Object: hr.leave.report.calendar
company_id Company, many2one, readonly
2025-06-12 14:35 YourCompany 18 / 21
Object: hr.leave.type
accrual_count Accruals count, float, readonly
accruals_ids Accruals, one2many
active Active, boolean
If the active field is set to false, it will allow you to hide the time off type without removing it.
allocation_count Allocations, integer, readonly
allocation_notif_subtype_id Allocation Notification Subtype, many2one
2025-06-12 14:35 YourCompany 19 / 21
Object: mail.message.subtype
Object: report.hr_holidays.report_holidayssummary
Object: res.partner
Object: res.users
allocation_count Total number of days allocated., float, readonly
allocation_display Allocation Display, char, readonly
2025-06-12 14:35 YourCompany 21 / 21
Object: resource.calendar
associated_leaves_count Time Off Count, integer, readonly
Object: resource.calendar.leaves
holiday_id Time Off Request, many2one