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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
adoption_date_definition | string | Optional | Rule regarding the requirement of an adoption date for relevant policies. Known values: REQUIRED, OPTIONAL, FORBIDDEN |
allow_approvers_to_request | boolean | Optional | Whether designated approvers can also request time off under this policy. |
allow_estimated_end_date | boolean | Optional | Whether an estimated end date can be provided for the time off request. |
allow_time_off_payment_treatment_upsert | JSON | Optional | |
allow_time_off_payment_treatment_upsert (anyOf 1) | boolean | Alternative | Whether payment treatment details can be updated. |
allow_time_off_payment_treatment_upsert (anyOf 2) | null | Alternative | Whether payment treatment details can be updated. |
allow_to_edit_past_time_offs | boolean | Optional | Whether past time off requests under this policy can be edited. |
attachment_condition | JSON | Optional | Comparison operator if attachment is conditionally required. |
attachment_condition (anyOf 1) | string | Alternative | Comparison operator if attachment is conditionally required. Known values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL |
attachment_condition (anyOf 2) | null | Alternative | |
attachment_condition_amount | JSON | Optional | |
attachment_condition_amount (anyOf 1) | JSON | Alternative | |
attachment_condition_amount (anyOf 1) (anyOf 1) | integer | Alternative | Threshold amount for the attachment condition. |
attachment_condition_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
attachment_condition_amount (anyOf 2) | null | Alternative | Threshold amount for the attachment condition. |
attachment_condition_unit | JSON | Optional | Unit for the attachment condition amount. |
attachment_condition_unit (anyOf 1) | string | Alternative | Unit for the attachment condition amount. Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR |
attachment_condition_unit (anyOf 2) | null | Alternative | |
auto_approval_inactivity_time_unit | JSON | Optional | Unit for the auto-approval inactivity period. |
auto_approval_inactivity_time_unit (anyOf 1) | string | Alternative | Unit for the auto-approval inactivity period. Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR |
auto_approval_inactivity_time_unit (anyOf 2) | null | Alternative | |
auto_approval_inactivity_time_unit_amount | JSON | Optional | |
auto_approval_inactivity_time_unit_amount (anyOf 1) | JSON | Alternative | |
auto_approval_inactivity_time_unit_amount (anyOf 1) (anyOf 1) | integer | Alternative | Amount for the auto-approval inactivity period. |
auto_approval_inactivity_time_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
auto_approval_inactivity_time_unit_amount (anyOf 2) | null | Alternative | Amount for the auto-approval inactivity period. |
benefits_payer_type | string | Optional | Who pays for the benefits associated with this time off. Known values: ORGANIZATION, GOVERNMENT |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Country code associated with this specific template instance, if applicable. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
country (anyOf 2) | null | Alternative | Country code associated with this specific template instance, if applicable. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
default_entitlement_unit_amount | JSON | Optional | |
default_entitlement_unit_amount (anyOf 1) | JSON | Alternative | |
default_entitlement_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | Default amount of entitlement granted per cycle. Format: double |
default_entitlement_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
default_entitlement_unit_amount (anyOf 2) | null | Alternative | Default amount of entitlement granted per cycle. Format: double |
disable_termination_editing | boolean | Optional | Whether editing related to termination is disabled. |
edit_approved_mode | JSON | Optional | Controls edit/cancel permissions on approved time off requests. Supersedes allow_to_edit_past_time_offs. |
edit_approved_mode (anyOf 1) | string | Alternative | Controls 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) | null | Alternative | |
enable_absence_percentage_requests | boolean | Optional | Whether requests can be made as a percentage of the workday. |
enable_accrued_days_for_policy_on_termination_flow | boolean | Optional | Calculate accrued days specifically for this policy during termination. |
enable_high_accuracy_accrued_days_on_termination_flow | boolean | Optional | Use high accuracy calculation for accrued days during termination. |
enable_pay_out_balance | boolean | Optional | Whether unused balance can be paid out. |
enabled_policy_fields | JSON | Optional | |
enabled_policy_fields (anyOf 1) | array | Alternative | List of specific policy fields that are enabled or configurable. |
enabled_policy_fields (anyOf 1)[] | string | Each item | |
enabled_policy_fields (anyOf 2) | null | Alternative | List of specific policy fields that are enabled or configurable. |
enabled_policy_fields (anyOf 2)[] | string | Each item | |
estimated_end_date_client_reminder | JSON | Optional | |
estimated_end_date_client_reminder (anyOf 1) | array | Alternative | Days before estimated end date to remind the client/manager. |
estimated_end_date_client_reminder (anyOf 1)[] | JSON | Each item | |
estimated_end_date_client_reminder (anyOf 1)[] (anyOf 1) | integer | Alternative | |
estimated_end_date_client_reminder (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
estimated_end_date_client_reminder (anyOf 2) | null | Alternative | Days before estimated end date to remind the client/manager. |
estimated_end_date_client_reminder (anyOf 2)[] | JSON | Each item | |
estimated_end_date_client_reminder (anyOf 2)[] (anyOf 1) | integer | Alternative | |
estimated_end_date_client_reminder (anyOf 2)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
estimated_end_date_worker_reminder | JSON | Optional | |
estimated_end_date_worker_reminder (anyOf 1) | array | Alternative | Days before estimated end date to remind the worker. |
estimated_end_date_worker_reminder (anyOf 1)[] | JSON | Each item | |
estimated_end_date_worker_reminder (anyOf 1)[] (anyOf 1) | integer | Alternative | |
estimated_end_date_worker_reminder (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
estimated_end_date_worker_reminder (anyOf 2) | null | Alternative | Days before estimated end date to remind the worker. |
estimated_end_date_worker_reminder (anyOf 2)[] | JSON | Each item | |
estimated_end_date_worker_reminder (anyOf 2)[] (anyOf 1) | integer | Alternative | |
estimated_end_date_worker_reminder (anyOf 2)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Optional | Unique identifier for the policy validation template. Format: uuid |
include_in_termination_flow | boolean | Optional | Whether this policy is considered during the termination process. |
is_auto_approval_on_inactivity_enabled | JSON | Optional | |
is_auto_approval_on_inactivity_enabled (anyOf 1) | boolean | Alternative | Whether requests are automatically approved after a period of inactivity. |
is_auto_approval_on_inactivity_enabled (anyOf 2) | null | Alternative | Whether requests are automatically approved after a period of inactivity. |
is_payment_top_off | boolean | Optional | Indicates if the policy involves payment top-offs. |
leave_type | string | Optional | Classification of the leave duration. Known values: SHORT_TERM_LEAVE, LONG_TERM_LEAVE |
max_entitlement_unit_amount | JSON | Optional | |
max_entitlement_unit_amount (anyOf 1) | JSON | Alternative | |
max_entitlement_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | Maximum allowed entitlement amount. Format: double |
max_entitlement_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_entitlement_unit_amount (anyOf 2) | null | Alternative | Maximum allowed entitlement amount. Format: double |
max_request_start_unit_amount | JSON | Optional | |
max_request_start_unit_amount (anyOf 1) | JSON | Alternative | |
max_request_start_unit_amount (anyOf 1) (anyOf 1) | integer | Alternative | Maximum waiting period amount if request_start_type is FIXED_PERIOD. |
max_request_start_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_request_start_unit_amount (anyOf 2) | null | Alternative | Maximum waiting period amount if request_start_type is FIXED_PERIOD. |
max_time_off_per_tracking | JSON | Optional | |
max_time_off_per_tracking (anyOf 1) | JSON | Alternative | |
max_time_off_per_tracking (anyOf 1) (anyOf 1) | number | Alternative | Maximum amount of time off allowed per tracking cycle. Format: double |
max_time_off_per_tracking (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_time_off_per_tracking (anyOf 2) | null | Alternative | Maximum amount of time off allowed per tracking cycle. Format: double |
max_tracking_unit_amount | JSON | Optional | |
max_tracking_unit_amount (anyOf 1) | JSON | Alternative | |
max_tracking_unit_amount (anyOf 1) (anyOf 1) | integer | Alternative | Maximum duration of the tracking cycle in tracking_unit. |
max_tracking_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_tracking_unit_amount (anyOf 2) | null | Alternative | Maximum duration of the tracking cycle in tracking_unit. |
maximum_time_off_request_amount | JSON | Optional | |
maximum_time_off_request_amount (anyOf 1) | JSON | Alternative | |
maximum_time_off_request_amount (anyOf 1) (anyOf 1) | number | Alternative | Maximum amount that can be requested in a single time off request. Format: double |
maximum_time_off_request_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maximum_time_off_request_amount (anyOf 2) | null | Alternative | Maximum amount that can be requested in a single time off request. Format: double |
min_entitlement_unit_amount | JSON | Optional | |
min_entitlement_unit_amount (anyOf 1) | JSON | Alternative | |
min_entitlement_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | Minimum allowed entitlement amount. Format: double |
min_entitlement_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_entitlement_unit_amount (anyOf 2) | null | Alternative | Minimum allowed entitlement amount. Format: double |
min_request_start_unit_amount | JSON | Optional | |
min_request_start_unit_amount (anyOf 1) | JSON | Alternative | |
min_request_start_unit_amount (anyOf 1) (anyOf 1) | integer | Alternative | Minimum waiting period amount if request_start_type is FIXED_PERIOD. |
min_request_start_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_request_start_unit_amount (anyOf 2) | null | Alternative | Minimum waiting period amount if request_start_type is FIXED_PERIOD. |
min_time_off_per_tracking | JSON | Optional | |
min_time_off_per_tracking (anyOf 1) | JSON | Alternative | |
min_time_off_per_tracking (anyOf 1) (anyOf 1) | number | Alternative | Minimum amount of time off required per tracking cycle. Format: double |
min_time_off_per_tracking (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_time_off_per_tracking (anyOf 2) | null | Alternative | Minimum amount of time off required per tracking cycle. Format: double |
min_tracking_unit_amount | JSON | Optional | |
min_tracking_unit_amount (anyOf 1) | JSON | Alternative | |
min_tracking_unit_amount (anyOf 1) (anyOf 1) | integer | Alternative | Minimum duration of the tracking cycle in tracking_unit. |
min_tracking_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_tracking_unit_amount (anyOf 2) | null | Alternative | Minimum duration of the tracking cycle in tracking_unit. |
minimum_time_off_request_amount | JSON | Optional | |
minimum_time_off_request_amount (anyOf 1) | JSON | Alternative | |
minimum_time_off_request_amount (anyOf 1) (anyOf 1) | number | Alternative | Minimum amount that can be requested in a single time off request. Format: double |
minimum_time_off_request_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minimum_time_off_request_amount (anyOf 2) | null | Alternative | Minimum amount that can be requested in a single time off request. Format: double |
notice_period_unit | JSON | Optional | Unit for the required notice period. |
notice_period_unit (anyOf 1) | string | Alternative | Unit for the required notice period. Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR |
notice_period_unit (anyOf 2) | null | Alternative | |
notice_period_unit_amount | JSON | Optional | |
notice_period_unit_amount (anyOf 1) | JSON | Alternative | |
notice_period_unit_amount (anyOf 1) (anyOf 1) | integer | Alternative | Amount for the required notice period. |
notice_period_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
notice_period_unit_amount (anyOf 2) | null | Alternative | Amount for the required notice period. |
ops_workbench_process_template_reference | JSON | Optional | |
ops_workbench_process_template_reference (anyOf 1) | string | Alternative | Reference to an Ops Workbench process template, if applicable. |
ops_workbench_process_template_reference (anyOf 2) | null | Alternative | Reference to an Ops Workbench process template, if applicable. |
overlap_request_type | string | Optional | Rule for requesting time off that overlaps with existing requests. Known values: ALLOWED, NOT_ALLOWED, ALLOWED_WITH_APPROVAL |
policy_allowance_proration | JSON | Optional | Proration rules applied to the policy allowances. |
policy_allowance_proration (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
policy_allowances | array | Optional | List of allowances defined within this policy template. |
policy_allowances[] | Model | Each item | Expand Retrieve policy validation templates — 200 response body — data policy validation templates item policy allowances item |
policy_type | Model | Optional | Expand Retrieve policy validation templates — 200 response body — data policy validation templates item policy type Details of the associated policy type. |
policy_type_id | string | Optional | Identifier of the associated policy type. Format: uuid |
policy_validation_template_reminders | array | Optional | Configuration for reminders related to this policy template. |
policy_validation_template_reminders[] | Model | Each item | Expand Get Organization Structure — 200 response body — data teams item |
request_start_type | JSON | Optional | When a worker can start requesting time off after becoming eligible. |
request_start_type (anyOf 1) | string | Alternative | When a worker can start requesting time off after becoming eligible. Known values: IMMEDIATELY, FIXED_PERIOD |
request_start_type (anyOf 2) | null | Alternative | |
request_start_unit | JSON | Optional | Unit for the waiting period if request_start_type is FIXED_PERIOD. |
request_start_unit (anyOf 1) | string | Alternative | Unit 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) | null | Alternative | |
require_notice_period | JSON | Optional | |
require_notice_period (anyOf 1) | boolean | Alternative | Whether a notice period is required before taking time off. |
require_notice_period (anyOf 2) | null | Alternative | Whether a notice period is required before taking time off. |
retrospective_request_type | string | Optional | Rule for requesting time off for past dates. Known values: ALLOWED, NOT_ALLOWED, ALLOWED_WITH_APPROVAL |
template_name | JSON | Optional | |
template_name (anyOf 1) | string | Alternative | Optional name for this specific template instance. |
template_name (anyOf 2) | null | Alternative | Optional name for this specific template instance. |
time_off_request_type | string | Optional | Allowed types of time off requests (e.g., full day, hourly). Known values: FULL_DAY, HALF_DAY, HOURLY, PERCENTAGE, FLEXIBLE |
time_off_type_validations | array | Optional | Specific validation rules applied to time off types under this policy. |
time_off_type_validations[] | Model | Each item | Expand Get Organization Structure — 200 response body — data teams item |
tracking_cadence | string | Optional | Determines when the tracking cycle starts. Known values: FIXED_DAY, ANNIVERSARY, NOT_SPECIFIED |
tracking_start_date | JSON | Optional | |
tracking_start_date (anyOf 1) | string | Alternative | Specific start date for FIXED_DAY tracking cadence (YYYY-MM-DD). Format: date |
tracking_start_date (anyOf 2) | null | Alternative | Specific start date for FIXED_DAY tracking cadence (YYYY-MM-DD). Format: date |
tracking_unit | JSON | Optional | The unit used for tracking the policy cycle (e.g., yearly). |
tracking_unit (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
upload_attachment_condition | string | Optional | Condition 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Proration rules applied to the policy allowances. |
has_partial_prorate | boolean | Optional | Indicates if partial proration rules are applied. |
hire_proration_cut_off_date | JSON | Optional | |
hire_proration_cut_off_date (anyOf 1) | JSON | Alternative | |
hire_proration_cut_off_date (anyOf 1) (anyOf 1) | integer | Alternative | Day of the month used as cut-off for hire proration. |
hire_proration_cut_off_date (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hire_proration_cut_off_date (anyOf 2) | null | Alternative | Day of the month used as cut-off for hire proration. |
hire_proration_rule | string | Optional | Rule 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 |
id | string | Optional | Unique identifier for the proration settings. Format: uuid |
is_accrual_prorate_policy | boolean | Optional | Indicates if accrual is prorated based on policy rules. |
max_part_time_worker_treatment_specific_amount | JSON | Optional | |
max_part_time_worker_treatment_specific_amount (anyOf 1) | JSON | Alternative | |
max_part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 1) | number | Alternative | Maximum specific amount for part-time treatment. Format: double |
max_part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_part_time_worker_treatment_specific_amount (anyOf 2) | null | Alternative | Maximum specific amount for part-time treatment. Format: double |
min_part_time_worker_treatment_specific_amount | JSON | Optional | |
min_part_time_worker_treatment_specific_amount (anyOf 1) | JSON | Alternative | |
min_part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 1) | number | Alternative | Minimum specific amount for part-time treatment. Format: double |
min_part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_part_time_worker_treatment_specific_amount (anyOf 2) | null | Alternative | Minimum specific amount for part-time treatment. Format: double |
part_time_worker_treatment_specific_amount | JSON | Optional | |
part_time_worker_treatment_specific_amount (anyOf 1) | JSON | Alternative | |
part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 1) | number | Alternative | Specific amount if treatment type is SPECIFIC_AMOUNT. Format: double |
part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
part_time_worker_treatment_specific_amount (anyOf 2) | null | Alternative | Specific amount if treatment type is SPECIFIC_AMOUNT. Format: double |
part_time_worker_treatment_type | string | Optional | How 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_date | JSON | Optional | |
termination_proration_cut_off_date (anyOf 1) | JSON | Alternative | |
termination_proration_cut_off_date (anyOf 1) (anyOf 1) | integer | Alternative | Day of the month used as cut-off for termination proration. |
termination_proration_cut_off_date (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
termination_proration_cut_off_date (anyOf 2) | null | Alternative | Day of the month used as cut-off for termination proration. |
termination_proration_rule | string | Optional | Rule 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accrual_application_type | JSON | Optional | When the accrued amount is applied to the balance. |
accrual_application_type (anyOf 1) | string | Alternative | When 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) | null | Alternative | |
accrual_prorate_types | JSON | Optional | |
accrual_prorate_types (anyOf 1) | array | Alternative | Specifies conditions under which accrual should be prorated. |
accrual_prorate_types (anyOf 1)[] | string | Each item | Known values: PRORATE_UNPAID_LEAVE, PRORATE_PAID_LEAVE, NO_PRORATE |
accrual_prorate_types (anyOf 2) | null | Alternative | Specifies conditions under which accrual should be prorated. |
accrual_prorate_types (anyOf 2)[] | string | Each item | Known values: PRORATE_UNPAID_LEAVE, PRORATE_PAID_LEAVE, NO_PRORATE |
accrual_type | string | Optional | How entitlement accrues (over time or based on events). Known values: TIMEFRAME, EVENT, TIME_OFF_IN_LIEU, HOURLY, LUMPSUM, NO_AUTO_ACCRUAL |
accrual_unit | JSON | Optional | Unit for accrual if type is TIMEFRAME. |
accrual_unit (anyOf 1) | string | Alternative | Unit for accrual if type is TIMEFRAME. Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR |
accrual_unit (anyOf 2) | null | Alternative | |
accrual_unit_amount | JSON | Optional | |
accrual_unit_amount (anyOf 1) | JSON | Alternative | |
accrual_unit_amount (anyOf 1) (anyOf 1) | integer | Alternative | Amount of accrual per unit if type is TIMEFRAME. |
accrual_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
accrual_unit_amount (anyOf 2) | null | Alternative | Amount of accrual per unit if type is TIMEFRAME. |
additional_allowance_rules | array | Optional | Specific rules governing additional allowances. |
additional_allowance_rules[] | Model | Each item | Expand Get Organization Structure — 200 response body — data teams item |
balance_tracking_flexible_custom_request_amount | JSON | Optional | |
balance_tracking_flexible_custom_request_amount (anyOf 1) | JSON | Alternative | |
balance_tracking_flexible_custom_request_amount (anyOf 1) (anyOf 1) | integer | Alternative | Custom amount for flexible balance tracking if applicable. |
balance_tracking_flexible_custom_request_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
balance_tracking_flexible_custom_request_amount (anyOf 2) | null | Alternative | Custom amount for flexible balance tracking if applicable. |
balance_tracking_type | JSON | Optional | How the balance is tracked (e.g., flexible, inflexible). |
balance_tracking_type (anyOf 1) | string | Alternative | How 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) | null | Alternative | |
enable_bank_holidays | boolean | Optional | Whether bank holidays affect the entitlement or usage. |
entitlement_expiration_unit | JSON | Optional | Unit for entitlement expiration period. |
entitlement_expiration_unit (anyOf 1) | string | Alternative | Unit for entitlement expiration period. Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR |
entitlement_expiration_unit (anyOf 2) | null | Alternative | |
entitlement_expiration_unit_amount | JSON | Optional | |
entitlement_expiration_unit_amount (anyOf 1) | JSON | Alternative | |
entitlement_expiration_unit_amount (anyOf 1) (anyOf 1) | integer | Alternative | Amount for entitlement expiration period. |
entitlement_expiration_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
entitlement_expiration_unit_amount (anyOf 2) | null | Alternative | Amount for entitlement expiration period. |
entitlement_start_type | JSON | Optional | When the entitlement starts. |
entitlement_start_type (anyOf 1) | string | Alternative | When the entitlement starts. Known values: IMMEDIATELY, FIXED_PERIOD, FIXED_DATE |
entitlement_start_type (anyOf 2) | null | Alternative | |
entitlement_start_unit | JSON | Optional | Unit for the start period if type is FIXED_PERIOD. |
entitlement_start_unit (anyOf 1) | string | Alternative | Unit 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) | null | Alternative | |
entitlement_start_unit_amount | JSON | Optional | |
entitlement_start_unit_amount (anyOf 1) | JSON | Alternative | |
entitlement_start_unit_amount (anyOf 1) (anyOf 1) | integer | Alternative | Amount for the start period if type is FIXED_PERIOD. |
entitlement_start_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
entitlement_start_unit_amount (anyOf 2) | null | Alternative | Amount for the start period if type is FIXED_PERIOD. |
entitlement_unit | string | Optional | Unit in which the entitlement is measured. Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR |
entitlement_unit_amount | JSON | Optional | |
entitlement_unit_amount (anyOf 1) | JSON | Alternative | |
entitlement_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | Amount of entitlement granted in entitlement_unit. Format: double |
entitlement_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
entitlement_unit_amount (anyOf 2) | null | Alternative | Amount of entitlement granted in entitlement_unit. Format: double |
id | string | Optional | Unique identifier for the policy allowance. Format: uuid |
name | string | Optional | Name of the allowance. |
part_time_worker_additional_allowance_type | string | Optional | How additional allowances apply to part-time workers. Known values: SAME_AS_FTE, PERCENTAGE_OF_FTE, NO_ADDITIONAL_ALLOWANCE |
rollover_expiration_unit | JSON | Optional | Unit for the expiration period of rolled-over balance. |
rollover_expiration_unit (anyOf 1) | string | Alternative | Unit for the expiration period of rolled-over balance. Known values: YEAR, MONTH, WEEK, DAY, BUSINESS_DAY, CALENDAR_DAY, HOUR |
rollover_expiration_unit (anyOf 2) | null | Alternative | |
rollover_expiration_unit_amount | JSON | Optional | |
rollover_expiration_unit_amount (anyOf 1) | JSON | Alternative | |
rollover_expiration_unit_amount (anyOf 1) (anyOf 1) | integer | Alternative | Amount for the expiration period of rolled-over balance. |
rollover_expiration_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rollover_expiration_unit_amount (anyOf 2) | null | Alternative | Amount for the expiration period of rolled-over balance. |
rollover_limit_unit_amount | JSON | Optional | |
rollover_limit_unit_amount (anyOf 1) | JSON | Alternative | |
rollover_limit_unit_amount (anyOf 1) (anyOf 1) | integer | Alternative | Maximum amount that can be rolled over if type is LIMITED_ROLLOVER. |
rollover_limit_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rollover_limit_unit_amount (anyOf 2) | null | Alternative | Maximum amount that can be rolled over if type is LIMITED_ROLLOVER. |
rollover_type | JSON | Optional | Rule for carrying over unused balance to the next cycle. |
rollover_type (anyOf 1) | string | Alternative | Rule 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) | null | Alternative | |
termination_type | string | Optional | Rule for handling the balance upon termination. Known values: NO_PAYOUT, PAYOUT_BALANCE |
type | string | Optional | Type of allowance (base or additional). Known values: BASE_ALLOWANCE, ADDITIONAL_ALLOWANCE |
zero_out_negative_balances_on_rollover | boolean | Optional | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the associated policy type. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the policy type. |
description (anyOf 2) | null | Alternative | Description of the policy type. |
id | string | Optional | Unique identifier of the policy type. Format: uuid |
name | string | Optional | Name of the policy type. |
Update time-off request — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Time off data to be updated |
time_off | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Used to return the updated time off request after modification. Contains all the time off details including status, dates, amounts, and associated metadata. |
amount | string | Required within parent | Amount 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_at | JSON | Optional | |
approved_at (anyOf 1) | string | Alternative | This 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) | null | Alternative | This 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 |
attachments | array | Optional | List of attachments associated with the time off request. |
attachments[] | Model | Each item | Expand Update time-off request — 200 response body — time off attachments item |
canceled_at | JSON | Optional | |
canceled_at (anyOf 1) | string | Alternative | Time off cancellation date Format: date-time |
canceled_at (anyOf 2) | null | Alternative | Time off cancellation date Format: date-time |
contract_oid | string | Optional | Contract id. This is the id of the contract associated with the time off request. |
created_at | string | Required within parent | This is the date when the time off request was created in the database. Format: date-time |
custom_field_values | array | Optional | Answers to the custom fields the request policy declares. Omitted when the policy declares none. |
custom_field_values[] | Model | Each item | Expand Update time-off request — 200 response body — time off custom field values item |
deduction_amount | string | Optional | Deduction amount. Available for independent contractor's policies |
deleted_at | JSON | Optional | |
deleted_at (anyOf 1) | string | Alternative | Time 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) | null | Alternative | Time off deletion date. Present only when the time-off is soft-deleted and include_deleted_time_offs was requested. Format: date-time |
description | string | Optional | Description of the time off request. Some policies require that a description is provided. |
end_date | string | Required within parent | 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. Format: date |
entitlement_unit | string | Required within parent | The unit in which the time off usage and entitlement are calculated. Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
half_end_date | boolean | Required within parent | Whether the end date is a half day or not. |
half_start_date | boolean | Required within parent | Whether the start date is a half day or not. |
is_end_date_estimated | boolean | Optional | Used 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_paid | boolean | Required within parent | Whether the time off is paid or unpaid. |
other_type_description | string | Optional | Used 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. |
reason | string | Optional | Reason for taking time off. This is complementary information for the time-off description. Useful to provide sub categories for the same policy. |
recipient_profile | Model | Optional | Expand 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_at | string | Required within parent | This is the date when the time off request was made. Format: date |
requester_profile | Model | Optional | Expand 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_date | string | Required within parent | 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. Format: date |
status | string | Optional | Status of the time off request. Can be REQUESTED, APPROVED, REJECTED, USED or CANCELED. Known values: REQUESTED, APPROVED, REJECTED, USED, CANCELED, DELETED |
time_off_dailies | array | Optional | Used 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[] | Model | Each item | Expand Update time-off request — 200 response body — time off time off dailies item |
time_off_event | Model | Optional | Expand Update time-off request — 200 response body — time off time off event |
time_off_percentage | string | Optional | Used 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_type | Model | Optional | Expand Update time-off request — 200 response body — time off time off type The type of time off taken. |
time_off_type_id | string | Required within parent | Time off type id. This is the id of the time off type associated with the time off request. Format: uuid |
updated_at | string | Required within parent | This 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An attachment associated with the time off request. |
created_at | string | Required within parent | This is the date when the attachment was created in the database. Format: date-time |
filename | string | Required within parent | Filename of the attachment |
id | string | Required within parent | Attachment id Format: uuid |
updated_at | string | Required within parent | This 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_id | string | Required within parent | The id of the custom field this value answers. Format: uuid |
value | JSON | Required within parent | |
value (anyOf 1) | string | Alternative | The submitted value for the custom field, serialized as text. When no value is provided, this will be null. |
value (anyOf 2) | null | Alternative | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The time off profile of the recipient of the time off request. Must be a worker profile. |
hris_profile_id | string | Required within parent | The worker HRIS profile id in the given organization. Format: uuid |
organization_id | string | Required within parent | Id of the organization the profile belongs to. Format: uuid |
Update time-off request — 200 response body — time off requester profile
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The time off profile of the requester of the time off request. Can be either a client or worker profile. |
client_profile_id | string | Optional | Id of the client profile. Available when the requester is a client. Format: uuid |
hris_profile_id | string | Optional | The worker HRIS profile id in the given organization. Available when the requester is a worker. Format: uuid |
organization_id | string | Required within parent | Id of the organization the profile belongs to. Format: uuid |
Update time-off request — 200 response body — time off time off dailies item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | Amount of time off taken in this specific date. |
created_at | string | Required within parent | This is the date when the time off daily was created in the database. Format: date-time |
date | string | Required within parent | Date of the time off daily. This is the date when the time off was taken. Format: date |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the time off daily. When it is a HOLIDAY this is the holiday name. |
description (anyOf 2) | null | Alternative | Description of the time off daily. When it is a HOLIDAY this is the holiday name. |
id | string | Required within parent | Time off daily id Format: uuid |
time_off_id | string | Required within parent | Time off id. This is the id of the time off request associated with the time off daily. Format: uuid |
type | string | Required within parent | Type 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_at | string | Required within parent | This 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | The date when the time off event was created in the database. Format: date-time |
event_details | Model | Optional | Expand 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_id | string | Optional | The HRIS profile id of the worker associated with the time off event. Same as the hris_profile_id in the recipient_profile. Format: uuid |
id | string | Optional | The time off event id. This is used to link the time off request to an event. Format: uuid |
policy_id | string | Optional | The policy id associated with the time off event. Same as the policy_id in the time off type. Format: uuid |
time_off_type_id | string | Optional | The time off type id associated with the time off event. Same as the time_off_type_id in the time off request. Format: uuid |
type | string | Optional | The type of the time off event. Known values: PARENTAL_LEAVE |
updated_at | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the event associated with the time off request. Required for event based policies such as parental leave. |
adoption_date | string | Optional | The date of adoption. This is used for parental leave requests. Format: date |
birth_date | string | Optional | The birth date of the child. This is used for parental leave requests. Format: date |
estimated_adoption_date | string | Optional | The estimated adoption date of the child. Birth is estimated when the adoption date has not been confirmed yet. Format: date |
estimated_birth_date | string | Optional | The estimated birth date of the child. Birth is estimated when the birth date has not been confirmed yet. Format: date |
had_multiple_children | boolean | Required within parent | Whether the birth was multiple or not. This is used for parental leave requests. |
was_premature_birth | boolean | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The type of time off taken. |
id | string | Required within parent | Time off type id. Format: uuid |
name | string | Required within parent | Time off type name. Basically the reason or category of time-off taken. For SICK leave, it can be doctor appointment, surgery etc. |
policy | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The policy associated with the time off type. |
id | string | Required within parent | Policy id Format: uuid |
name | string | Required within parent | The custom name given to policy during policy creation. |
policy_type | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Policy type id Format: uuid |
name | string | Required within parent | Depicts the type of policy, like VACATION, SICK etc |
Update time-off request — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Time off update request data |
contract_oid | string or null | Optional | Contract id. This is the id of the contract associated with the time off request. Maximum length: 24 |
custom_field_values | array or null | Optional | Answers to the custom fields the request policy declares, addressed by custom field id. |
custom_field_values[] | Model | Each item | Expand Create time-off request — request body — body data custom field values item |
dates | array | Optional | The dates breakdown for the time off request. |
dates[] | Model | Each item | Expand Create time-off request — request body — body data dates item |
deduction_amount | string or null | Optional | Deduction amount. Available for independent contractor's policies |
description | string or null | Optional | Description of the time off request. Some policies require that a description is provided. Maximum length: 500 |
end_date | Model | Required within parent | Expand 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_details | Model | Optional | Expand 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_paid | boolean | Optional | Whether the time off is paid or unpaid. By default it follows the policy configuration. |
other_type_description | string or null | Optional | Description of the time off type. This is used when the policy is OTHER. Maximum length: 255 |
policy_id | string | Optional | The time off policy id. Can be used in place of time_off_type_id Format: uuid |
reason | string or null | Optional | Reason 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_id | string | Required within parent | The hris profile id of the recipient Format: uuid |
start_date | Model | Required within parent | Expand 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_id | string | Optional | The time off event id. This is used to link the time off request to an event. Format: uuid |
time_off_percentage | number or null | Optional | This 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_id | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the event associated with the time off request. Required for event based policies such as parental leave. |
adoption_date | string | Optional | The date of adoption. This is used for parental leave requests. Format: date |
birth_date | string | Required within parent | The birth date of the child. This is used for parental leave requests. Format: date |
had_multiple_children | boolean | Required within parent | Whether the birth was multiple or not. This is used for parental leave requests. |
is_confirmation | boolean | Optional | Whether 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_birth | boolean | Required within parent | Whether the birth was premature or not. This is used for parental leave requests. |
Validate time-off request — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Time off request validation result |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Time off request validation result |
amount | string | Optional | The amount of time off requested. |
amount_next_tracking_period | string | Optional | The amount of time off requested to be applicable in the next tracking period. |
country_specific_validation_results | array | Optional | Results of country-specific validation rules |
country_specific_validation_results[] | Model | Each item | Expand Validate time-off request — 200 response body — data country specific validation results item |
country_specific_validation_results_next_tracking_period | array | Optional | Results of country-specific validation rules |
country_specific_validation_results_next_tracking_period[] | Model | Each item | Expand Validate time-off request — 200 response body — data country specific validation results item |
custom_field_validation_results | array | Optional | Every rejected custom field answer. Omitted when all answers are valid. |
custom_field_validation_results[] | Model | Each item | Expand Validate time-off request — 200 response body — data custom field validation results item |
custom_fields | array | Optional | The custom fields the request policy declares. Omitted when the policy declares none. |
custom_fields[] | Model | Each item | Expand Validate time-off request — 200 response body — data custom fields item |
dates | array | Optional | The dates breakdown for the time off request. |
dates[] | Model | Each item | Expand Validate time-off request — 200 response body — data dates item |
event_details_fields | Model | Optional | Expand Validate time-off request — 200 response body — data event details fields Fields required for specific time off requests, such as parental leave. |
is_event_based | boolean | Optional | Indicates if the time off request is event-based, such as parental leave |
is_valid | boolean | Required within parent | Indicates if the time off request is valid or not. When false, the response will contain an error message. |
max_time_off_percentage | string | Optional | The maximum time off percentage allowed for the request |
new_end_date | string | Optional | The 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_date | string | Optional | The 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_balance | string | Optional | The remaining policy balance for the tracking period |
remaining_balance_next_tracking_period | string | Optional | The remaining policy balance for the next tracking period |
require_attachment | boolean | Optional | Indicates if an attachment is required for the time off request |
require_description | boolean | Optional | Indicates if a description is required for the time off request |
validation_error_message | string | Optional | Error 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Result of a specific country validation rule |
data | Model | Optional | Expand Validate time-off request — 200 response body — data country specific validation results item data |
description | string | Optional | A human-readable description of the validation result |
is_valid | boolean | Optional | Indicates if this specific validation passed |
validation_type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
max_requests | JSON | Optional | |
max_requests (anyOf 1) | number | Alternative | Maximum number of requests allowed by this validation rule Format: double |
max_requests (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
ranges | array | Optional | Date ranges that were validated |
ranges[] | Model | Each item | Expand Validate time-off request — 200 response body — data country specific validation results item data ranges item |
remaining_balance | JSON | Optional | |
remaining_balance (anyOf 1) | number | Alternative | Remaining balance at the time of applying this rule Format: double |
remaining_balance (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_day | JSON | Optional | |
end_day (anyOf 1) | number | Alternative | The end day in the range Format: double |
end_day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
start_day | JSON | Required within parent | |
start_day (anyOf 1) | number | Alternative | The start day in the range Format: double |
start_day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Validate time-off request — 200 response body — data custom field validation results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_id | string | Optional | The id of the rejected custom field. Absent for payload-level errors. Format: uuid |
key | string | Optional | Machine key of the rejected field, when it resolved. |
message | string | Required within parent | Human-readable description of the rejection. |
reason | string | Required within parent | Why the answer was rejected. |
Validate time-off request — 200 response body — data custom fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
field_requirement | string | Required within parent | Whether an answer is mandatory, and under which conditions. Known values: ALWAYS_REQUIRED, REQUIRED_CONDITIONALLY, OPTIONAL |
id | string | Required within parent | The custom field id. Format: uuid |
key | string | Required within parent | Machine key, unique within the policy. |
name | string | Required within parent | Human-facing field name shown on the request form. |
requirement_conditions | JSON | Optional | |
requirement_conditions (anyOf 1) | array | Alternative | Present only for a REQUIRED_CONDITIONALLY field: the conditions under which it becomes required. |
requirement_conditions (anyOf 1)[] | Model | Each item | Expand Validate time-off request — 200 response body — data custom fields item requirement conditions null item |
requirement_conditions (anyOf 2) | null | Alternative | Present only for a REQUIRED_CONDITIONALLY field: the conditions under which it becomes required. |
requirement_conditions (anyOf 2)[] | Model | Each item | Expand Validate time-off request — 200 response body — data custom fields item requirement conditions null item |
schema | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
left_field_key | string | Optional | Machine key of the field whose answer is being compared. |
operator | string | Required within parent | How 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_key | string | Optional | Machine key of another field to compare against, when the right side is itself an answer rather than a static value. |
static_items | JSON | Optional | |
static_items (anyOf 1) | array | Alternative | Literal list to compare against, for IS_ANY_OF. |
static_items (anyOf 1)[] | string | Each item | |
static_items (anyOf 2) | null | Alternative | Literal list to compare against, for IS_ANY_OF. |
static_items (anyOf 2)[] | string | Each item | |
static_value | JSON | Optional | |
static_value (anyOf 1) | string | Alternative | Literal 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) | null | Alternative | Literal 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The value type plus shape/constraints of the field. |
enum | array | Optional | Allowed values, when the field is a closed list. |
enum[] | string | Each item | |
is_nullable | boolean | Required within parent | Whether 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. |
type | string | Required within parent | The value type of the field. Known values: string, number, boolean, date, datetime |
Validate time-off request — 200 response body — data dates item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Optional | The amount of time off requested for the date. It uses the same time unit as in the total amount for the time off request. |
date | string | Required within parent | An specific date in the time-off request Format: date |
day_types | array | Optional | The types of leave available for the date. Either FULL_DAY or HALF_DAY. |
day_types[] | string | Each item | The type of leave for the day. Known values: FULL_DAY, HALF_DAY, PERCENTAGE, HOURLY |
holiday_name | string | Optional | The name of the holiday for the date. Only applicable for holidays. Only present when date type is HOLIDAY. |
hours | array | Optional | The 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[] | string | Each item | |
time_off_percentage | string | Optional | The 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. |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Fields required for specific time off requests, such as parental leave. |
adoption_date | Model | Optional | Expand 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_date | Model | Optional | Expand 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_children | Model | Optional | Expand 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_birth | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The adoption-date of the child. Might be required depending on the type if leave requests. |
required | boolean | Required within parent | Indicates if the field is required |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The birth-date of the child. Required for parental leave requests. |
required | boolean | Required within parent | Indicates if the field is required |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Indicates if the request is for multiple children. Required for parental leave requests. |
required | boolean | Required within parent | Indicates if the field is required |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Indicates if the child was born prematurely. Required for parental leave requests. |
required | boolean | Required within parent | Indicates if the field is required |
type | string | Required within parent | The type of the field, indicating it is a boolean field Known values: boolean |
Validate time-off request — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Time off request data |
custom_field_values | array or null | Optional | Answers to the custom fields the request policy declares, addressed by custom field id. |
custom_field_values[] | Model | Each item | Expand Create time-off request — request body — body data custom field values item |
dates | array | Optional | The dates breakdown for the time off request. |
dates[] | Model | Each item | Expand Validate time-off request — request body — body data dates item |
deduction_amount | string | Optional | The amount to be deducted from the time off balance. Only valid for policies used by independent contractors |
description | string or null | Optional | The description of the time off request Maximum length: 500 |
end_date | string | Required within parent | The end date of the time off request. Format: date |
event_details | Model | Optional | Expand Validate time-off request — request body — body data event details Event details regarding the leave. Required for event based policies such as parental leave. |
id | string | Optional | The time off id. Required when validating a time off update request |
is_paid | boolean | Optional | Indicates if the time off request is paid or not. By default it follows the policy configuration. |
policy_id | string | Optional | The time off policy id. Can be used in place of time_off_type_id |
recipient_profile_id | string | Required within parent | The hris profile id of the recipient |
start_date | string | Required within parent | The start date of the time off request. Format: date |
time_off_event_id | string | Optional | The time off event id that this request is associated with. Only present for event-based policies such as parental leave. |
time_off_percentage | string or null | Optional | The 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_id | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The dates breakdown for the time off request. |
amount | string | Optional | The 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. |
date | string | Required within parent | An specific date in the time-off request Format: date |
day_type | string | Optional | The type of day for the time off request. All dates must follow the same type. One of: HALF_DAY, FULL_DAY, PERCENTAGE, HOURLY |
hours | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Event details regarding the leave. Required for event based policies such as parental leave. |
adoption_date | string | Optional | The adoption-date of the child. Required depending on the type of the leave requests. Format: date |
birth_date | string | Optional | The birth-date of the child. Required for parental leave requests. Format: date |
had_multiple_children | boolean | Optional | Indicates if the request is for multiple children. Required for parental leave requests. |
was_premature_birth | boolean | Optional | Indicates if the child was born prematurely. Required for parental leave requests. |