Skip to content

Deel: Time off schemas (part 2)

36 Deel schemas with complete fields and constraints.

← Time off operations · All schemas

Retrieve policy validation templates — 200 response body — data policy validation templates item

FieldTypePresenceDescription and constraints
$objectRoot
adoption_date_definitionstringOptionalRule regarding the requirement of an adoption date for relevant policies.
Known values: REQUIRED, OPTIONAL, FORBIDDEN
allow_approvers_to_requestbooleanOptionalWhether designated approvers can also request time off under this policy.
allow_estimated_end_datebooleanOptionalWhether an estimated end date can be provided for the time off request.
allow_time_off_payment_treatment_upsertJSONOptional
allow_time_off_payment_treatment_upsert (anyOf 1)booleanAlternativeWhether payment treatment details can be updated.
allow_time_off_payment_treatment_upsert (anyOf 2)nullAlternativeWhether payment treatment details can be updated.
allow_to_edit_past_time_offsbooleanOptionalWhether past time off requests under this policy can be edited.
attachment_conditionJSONOptionalComparison operator if attachment is conditionally required.
attachment_condition (anyOf 1)stringAlternativeComparison operator if attachment is conditionally required.
Known values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL
attachment_condition (anyOf 2)nullAlternative
attachment_condition_amountJSONOptional
attachment_condition_amount (anyOf 1)JSONAlternative
attachment_condition_amount (anyOf 1) (anyOf 1)integerAlternativeThreshold amount for the attachment condition.
attachment_condition_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
attachment_condition_amount (anyOf 2)nullAlternativeThreshold amount for the attachment condition.
attachment_condition_unitJSONOptionalUnit for the attachment condition amount.
attachment_condition_unit (anyOf 1)stringAlternativeUnit for the attachment condition amount.
Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR
attachment_condition_unit (anyOf 2)nullAlternative
auto_approval_inactivity_time_unitJSONOptionalUnit for the auto-approval inactivity period.
auto_approval_inactivity_time_unit (anyOf 1)stringAlternativeUnit for the auto-approval inactivity period.
Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR
auto_approval_inactivity_time_unit (anyOf 2)nullAlternative
auto_approval_inactivity_time_unit_amountJSONOptional
auto_approval_inactivity_time_unit_amount (anyOf 1)JSONAlternative
auto_approval_inactivity_time_unit_amount (anyOf 1) (anyOf 1)integerAlternativeAmount for the auto-approval inactivity period.
auto_approval_inactivity_time_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
auto_approval_inactivity_time_unit_amount (anyOf 2)nullAlternativeAmount for the auto-approval inactivity period.
benefits_payer_typestringOptionalWho pays for the benefits associated with this time off.
Known values: ORGANIZATION, GOVERNMENT
countryJSONOptional
country (anyOf 1)stringAlternativeCountry code associated with this specific template instance, if applicable.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
country (anyOf 2)nullAlternativeCountry code associated with this specific template instance, if applicable.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
default_entitlement_unit_amountJSONOptional
default_entitlement_unit_amount (anyOf 1)JSONAlternative
default_entitlement_unit_amount (anyOf 1) (anyOf 1)numberAlternativeDefault amount of entitlement granted per cycle.
Format: double
default_entitlement_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
default_entitlement_unit_amount (anyOf 2)nullAlternativeDefault amount of entitlement granted per cycle.
Format: double
disable_termination_editingbooleanOptionalWhether editing related to termination is disabled.
edit_approved_modeJSONOptionalControls edit/cancel permissions on approved time off requests. Supersedes allow_to_edit_past_time_offs.
edit_approved_mode (anyOf 1)stringAlternativeControls edit/cancel permissions on approved time off requests. Supersedes allow_to_edit_past_time_offs.
Known values: RESTRICT_FULLY, RESTRICT_BEYOND_CYCLE, NO_RESTRICT
edit_approved_mode (anyOf 2)nullAlternative
enable_absence_percentage_requestsbooleanOptionalWhether requests can be made as a percentage of the workday.
enable_accrued_days_for_policy_on_termination_flowbooleanOptionalCalculate accrued days specifically for this policy during termination.
enable_high_accuracy_accrued_days_on_termination_flowbooleanOptionalUse high accuracy calculation for accrued days during termination.
enable_pay_out_balancebooleanOptionalWhether unused balance can be paid out.
enabled_policy_fieldsJSONOptional
enabled_policy_fields (anyOf 1)arrayAlternativeList of specific policy fields that are enabled or configurable.
enabled_policy_fields (anyOf 1)[]stringEach item
enabled_policy_fields (anyOf 2)nullAlternativeList of specific policy fields that are enabled or configurable.
enabled_policy_fields (anyOf 2)[]stringEach item
estimated_end_date_client_reminderJSONOptional
estimated_end_date_client_reminder (anyOf 1)arrayAlternativeDays before estimated end date to remind the client/manager.
estimated_end_date_client_reminder (anyOf 1)[]JSONEach item
estimated_end_date_client_reminder (anyOf 1)[] (anyOf 1)integerAlternative
estimated_end_date_client_reminder (anyOf 1)[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
estimated_end_date_client_reminder (anyOf 2)nullAlternativeDays before estimated end date to remind the client/manager.
estimated_end_date_client_reminder (anyOf 2)[]JSONEach item
estimated_end_date_client_reminder (anyOf 2)[] (anyOf 1)integerAlternative
estimated_end_date_client_reminder (anyOf 2)[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
estimated_end_date_worker_reminderJSONOptional
estimated_end_date_worker_reminder (anyOf 1)arrayAlternativeDays before estimated end date to remind the worker.
estimated_end_date_worker_reminder (anyOf 1)[]JSONEach item
estimated_end_date_worker_reminder (anyOf 1)[] (anyOf 1)integerAlternative
estimated_end_date_worker_reminder (anyOf 1)[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
estimated_end_date_worker_reminder (anyOf 2)nullAlternativeDays before estimated end date to remind the worker.
estimated_end_date_worker_reminder (anyOf 2)[]JSONEach item
estimated_end_date_worker_reminder (anyOf 2)[] (anyOf 1)integerAlternative
estimated_end_date_worker_reminder (anyOf 2)[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringOptionalUnique identifier for the policy validation template.
Format: uuid
include_in_termination_flowbooleanOptionalWhether this policy is considered during the termination process.
is_auto_approval_on_inactivity_enabledJSONOptional
is_auto_approval_on_inactivity_enabled (anyOf 1)booleanAlternativeWhether requests are automatically approved after a period of inactivity.
is_auto_approval_on_inactivity_enabled (anyOf 2)nullAlternativeWhether requests are automatically approved after a period of inactivity.
is_payment_top_offbooleanOptionalIndicates if the policy involves payment top-offs.
leave_typestringOptionalClassification of the leave duration.
Known values: SHORT_TERM_LEAVE, LONG_TERM_LEAVE
max_entitlement_unit_amountJSONOptional
max_entitlement_unit_amount (anyOf 1)JSONAlternative
max_entitlement_unit_amount (anyOf 1) (anyOf 1)numberAlternativeMaximum allowed entitlement amount.
Format: double
max_entitlement_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_entitlement_unit_amount (anyOf 2)nullAlternativeMaximum allowed entitlement amount.
Format: double
max_request_start_unit_amountJSONOptional
max_request_start_unit_amount (anyOf 1)JSONAlternative
max_request_start_unit_amount (anyOf 1) (anyOf 1)integerAlternativeMaximum waiting period amount if request_start_type is FIXED_PERIOD.
max_request_start_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_request_start_unit_amount (anyOf 2)nullAlternativeMaximum waiting period amount if request_start_type is FIXED_PERIOD.
max_time_off_per_trackingJSONOptional
max_time_off_per_tracking (anyOf 1)JSONAlternative
max_time_off_per_tracking (anyOf 1) (anyOf 1)numberAlternativeMaximum amount of time off allowed per tracking cycle.
Format: double
max_time_off_per_tracking (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_time_off_per_tracking (anyOf 2)nullAlternativeMaximum amount of time off allowed per tracking cycle.
Format: double
max_tracking_unit_amountJSONOptional
max_tracking_unit_amount (anyOf 1)JSONAlternative
max_tracking_unit_amount (anyOf 1) (anyOf 1)integerAlternativeMaximum duration of the tracking cycle in tracking_unit.
max_tracking_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_tracking_unit_amount (anyOf 2)nullAlternativeMaximum duration of the tracking cycle in tracking_unit.
maximum_time_off_request_amountJSONOptional
maximum_time_off_request_amount (anyOf 1)JSONAlternative
maximum_time_off_request_amount (anyOf 1) (anyOf 1)numberAlternativeMaximum amount that can be requested in a single time off request.
Format: double
maximum_time_off_request_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maximum_time_off_request_amount (anyOf 2)nullAlternativeMaximum amount that can be requested in a single time off request.
Format: double
min_entitlement_unit_amountJSONOptional
min_entitlement_unit_amount (anyOf 1)JSONAlternative
min_entitlement_unit_amount (anyOf 1) (anyOf 1)numberAlternativeMinimum allowed entitlement amount.
Format: double
min_entitlement_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_entitlement_unit_amount (anyOf 2)nullAlternativeMinimum allowed entitlement amount.
Format: double
min_request_start_unit_amountJSONOptional
min_request_start_unit_amount (anyOf 1)JSONAlternative
min_request_start_unit_amount (anyOf 1) (anyOf 1)integerAlternativeMinimum waiting period amount if request_start_type is FIXED_PERIOD.
min_request_start_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_request_start_unit_amount (anyOf 2)nullAlternativeMinimum waiting period amount if request_start_type is FIXED_PERIOD.
min_time_off_per_trackingJSONOptional
min_time_off_per_tracking (anyOf 1)JSONAlternative
min_time_off_per_tracking (anyOf 1) (anyOf 1)numberAlternativeMinimum amount of time off required per tracking cycle.
Format: double
min_time_off_per_tracking (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_time_off_per_tracking (anyOf 2)nullAlternativeMinimum amount of time off required per tracking cycle.
Format: double
min_tracking_unit_amountJSONOptional
min_tracking_unit_amount (anyOf 1)JSONAlternative
min_tracking_unit_amount (anyOf 1) (anyOf 1)integerAlternativeMinimum duration of the tracking cycle in tracking_unit.
min_tracking_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_tracking_unit_amount (anyOf 2)nullAlternativeMinimum duration of the tracking cycle in tracking_unit.
minimum_time_off_request_amountJSONOptional
minimum_time_off_request_amount (anyOf 1)JSONAlternative
minimum_time_off_request_amount (anyOf 1) (anyOf 1)numberAlternativeMinimum amount that can be requested in a single time off request.
Format: double
minimum_time_off_request_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minimum_time_off_request_amount (anyOf 2)nullAlternativeMinimum amount that can be requested in a single time off request.
Format: double
notice_period_unitJSONOptionalUnit for the required notice period.
notice_period_unit (anyOf 1)stringAlternativeUnit for the required notice period.
Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR
notice_period_unit (anyOf 2)nullAlternative
notice_period_unit_amountJSONOptional
notice_period_unit_amount (anyOf 1)JSONAlternative
notice_period_unit_amount (anyOf 1) (anyOf 1)integerAlternativeAmount for the required notice period.
notice_period_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
notice_period_unit_amount (anyOf 2)nullAlternativeAmount for the required notice period.
ops_workbench_process_template_referenceJSONOptional
ops_workbench_process_template_reference (anyOf 1)stringAlternativeReference to an Ops Workbench process template, if applicable.
ops_workbench_process_template_reference (anyOf 2)nullAlternativeReference to an Ops Workbench process template, if applicable.
overlap_request_typestringOptionalRule for requesting time off that overlaps with existing requests.
Known values: ALLOWED, NOT_ALLOWED, ALLOWED_WITH_APPROVAL
policy_allowance_prorationJSONOptionalProration rules applied to the policy allowances.
policy_allowance_proration (anyOf 1)ModelAlternativeExpand Retrieve policy validation templates — 200 response body — data policy validation templates item policy allowance proration Proration rules applied to the policy allowances
policy_allowance_proration (anyOf 2)nullAlternative
policy_allowancesarrayOptionalList of allowances defined within this policy template.
policy_allowances[]ModelEach itemExpand Retrieve policy validation templates — 200 response body — data policy validation templates item policy allowances item
policy_typeModelOptionalExpand Retrieve policy validation templates — 200 response body — data policy validation templates item policy type
Details of the associated policy type.
policy_type_idstringOptionalIdentifier of the associated policy type.
Format: uuid
policy_validation_template_remindersarrayOptionalConfiguration for reminders related to this policy template.
policy_validation_template_reminders[]ModelEach itemExpand Get Organization Structure — 200 response body — data teams item
request_start_typeJSONOptionalWhen a worker can start requesting time off after becoming eligible.
request_start_type (anyOf 1)stringAlternativeWhen a worker can start requesting time off after becoming eligible.
Known values: IMMEDIATELY, FIXED_PERIOD
request_start_type (anyOf 2)nullAlternative
request_start_unitJSONOptionalUnit for the waiting period if request_start_type is FIXED_PERIOD.
request_start_unit (anyOf 1)stringAlternativeUnit for the waiting period if request_start_type is FIXED_PERIOD.
Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR
request_start_unit (anyOf 2)nullAlternative
require_notice_periodJSONOptional
require_notice_period (anyOf 1)booleanAlternativeWhether a notice period is required before taking time off.
require_notice_period (anyOf 2)nullAlternativeWhether a notice period is required before taking time off.
retrospective_request_typestringOptionalRule for requesting time off for past dates.
Known values: ALLOWED, NOT_ALLOWED, ALLOWED_WITH_APPROVAL
template_nameJSONOptional
template_name (anyOf 1)stringAlternativeOptional name for this specific template instance.
template_name (anyOf 2)nullAlternativeOptional name for this specific template instance.
time_off_request_typestringOptionalAllowed types of time off requests (e.g., full day, hourly).
Known values: FULL_DAY, HALF_DAY, HOURLY, PERCENTAGE, FLEXIBLE
time_off_type_validationsarrayOptionalSpecific validation rules applied to time off types under this policy.
time_off_type_validations[]ModelEach itemExpand Get Organization Structure — 200 response body — data teams item
tracking_cadencestringOptionalDetermines when the tracking cycle starts.
Known values: FIXED_DAY, ANNIVERSARY, NOT_SPECIFIED
tracking_start_dateJSONOptional
tracking_start_date (anyOf 1)stringAlternativeSpecific start date for FIXED_DAY tracking cadence (YYYY-MM-DD).
Format: date
tracking_start_date (anyOf 2)nullAlternativeSpecific start date for FIXED_DAY tracking cadence (YYYY-MM-DD).
Format: date
tracking_unitJSONOptionalThe unit used for tracking the policy cycle (e.g., yearly).
tracking_unit (anyOf 1)stringAlternativeThe unit used for tracking the policy cycle (e.g., yearly).
Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR
tracking_unit (anyOf 2)nullAlternative
upload_attachment_conditionstringOptionalCondition under which an attachment is needed for a request.
Known values: REQUIRED, NOT_REQUIRED, CONDITIONALLY_REQUIRED, REQUIRED_WITH_CONDITION, ALWAYS_REQUIRED

Referenced models: Get Organization Structure — 200 response body — data teams item, Retrieve policy validation templates — 200 response body — data policy validation templates item policy allowance proration Proration rules applied to the policy allowances, Retrieve policy validation templates — 200 response body — data policy validation templates item policy allowances item, Retrieve policy validation templates — 200 response body — data policy validation templates item policy type

Retrieve policy validation templates — 200 response body — data policy validation templates item policy allowance proration Proration rules applied to the policy allowances

FieldTypePresenceDescription and constraints
$objectRootProration rules applied to the policy allowances.
has_partial_proratebooleanOptionalIndicates if partial proration rules are applied.
hire_proration_cut_off_dateJSONOptional
hire_proration_cut_off_date (anyOf 1)JSONAlternative
hire_proration_cut_off_date (anyOf 1) (anyOf 1)integerAlternativeDay of the month used as cut-off for hire proration.
hire_proration_cut_off_date (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hire_proration_cut_off_date (anyOf 2)nullAlternativeDay of the month used as cut-off for hire proration.
hire_proration_rulestringOptionalRule for prorating entitlement upon hiring.
Known values: NO_PRORATION, FULL_AMOUNT, PRORATED_MONTHLY, PRORATED_DAILY, COUNTRY_SPECIFIC, FULL_MONTH_PRORATION_BASED_ON_DAY, TENURE_BOUNDARY_PRORATION
idstringOptionalUnique identifier for the proration settings.
Format: uuid
is_accrual_prorate_policybooleanOptionalIndicates if accrual is prorated based on policy rules.
max_part_time_worker_treatment_specific_amountJSONOptional
max_part_time_worker_treatment_specific_amount (anyOf 1)JSONAlternative
max_part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 1)numberAlternativeMaximum specific amount for part-time treatment.
Format: double
max_part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_part_time_worker_treatment_specific_amount (anyOf 2)nullAlternativeMaximum specific amount for part-time treatment.
Format: double
min_part_time_worker_treatment_specific_amountJSONOptional
min_part_time_worker_treatment_specific_amount (anyOf 1)JSONAlternative
min_part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 1)numberAlternativeMinimum specific amount for part-time treatment.
Format: double
min_part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_part_time_worker_treatment_specific_amount (anyOf 2)nullAlternativeMinimum specific amount for part-time treatment.
Format: double
part_time_worker_treatment_specific_amountJSONOptional
part_time_worker_treatment_specific_amount (anyOf 1)JSONAlternative
part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 1)numberAlternativeSpecific amount if treatment type is SPECIFIC_AMOUNT.
Format: double
part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
part_time_worker_treatment_specific_amount (anyOf 2)nullAlternativeSpecific amount if treatment type is SPECIFIC_AMOUNT.
Format: double
part_time_worker_treatment_typestringOptionalHow part-time workers are treated regarding entitlement.
Known values: SAME_AS_FTE, SPECIFIC_AMOUNT, PRO_RATA, PERCENTAGE_OF_FTE, BASED_ON_WORK_HOURS, BASED_ON_WORK_DAYS, CUSTOM_ENTITLEMENT
termination_proration_cut_off_dateJSONOptional
termination_proration_cut_off_date (anyOf 1)JSONAlternative
termination_proration_cut_off_date (anyOf 1) (anyOf 1)integerAlternativeDay of the month used as cut-off for termination proration.
termination_proration_cut_off_date (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
termination_proration_cut_off_date (anyOf 2)nullAlternativeDay of the month used as cut-off for termination proration.
termination_proration_rulestringOptionalRule for prorating entitlement upon termination.
Known values: NO_PRORATION, FULL_AMOUNT, PRORATED_MONTHLY, PRORATED_DAILY, COUNTRY_SPECIFIC, FULL_MONTH_PRORATION_BASED_ON_DAY, TENURE_BOUNDARY_PRORATION

Retrieve policy validation templates — 200 response body — data policy validation templates item policy allowances item

FieldTypePresenceDescription and constraints
$objectRoot
accrual_application_typeJSONOptionalWhen the accrued amount is applied to the balance.
accrual_application_type (anyOf 1)stringAlternativeWhen the accrued amount is applied to the balance.
Known values: BEGIN_OF_CYCLE, BEGIN_OF_NEXT_CYCLE, END_OF_CYCLE
accrual_application_type (anyOf 2)nullAlternative
accrual_prorate_typesJSONOptional
accrual_prorate_types (anyOf 1)arrayAlternativeSpecifies conditions under which accrual should be prorated.
accrual_prorate_types (anyOf 1)[]stringEach itemKnown values: PRORATE_UNPAID_LEAVE, PRORATE_PAID_LEAVE, NO_PRORATE
accrual_prorate_types (anyOf 2)nullAlternativeSpecifies conditions under which accrual should be prorated.
accrual_prorate_types (anyOf 2)[]stringEach itemKnown values: PRORATE_UNPAID_LEAVE, PRORATE_PAID_LEAVE, NO_PRORATE
accrual_typestringOptionalHow entitlement accrues (over time or based on events).
Known values: TIMEFRAME, EVENT, TIME_OFF_IN_LIEU, HOURLY, LUMPSUM, NO_AUTO_ACCRUAL
accrual_unitJSONOptionalUnit for accrual if type is TIMEFRAME.
accrual_unit (anyOf 1)stringAlternativeUnit for accrual if type is TIMEFRAME.
Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR
accrual_unit (anyOf 2)nullAlternative
accrual_unit_amountJSONOptional
accrual_unit_amount (anyOf 1)JSONAlternative
accrual_unit_amount (anyOf 1) (anyOf 1)integerAlternativeAmount of accrual per unit if type is TIMEFRAME.
accrual_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
accrual_unit_amount (anyOf 2)nullAlternativeAmount of accrual per unit if type is TIMEFRAME.
additional_allowance_rulesarrayOptionalSpecific rules governing additional allowances.
additional_allowance_rules[]ModelEach itemExpand Get Organization Structure — 200 response body — data teams item
balance_tracking_flexible_custom_request_amountJSONOptional
balance_tracking_flexible_custom_request_amount (anyOf 1)JSONAlternative
balance_tracking_flexible_custom_request_amount (anyOf 1) (anyOf 1)integerAlternativeCustom amount for flexible balance tracking if applicable.
balance_tracking_flexible_custom_request_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
balance_tracking_flexible_custom_request_amount (anyOf 2)nullAlternativeCustom amount for flexible balance tracking if applicable.
balance_tracking_typeJSONOptionalHow the balance is tracked (e.g., flexible, inflexible).
balance_tracking_type (anyOf 1)stringAlternativeHow the balance is tracked (e.g., flexible, inflexible).
Known values: FLEXIBLE_UP_TO_YEARLY_ALLOWANCE, FLEXIBLE_NO_LIMIT, FLEXIBLE_CUSTOM_AMOUNT, INFLEXIBLE
balance_tracking_type (anyOf 2)nullAlternative
enable_bank_holidaysbooleanOptionalWhether bank holidays affect the entitlement or usage.
entitlement_expiration_unitJSONOptionalUnit for entitlement expiration period.
entitlement_expiration_unit (anyOf 1)stringAlternativeUnit for entitlement expiration period.
Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR
entitlement_expiration_unit (anyOf 2)nullAlternative
entitlement_expiration_unit_amountJSONOptional
entitlement_expiration_unit_amount (anyOf 1)JSONAlternative
entitlement_expiration_unit_amount (anyOf 1) (anyOf 1)integerAlternativeAmount for entitlement expiration period.
entitlement_expiration_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
entitlement_expiration_unit_amount (anyOf 2)nullAlternativeAmount for entitlement expiration period.
entitlement_start_typeJSONOptionalWhen the entitlement starts.
entitlement_start_type (anyOf 1)stringAlternativeWhen the entitlement starts.
Known values: IMMEDIATELY, FIXED_PERIOD, FIXED_DATE
entitlement_start_type (anyOf 2)nullAlternative
entitlement_start_unitJSONOptionalUnit for the start period if type is FIXED_PERIOD.
entitlement_start_unit (anyOf 1)stringAlternativeUnit for the start period if type is FIXED_PERIOD.
Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR
entitlement_start_unit (anyOf 2)nullAlternative
entitlement_start_unit_amountJSONOptional
entitlement_start_unit_amount (anyOf 1)JSONAlternative
entitlement_start_unit_amount (anyOf 1) (anyOf 1)integerAlternativeAmount for the start period if type is FIXED_PERIOD.
entitlement_start_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
entitlement_start_unit_amount (anyOf 2)nullAlternativeAmount for the start period if type is FIXED_PERIOD.
entitlement_unitstringOptionalUnit in which the entitlement is measured.
Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR
entitlement_unit_amountJSONOptional
entitlement_unit_amount (anyOf 1)JSONAlternative
entitlement_unit_amount (anyOf 1) (anyOf 1)numberAlternativeAmount of entitlement granted in entitlement_unit.
Format: double
entitlement_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
entitlement_unit_amount (anyOf 2)nullAlternativeAmount of entitlement granted in entitlement_unit.
Format: double
idstringOptionalUnique identifier for the policy allowance.
Format: uuid
namestringOptionalName of the allowance.
part_time_worker_additional_allowance_typestringOptionalHow additional allowances apply to part-time workers.
Known values: SAME_AS_FTE, PERCENTAGE_OF_FTE, NO_ADDITIONAL_ALLOWANCE
rollover_expiration_unitJSONOptionalUnit for the expiration period of rolled-over balance.
rollover_expiration_unit (anyOf 1)stringAlternativeUnit for the expiration period of rolled-over balance.
Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR
rollover_expiration_unit (anyOf 2)nullAlternative
rollover_expiration_unit_amountJSONOptional
rollover_expiration_unit_amount (anyOf 1)JSONAlternative
rollover_expiration_unit_amount (anyOf 1) (anyOf 1)integerAlternativeAmount for the expiration period of rolled-over balance.
rollover_expiration_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rollover_expiration_unit_amount (anyOf 2)nullAlternativeAmount for the expiration period of rolled-over balance.
rollover_limit_unit_amountJSONOptional
rollover_limit_unit_amount (anyOf 1)JSONAlternative
rollover_limit_unit_amount (anyOf 1) (anyOf 1)integerAlternativeMaximum amount that can be rolled over if type is LIMITED_ROLLOVER.
rollover_limit_unit_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rollover_limit_unit_amount (anyOf 2)nullAlternativeMaximum amount that can be rolled over if type is LIMITED_ROLLOVER.
rollover_typeJSONOptionalRule for carrying over unused balance to the next cycle.
rollover_type (anyOf 1)stringAlternativeRule for carrying over unused balance to the next cycle.
Known values: NO_ROLLOVER, LIMITED_ROLLOVER, UNLIMITED_ROLLOVER, PAY_OUT, CARRY_OVER, CARRY_OVER_PAY_OUT
rollover_type (anyOf 2)nullAlternative
termination_typestringOptionalRule for handling the balance upon termination.
Known values: NO_PAYOUT, PAYOUT_BALANCE
typestringOptionalType of allowance (base or additional).
Known values: BASE_ALLOWANCE, ADDITIONAL_ALLOWANCE
zero_out_negative_balances_on_rolloverbooleanOptionalWhether negative balances are reset to zero at rollover.

Referenced models: Get Organization Structure — 200 response body — data teams item

Retrieve policy validation templates — 200 response body — data policy validation templates item policy type

FieldTypePresenceDescription and constraints
$objectRootDetails of the associated policy type.
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the policy type.
description (anyOf 2)nullAlternativeDescription of the policy type.
idstringOptionalUnique identifier of the policy type.
Format: uuid
namestringOptionalName of the policy type.

Update time-off request — 200 response body

FieldTypePresenceDescription and constraints
$objectRootTime off data to be updated
time_offModelRequired within parentExpand Update time-off request — 200 response body — time off
Used to return the updated time off request after modification. Contains all the time off details including status, dates, amounts, and associated metadata.

Referenced models: Update time-off request — 200 response body — time off

Update time-off request — 200 response body — time off

FieldTypePresenceDescription and constraints
$objectRootUsed to return the updated time off request after modification. Contains all the time off details including status, dates, amounts, and associated metadata.
amountstringRequired within parentAmount of time off taken. This is the total amount of time off taken. For example, if you take 2 days off, this will be 2. If you take 1 day off, this will be 1.
approved_atJSONOptional
approved_at (anyOf 1)stringAlternativeThis is the date when the time off request was approved. This will be null if the time off request is not approved yet.
Format: date-time
approved_at (anyOf 2)nullAlternativeThis is the date when the time off request was approved. This will be null if the time off request is not approved yet.
Format: date-time
attachmentsarrayOptionalList of attachments associated with the time off request.
attachments[]ModelEach itemExpand Update time-off request — 200 response body — time off attachments item
canceled_atJSONOptional
canceled_at (anyOf 1)stringAlternativeTime off cancellation date
Format: date-time
canceled_at (anyOf 2)nullAlternativeTime off cancellation date
Format: date-time
contract_oidstringOptionalContract id. This is the id of the contract associated with the time off request.
created_atstringRequired within parentThis is the date when the time off request was created in the database.
Format: date-time
custom_field_valuesarrayOptionalAnswers to the custom fields the request policy declares. Omitted when the policy declares none.
custom_field_values[]ModelEach itemExpand Update time-off request — 200 response body — time off custom field values item
deduction_amountstringOptionalDeduction amount. Available for independent contractor's policies
deleted_atJSONOptional
deleted_at (anyOf 1)stringAlternativeTime off deletion date. Present only when the time-off is soft-deleted and include_deleted_time_offs was requested.
Format: date-time
deleted_at (anyOf 2)nullAlternativeTime off deletion date. Present only when the time-off is soft-deleted and include_deleted_time_offs was requested.
Format: date-time
descriptionstringOptionalDescription of the time off request. Some policies require that a description is provided.
end_datestringRequired within parentEnd date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day.
Format: date
entitlement_unitstringRequired within parentThe unit in which the time off usage and entitlement are calculated.
Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR
half_end_datebooleanRequired within parentWhether the end date is a half day or not.
half_start_datebooleanRequired within parentWhether the start date is a half day or not.
is_end_date_estimatedbooleanOptionalUsed to indicate if the end date is an estimate rather than a confirmed date. This is particularly important for event-based policies such as Parental Leave, where the actual end date may depend on the actual birth or adoption date, which may not be known at the time of request submission.
is_paidbooleanRequired within parentWhether the time off is paid or unpaid.
other_type_descriptionstringOptionalUsed to provide a custom description when the time off type is categorized as 'OTHER'. This allows users to specify the nature of time off that doesn't fit into standard categories, providing flexibility for unique or organization-specific time off types.
reasonstringOptionalReason for taking time off. This is complementary information for the time-off description. Useful to provide sub categories for the same policy.
recipient_profileModelOptionalExpand Update time-off request — 200 response body — time off recipient profile
The time off profile of the recipient of the time off request. Must be a worker profile.
requested_atstringRequired within parentThis is the date when the time off request was made.
Format: date
requester_profileModelOptionalExpand Update time-off request — 200 response body — time off requester profile
The time off profile of the requester of the time off request. Can be either a client or worker profile.
start_datestringRequired within parentStart date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first day.
Format: date
statusstringOptionalStatus of the time off request. Can be REQUESTED, APPROVED, REJECTED, USED or CANCELED.
Known values: REQUESTED, APPROVED, REJECTED, USED, CANCELED, DELETED
time_off_dailiesarrayOptionalUsed to break down the time off request into daily records. Each entry represents a single day within the time off period, allowing for detailed tracking of working days, non-working days, and holidays included in the request.
time_off_dailies[]ModelEach itemExpand Update time-off request — 200 response body — time off time off dailies item
time_off_eventModelOptionalExpand Update time-off request — 200 response body — time off time off event
time_off_percentagestringOptionalUsed to specify the percentage of time off taken relative to full-time employment. This value ranges from 0 to 1, where 1 represents full-time (100%) and 0.5 represents part-time (50%). This is useful for part-time workers or when taking partial time off.
time_off_typeModelOptionalExpand Update time-off request — 200 response body — time off time off type
The type of time off taken.
time_off_type_idstringRequired within parentTime off type id. This is the id of the time off type associated with the time off request.
Format: uuid
updated_atstringRequired within parentThis is the date when the time off request was last updated in the database.
Format: date-time

Referenced models: Update time-off request — 200 response body — time off custom field values item, Update time-off request — 200 response body — time off attachments item, Update time-off request — 200 response body — time off recipient profile, Update time-off request — 200 response body — time off requester profile, Update time-off request — 200 response body — time off time off dailies item, Update time-off request — 200 response body — time off time off event, Update time-off request — 200 response body — time off time off type

Update time-off request — 200 response body — time off attachments item

FieldTypePresenceDescription and constraints
$objectRootAn attachment associated with the time off request.
created_atstringRequired within parentThis is the date when the attachment was created in the database.
Format: date-time
filenamestringRequired within parentFilename of the attachment
idstringRequired within parentAttachment id
Format: uuid
updated_atstringRequired within parentThis is the date when the attachment was last updated in the database.
Format: date-time

Update time-off request — 200 response body — time off custom field values item

FieldTypePresenceDescription and constraints
$objectRoot
field_idstringRequired within parentThe id of the custom field this value answers.
Format: uuid
valueJSONRequired within parent
value (anyOf 1)stringAlternativeThe submitted value for the custom field, serialized as text. When no value is provided, this will be null.
value (anyOf 2)nullAlternativeThe submitted value for the custom field, serialized as text. When no value is provided, this will be null.

Update time-off request — 200 response body — time off recipient profile

FieldTypePresenceDescription and constraints
$objectRootThe time off profile of the recipient of the time off request. Must be a worker profile.
hris_profile_idstringRequired within parentThe worker HRIS profile id in the given organization.
Format: uuid
organization_idstringRequired within parentId of the organization the profile belongs to.
Format: uuid

Update time-off request — 200 response body — time off requester profile

FieldTypePresenceDescription and constraints
$objectRootThe time off profile of the requester of the time off request. Can be either a client or worker profile.
client_profile_idstringOptionalId of the client profile. Available when the requester is a client.
Format: uuid
hris_profile_idstringOptionalThe worker HRIS profile id in the given organization. Available when the requester is a worker.
Format: uuid
organization_idstringRequired within parentId of the organization the profile belongs to.
Format: uuid

Update time-off request — 200 response body — time off time off dailies item

FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentAmount of time off taken in this specific date.
created_atstringRequired within parentThis is the date when the time off daily was created in the database.
Format: date-time
datestringRequired within parentDate of the time off daily. This is the date when the time off was taken.
Format: date
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the time off daily. When it is a HOLIDAY this is the holiday name.
description (anyOf 2)nullAlternativeDescription of the time off daily. When it is a HOLIDAY this is the holiday name.
idstringRequired within parentTime off daily id
Format: uuid
time_off_idstringRequired within parentTime off id. This is the id of the time off request associated with the time off daily.
Format: uuid
typestringRequired within parentType of the time off daily. Can be WORKING_DAY, NON_WORKING_DAY, HOLIDAY or FORFAIT_HOUR_DAY.
Known values: WORKING_DAY, NON_WORKING_DAY, HOLIDAY, FORFAIT_HOUR_DAY
updated_atstringRequired within parentThis is the date when the time off daily was last updated in the database.
Format: date-time

Update time-off request — 200 response body — time off time off event

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalThe date when the time off event was created in the database.
Format: date-time
event_detailsModelOptionalExpand Update time-off request — 200 response body — time off time off event event details
Details of the event associated with the time off request. Required for event based policies such as parental leave.
hris_profile_idstringOptionalThe HRIS profile id of the worker associated with the time off event. Same as the hris_profile_id in the recipient_profile.
Format: uuid
idstringOptionalThe time off event id. This is used to link the time off request to an event.
Format: uuid
policy_idstringOptionalThe policy id associated with the time off event. Same as the policy_id in the time off type.
Format: uuid
time_off_type_idstringOptionalThe time off type id associated with the time off event. Same as the time_off_type_id in the time off request.
Format: uuid
typestringOptionalThe type of the time off event.
Known values: PARENTAL_LEAVE
updated_atstringOptionalThe date when the time off event was last updated in the database.
Format: date-time

Referenced models: Update time-off request — 200 response body — time off time off event event details

Update time-off request — 200 response body — time off time off event event details

FieldTypePresenceDescription and constraints
$objectRootDetails of the event associated with the time off request. Required for event based policies such as parental leave.
adoption_datestringOptionalThe date of adoption. This is used for parental leave requests.
Format: date
birth_datestringOptionalThe birth date of the child. This is used for parental leave requests.
Format: date
estimated_adoption_datestringOptionalThe estimated adoption date of the child. Birth is estimated when the adoption date has not been confirmed yet.
Format: date
estimated_birth_datestringOptionalThe estimated birth date of the child. Birth is estimated when the birth date has not been confirmed yet.
Format: date
had_multiple_childrenbooleanRequired within parentWhether the birth was multiple or not. This is used for parental leave requests.
was_premature_birthbooleanRequired within parentWhether the birth was premature or not. This is used for parental leave requests.

Update time-off request — 200 response body — time off time off type

FieldTypePresenceDescription and constraints
$objectRootThe type of time off taken.
idstringRequired within parentTime off type id.
Format: uuid
namestringRequired within parentTime off type name. Basically the reason or category of time-off taken. For SICK leave, it can be doctor appointment, surgery etc.
policyModelOptionalExpand Update time-off request — 200 response body — time off time off type policy
The policy associated with the time off type.

Referenced models: Update time-off request — 200 response body — time off time off type policy

Update time-off request — 200 response body — time off time off type policy

FieldTypePresenceDescription and constraints
$objectRootThe policy associated with the time off type.
idstringRequired within parentPolicy id
Format: uuid
namestringRequired within parentThe custom name given to policy during policy creation.
policy_typeModelRequired within parentExpand Update time-off request — 200 response body — time off time off type policy policy type

Referenced models: Update time-off request — 200 response body — time off time off type policy policy type

Update time-off request — 200 response body — time off time off type policy policy type

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentPolicy type id
Format: uuid
namestringRequired within parentDepicts the type of policy, like VACATION, SICK etc

Update time-off request — request body — body data

FieldTypePresenceDescription and constraints
$objectRootTime off update request data
contract_oidstring or nullOptionalContract id. This is the id of the contract associated with the time off request.
Maximum length: 24
custom_field_valuesarray or nullOptionalAnswers to the custom fields the request policy declares, addressed by custom field id.
custom_field_values[]ModelEach itemExpand Create time-off request — request body — body data custom field values item
datesarrayOptionalThe dates breakdown for the time off request.
dates[]ModelEach itemExpand Create time-off request — request body — body data dates item
deduction_amountstring or nullOptionalDeduction amount. Available for independent contractor's policies
descriptionstring or nullOptionalDescription of the time off request. Some policies require that a description is provided.
Maximum length: 500
end_dateModelRequired within parentExpand Create time-off request — request body — body data end date
End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day.
event_detailsModelOptionalExpand Update time-off request — request body — body data event details
Details of the event associated with the time off request. Required for event based policies such as parental leave.
is_paidbooleanOptionalWhether the time off is paid or unpaid. By default it follows the policy configuration.
other_type_descriptionstring or nullOptionalDescription of the time off type. This is used when the policy is OTHER.
Maximum length: 255
policy_idstringOptionalThe time off policy id. Can be used in place of time_off_type_id
Format: uuid
reasonstring or nullOptionalReason for taking time off. This is complementary information for the time-off description. Useful to provide sub categories for the same policy.
Maximum length: 500
recipient_profile_idstringRequired within parentThe hris profile id of the recipient
Format: uuid
start_dateModelRequired within parentExpand Create time-off request — request body — body data start date
Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first day.
time_off_event_idstringOptionalThe time off event id. This is used to link the time off request to an event.
Format: uuid
time_off_percentagenumber or nullOptionalThis is the percentage of time off taken. This is used when the time off request is a percentage.
Format: double
Maximum: 1
Minimum: 0
time_off_type_idstringOptionalThe time off type id. Required when policy_id is not provided
Format: uuid

Referenced models: Create time-off request — request body — body data custom field values item, Create time-off request — request body — body data dates item, Create time-off request — request body — body data end date, Create time-off request — request body — body data start date, Update time-off request — request body — body data event details

Update time-off request — request body — body data event details

FieldTypePresenceDescription and constraints
$objectRootDetails of the event associated with the time off request. Required for event based policies such as parental leave.
adoption_datestringOptionalThe date of adoption. This is used for parental leave requests.
Format: date
birth_datestringRequired within parentThe birth date of the child. This is used for parental leave requests.
Format: date
had_multiple_childrenbooleanRequired within parentWhether the birth was multiple or not. This is used for parental leave requests.
is_confirmationbooleanOptionalWhether the event date are a confirmed or not. This is used for parental leave requests when either the birth date or adoption date are not estimated anymore but actually confirmed.
was_premature_birthbooleanRequired within parentWhether the birth was premature or not. This is used for parental leave requests.

Validate time-off request — 200 response body

FieldTypePresenceDescription and constraints
$objectRootTime off request validation result
dataModelRequired within parentExpand Validate time-off request — 200 response body — data
Time off request validation result

Referenced models: Validate time-off request — 200 response body — data

Validate time-off request — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootTime off request validation result
amountstringOptionalThe amount of time off requested.
amount_next_tracking_periodstringOptionalThe amount of time off requested to be applicable in the next tracking period.
country_specific_validation_resultsarrayOptionalResults of country-specific validation rules
country_specific_validation_results[]ModelEach itemExpand Validate time-off request — 200 response body — data country specific validation results item
country_specific_validation_results_next_tracking_periodarrayOptionalResults of country-specific validation rules
country_specific_validation_results_next_tracking_period[]ModelEach itemExpand Validate time-off request — 200 response body — data country specific validation results item
custom_field_validation_resultsarrayOptionalEvery rejected custom field answer. Omitted when all answers are valid.
custom_field_validation_results[]ModelEach itemExpand Validate time-off request — 200 response body — data custom field validation results item
custom_fieldsarrayOptionalThe custom fields the request policy declares. Omitted when the policy declares none.
custom_fields[]ModelEach itemExpand Validate time-off request — 200 response body — data custom fields item
datesarrayOptionalThe dates breakdown for the time off request.
dates[]ModelEach itemExpand Validate time-off request — 200 response body — data dates item
event_details_fieldsModelOptionalExpand Validate time-off request — 200 response body — data event details fields
Fields required for specific time off requests, such as parental leave.
is_event_basedbooleanOptionalIndicates if the time off request is event-based, such as parental leave
is_validbooleanRequired within parentIndicates if the time off request is valid or not. When false, the response will contain an error message.
max_time_off_percentagestringOptionalThe maximum time off percentage allowed for the request
new_end_datestringOptionalThe new end date for the time off request. It could be different from the original end date depending on the policy configuration. For example, for forfait-jour policies
Format: date
new_start_datestringOptionalThe new start date for the time off request. It could be different from the original start date depending on the policy configuration. For example, for forfait-jour policies
Format: date
remaining_balancestringOptionalThe remaining policy balance for the tracking period
remaining_balance_next_tracking_periodstringOptionalThe remaining policy balance for the next tracking period
require_attachmentbooleanOptionalIndicates if an attachment is required for the time off request
require_descriptionbooleanOptionalIndicates if a description is required for the time off request
validation_error_messagestringOptionalError message when the time off request is invalid

Referenced models: Validate time-off request — 200 response body — data custom fields item, Validate time-off request — 200 response body — data country specific validation results item, Validate time-off request — 200 response body — data custom field validation results item, Validate time-off request — 200 response body — data dates item, Validate time-off request — 200 response body — data event details fields

Validate time-off request — 200 response body — data country specific validation results item

FieldTypePresenceDescription and constraints
$objectRootResult of a specific country validation rule
dataModelOptionalExpand Validate time-off request — 200 response body — data country specific validation results item data
descriptionstringOptionalA human-readable description of the validation result
is_validbooleanOptionalIndicates if this specific validation passed
validation_typestringRequired within parentThe type of validation rule being applied

Referenced models: Validate time-off request — 200 response body — data country specific validation results item data

Validate time-off request — 200 response body — data country specific validation results item data

FieldTypePresenceDescription and constraints
$objectRoot
max_requestsJSONOptional
max_requests (anyOf 1)numberAlternativeMaximum number of requests allowed by this validation rule
Format: double
max_requests (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rangesarrayOptionalDate ranges that were validated
ranges[]ModelEach itemExpand Validate time-off request — 200 response body — data country specific validation results item data ranges item
remaining_balanceJSONOptional
remaining_balance (anyOf 1)numberAlternativeRemaining balance at the time of applying this rule
Format: double
remaining_balance (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Validate time-off request — 200 response body — data country specific validation results item data ranges item

Validate time-off request — 200 response body — data country specific validation results item data ranges item

FieldTypePresenceDescription and constraints
$objectRoot
end_dayJSONOptional
end_day (anyOf 1)numberAlternativeThe end day in the range
Format: double
end_day (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start_dayJSONRequired within parent
start_day (anyOf 1)numberAlternativeThe start day in the range
Format: double
start_day (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Validate time-off request — 200 response body — data custom field validation results item

FieldTypePresenceDescription and constraints
$objectRoot
field_idstringOptionalThe id of the rejected custom field. Absent for payload-level errors.
Format: uuid
keystringOptionalMachine key of the rejected field, when it resolved.
messagestringRequired within parentHuman-readable description of the rejection.
reasonstringRequired within parentWhy the answer was rejected.

Validate time-off request — 200 response body — data custom fields item

FieldTypePresenceDescription and constraints
$objectRoot
field_requirementstringRequired within parentWhether an answer is mandatory, and under which conditions.
Known values: ALWAYS_REQUIRED, REQUIRED_CONDITIONALLY, OPTIONAL
idstringRequired within parentThe custom field id.
Format: uuid
keystringRequired within parentMachine key, unique within the policy.
namestringRequired within parentHuman-facing field name shown on the request form.
requirement_conditionsJSONOptional
requirement_conditions (anyOf 1)arrayAlternativePresent only for a REQUIRED_CONDITIONALLY field: the conditions under which it becomes required.
requirement_conditions (anyOf 1)[]ModelEach itemExpand Validate time-off request — 200 response body — data custom fields item requirement conditions null item
requirement_conditions (anyOf 2)nullAlternativePresent only for a REQUIRED_CONDITIONALLY field: the conditions under which it becomes required.
requirement_conditions (anyOf 2)[]ModelEach itemExpand Validate time-off request — 200 response body — data custom fields item requirement conditions null item
schemaModelRequired within parentExpand Validate time-off request — 200 response body — data custom fields item schema
The value type plus shape/constraints of the field.

Referenced models: Validate time-off request — 200 response body — data custom fields item requirement conditions null item, Validate time-off request — 200 response body — data custom fields item schema

Validate time-off request — 200 response body — data custom fields item requirement conditions null item

FieldTypePresenceDescription and constraints
$objectRoot
left_field_keystringOptionalMachine key of the field whose answer is being compared.
operatorstringRequired within parentHow the left field's answer is compared against the right side.
Known values: IS, IS_NOT, IS_ANY_OF, IS_AT_LEAST, IS_AT_MOST, IS_LESS_THAN, IS_MORE_THAN
right_field_keystringOptionalMachine key of another field to compare against, when the right side is itself an answer rather than a static value.
static_itemsJSONOptional
static_items (anyOf 1)arrayAlternativeLiteral list to compare against, for IS_ANY_OF.
static_items (anyOf 1)[]stringEach item
static_items (anyOf 2)nullAlternativeLiteral list to compare against, for IS_ANY_OF.
static_items (anyOf 2)[]stringEach item
static_valueJSONOptional
static_value (anyOf 1)stringAlternativeLiteral value to compare against, for a single-value operator (IS, IS_NOT, IS_AT_LEAST, IS_AT_MOST, IS_LESS_THAN, IS_MORE_THAN).
static_value (anyOf 2)nullAlternativeLiteral value to compare against, for a single-value operator (IS, IS_NOT, IS_AT_LEAST, IS_AT_MOST, IS_LESS_THAN, IS_MORE_THAN).

Validate time-off request — 200 response body — data custom fields item schema

FieldTypePresenceDescription and constraints
$objectRootThe value type plus shape/constraints of the field.
enumarrayOptionalAllowed values, when the field is a closed list.
enum[]stringEach item
is_nullablebooleanRequired within parentWhether the field accepts a null answer. Always `false` today — nullable custom fields are not supported yet, but the flag is present from the start so support can be added later without a breaking change.
typestringRequired within parentThe value type of the field.
Known values: string, number, boolean, date, datetime

Validate time-off request — 200 response body — data dates item

FieldTypePresenceDescription and constraints
$objectRoot
amountstringOptionalThe amount of time off requested for the date. It uses the same time unit as in the total amount for the time off request.
datestringRequired within parentAn specific date in the time-off request
Format: date
day_typesarrayOptionalThe types of leave available for the date. Either FULL_DAY or HALF_DAY.
day_types[]stringEach itemThe type of leave for the day.
Known values: FULL_DAY, HALF_DAY, PERCENTAGE, HOURLY
holiday_namestringOptionalThe name of the holiday for the date. Only applicable for holidays. Only present when date type is HOLIDAY.
hoursarrayOptionalThe maximum allowed number of hours that can be take in this specific date. For example, if there is another leave taking 3 hours in the same date, the maximum allowed hours will be 5 (assuming a work schedule of 8 hours).
hours[]stringEach item
time_off_percentagestringOptionalThe percentage of time off requested for the date. For example, if the request is for a full day, the percentage will be 1. If it's for half a day, the percentage will be 0.5.
typestringRequired within parentThe type of day for the time off request. All dates must follow the same type.
Known values: WORKING_DAY, NON_WORKING_DAY, HOLIDAY, FORFAIT_HOUR_DAY

Validate time-off request — 200 response body — data event details fields

FieldTypePresenceDescription and constraints
$objectRootFields required for specific time off requests, such as parental leave.
adoption_dateModelOptionalExpand Validate time-off request — 200 response body — data event details fields adoption date
The adoption-date of the child. Might be required depending on the type if leave requests.
birth_dateModelOptionalExpand Validate time-off request — 200 response body — data event details fields birth date
The birth-date of the child. Required for parental leave requests.
had_multiple_childrenModelOptionalExpand Validate time-off request — 200 response body — data event details fields had multiple children
Indicates if the request is for multiple children. Required for parental leave requests.
was_premature_birthModelOptionalExpand Validate time-off request — 200 response body — data event details fields was premature birth
Indicates if the child was born prematurely. Required for parental leave requests.

Referenced models: Validate time-off request — 200 response body — data event details fields adoption date, Validate time-off request — 200 response body — data event details fields birth date, Validate time-off request — 200 response body — data event details fields had multiple children, Validate time-off request — 200 response body — data event details fields was premature birth

Validate time-off request — 200 response body — data event details fields adoption date

FieldTypePresenceDescription and constraints
$objectRootThe adoption-date of the child. Might be required depending on the type if leave requests.
requiredbooleanRequired within parentIndicates if the field is required
typestringRequired within parentThe type of the field, indicating it is a date-only field
Known values: date-only

Validate time-off request — 200 response body — data event details fields birth date

FieldTypePresenceDescription and constraints
$objectRootThe birth-date of the child. Required for parental leave requests.
requiredbooleanRequired within parentIndicates if the field is required
typestringRequired within parentThe type of the field, indicating it is a date-only field
Known values: date-only

Validate time-off request — 200 response body — data event details fields had multiple children

FieldTypePresenceDescription and constraints
$objectRootIndicates if the request is for multiple children. Required for parental leave requests.
requiredbooleanRequired within parentIndicates if the field is required
typestringRequired within parentThe type of the field, indicating it is a boolean field
Known values: boolean

Validate time-off request — 200 response body — data event details fields was premature birth

FieldTypePresenceDescription and constraints
$objectRootIndicates if the child was born prematurely. Required for parental leave requests.
requiredbooleanRequired within parentIndicates if the field is required
typestringRequired within parentThe type of the field, indicating it is a boolean field
Known values: boolean

Validate time-off request — request body — body data

FieldTypePresenceDescription and constraints
$objectRootTime off request data
custom_field_valuesarray or nullOptionalAnswers to the custom fields the request policy declares, addressed by custom field id.
custom_field_values[]ModelEach itemExpand Create time-off request — request body — body data custom field values item
datesarrayOptionalThe dates breakdown for the time off request.
dates[]ModelEach itemExpand Validate time-off request — request body — body data dates item
deduction_amountstringOptionalThe amount to be deducted from the time off balance. Only valid for policies used by independent contractors
descriptionstring or nullOptionalThe description of the time off request
Maximum length: 500
end_datestringRequired within parentThe end date of the time off request.
Format: date
event_detailsModelOptionalExpand Validate time-off request — request body — body data event details
Event details regarding the leave. Required for event based policies such as parental leave.
idstringOptionalThe time off id. Required when validating a time off update request
is_paidbooleanOptionalIndicates if the time off request is paid or not. By default it follows the policy configuration.
policy_idstringOptionalThe time off policy id. Can be used in place of time_off_type_id
recipient_profile_idstringRequired within parentThe hris profile id of the recipient
start_datestringRequired within parentThe start date of the time off request.
Format: date
time_off_event_idstringOptionalThe time off event id that this request is associated with. Only present for event-based policies such as parental leave.
time_off_percentagestring or nullOptionalThe percentage of time off requested. For example, if the request is for a full day, the percentage will be 1. If it's for half a day, the percentage will be 0.5.
time_off_type_idstringOptionalThe time off type id. Required when policy_id is not provided

Referenced models: Create time-off request — request body — body data custom field values item, Validate time-off request — request body — body data dates item, Validate time-off request — request body — body data event details

Validate time-off request — request body — body data dates item

FieldTypePresenceDescription and constraints
$objectRootThe dates breakdown for the time off request.
amountstringOptionalThe amount of time off requested for the date. It must be in the same time unit as in the total amount for the time off request.
datestringRequired within parentAn specific date in the time-off request
Format: date
day_typestringOptionalThe type of day for the time off request. All dates must follow the same type.
One of: HALF_DAY, FULL_DAY, PERCENTAGE, HOURLY
hoursstringOptionalThe amount taken in hours during this specific date. It can not exceed the maximum allowed hours for the date.

Validate time-off request — request body — body data event details

FieldTypePresenceDescription and constraints
$objectRootEvent details regarding the leave. Required for event based policies such as parental leave.
adoption_datestringOptionalThe adoption-date of the child. Required depending on the type of the leave requests.
Format: date
birth_datestringOptionalThe birth-date of the child. Required for parental leave requests.
Format: date
had_multiple_childrenbooleanOptionalIndicates if the request is for multiple children. Required for parental leave requests.
was_premature_birthbooleanOptionalIndicates if the child was born prematurely. Required for parental leave requests.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.