Deel: Retrieve policy validation templates — 200 response body — data policy validation templates item policy allowances item
Retrieve policy validation templates: 200 response body, field data / policy_validation_templates / item / policy_allowances / 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 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