Skip to content

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

Retrieve policy validation templates: 200 response body, field data / policy_validation_templates / item. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: 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

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.