Deel: Process time-off requests from an external HRIS — request body — body data time offs item entitlement unit: HOUR, BUSINESS DAY, CALENDAR DAY, WEEK, MONTH, YEAR
Process time-off requests from an external HRIS: request body, field body / data / time_offs / item / entitlement_unit: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Process time-off requests from an external HRIS — request body — body / data / time_offs / item / entitlement_unit: HOUR, BUSINESS DAY, CALENDAR DAY, WEEK, MONTH, YEAR
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Optional | The amount in time units for this time off. When no amount is informed, it will be calculated using work schedules and public holidays defined at Deel. |
approved_at | string | Optional | The approval date of the time off. If no approval date is informed, the start date of this request will be used as the approval date. Note: use this field in order to support retrospective leaves so Deel can identify requests made after the payroll cycle. Format: date |
contract_oid | string | Required within parent | The contract id that has requested the time off. Maximum length: 24 |
description | string or null | Optional | The description of the time off. Maximum length: 500 |
end_date | string | Required within parent | The end date of the time off. Format: date |
entitlement_unit | string | Optional | The time unit for this time off. Mandatory when amount parameter is informed. If no amount and no entitlement_unit are informed, it will be calculated using Deel’s internal country templates for compliant time off policies. One of: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
external_id | string | Required within parent | External ID to link a Deel time off object with an external time off object. It will be used to determine which operation should be done: INSERT, UPDATE or DELETE. Maximum length: 48 |
is_paid | boolean | Optional | Allows the consumer to specify whether the time off is considered as paid (at statutory) or unpaid based on the configuration of the policy in the external HRIS. |
policy_name | string | Optional | The policy name the time off is being requested for. If not informed, a default name will be generated using the policy type and contract’s country (eg: Vacation - US). Maximum length: 256 |
policy_type | JSON | Required within parent | The Deel policy type of the policy the time off is being requested for. |
policy_type (oneOf 1) | Model | Alternative | Expand Process time-off requests from an external HRIS — request body — body / data / time_offs / item / entitlement_unit: HOUR, BUSINESS DAY, CALENDAR DAY, WEEK, MONTH, YEAR policy type string |
policy_type (oneOf 2) | null | Alternative | |
requested_at | string | Optional | The request date of the time off. Format: date |
start_date | string | Required within parent | The start date of the time off. Format: date |