Time Off Single Policy Reference

The Policy component allows platforms to create, edit, and manage individual time off policies.

A single policy details screen shows all configuration details of a specific policy, including name, type, rules, and assigned employees. It also allows enabling or disabling the policy and editing the configuration fields.

Time off and PTO policy creation page.

Basic Implementation

iframe

React

iframe implementation is the recommended way to get started with time off

The Time Off Settings component takes care of rendering and navigation between time off policies.

The Policy component receives the prop policyId, which must be a valid ID of a time off policy. The goBack callback is used for returning to the previous screen (e.g. TimeOffSettings).

When rendered, the component loads the selected policy and displays its configuration in several sections

Policy Basic Details

Basic details section

This section configures the policy name and type, approval settings, default status, paid/unpaid status and other settings.

The available types include Sick, TimeOff, and VacationPay. These correspond to standard leave types used across payroll platforms.

Need additional time-off types? Chat with your Easyteam account manager

Balance Rules

Time off balances section

This section defines rules about balance limits, accrual rates, limits, carryover between years and negative balance rules.

Employee Assignment and Balances

Employee status and balances

This section defines which employees are assigned to this policy. Note that even employees that are not currently assigned to a policy can still have a balance they already accrued.

Users with admin permissions can override any staff member's balance.

API Types and Integration Notes

Time off integration works out of the box when using Easyteam UI components.

To work directly with time off policies and types, read the Time Off API documentation.

Each policy is represented by the type interface PolicyTypeDto; the list of employees assigned to a policy is defined via the IPolicyAssignedEmployee interface; balances and assignments are defined using the IWorkerPolicyMapper interface.

Callbacks and Notifications

When integration with the Easyteam notification system is enabled, changes to a policy or its assignment could trigger updates to affected employees. Learn more about this in the embedded notifications reference.

Event callbacks from the time off policy component include:

Event	Trigger	Payload
`onTimeOffPolicyCreate`	Admin creates a new time off policy	`time_off_policy` object
`onTimeOffPolicyEdit`	Admin modifies an existing time off policy	`time_off_policy` object
`onTimeOffPolicyDelete`	Admin deletes a time off policy	`time_off_policy` object
`onTimeOffPolicyAssign`	Employee is added to a policy	`time_off_policy` object, `employee_internal_id`, `employee_external_id`, `balance`
`onTimeOffPolicyRemove`	Employee is removed from a policy	`time_off_policy` object, `employee_internal_id`, `employee_external_id`, `balance`

All events can be subscribed to via your platform’s integration layer or webhook system. See the event and callback handling guide and notifications integration guide for more details.

Component Properties

Property	Type	Required	Description
`policyId`	`string`	Yes	ID of the policy to display and manage
`goBack`	`() => void`	Yes	Callback for navigating back to previous screen

Custom Strings (optional)

The policy component supports limited string customization for section titles and messages. For a full list of supported string overrides, see the UI Customization Introduction.

💡

The Policy component is designed to be used inside the broader time off settings interface, but it can also be rendered independently with just a policyId identifier.

Time Off Single Policy Reference

Basic Implementation#

Component Behavior & Navigation#

Policy Basic Details#

Balance Rules#

Employee Assignment and Balances#

API Types and Integration Notes#

Callbacks and Notifications#

Component Properties#

Custom Strings (optional)#