Deel: List policies — 200 response body — policies item policy allowances item
List policies: 200 response body, field policies / item / policy_allowances / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: List policies — 200 response body — policies item policy allowances item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accrual_application_type | JSON | Required within parent | Type of accrual application. Enum to indicate when accruals will be applied within the accrual cycles. |
accrual_application_type (anyOf 1) | string | Alternative | Type of accrual application. Enum to indicate when accruals will be applied within the accrual cycles. Known values: BEGIN_OF_CYCLE, END_OF_CYCLE, BEGIN_OF_NEXT_CYCLE |
accrual_application_type (anyOf 2) | null | Alternative | |
accrual_type | string | Required within parent | Type of accrual for the allowance. Determines how/when profiles should earn their entitlement (aka: allowance). Known values: TIMEFRAME, EVENT, TIME_OFF_IN_LIEU, HOURLY, LUMPSUM, NO_AUTO_ACCRUAL |
accrual_unit | JSON | Required within parent | Unit used for accrual |
accrual_unit (anyOf 1) | string | Alternative | Unit used for accrual Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
accrual_unit (anyOf 2) | null | Alternative | |
accrual_unit_amount | JSON | Required within parent | |
accrual_unit_amount (anyOf 1) | JSON | Alternative | |
accrual_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | Amount of accrual units Format: double |
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 units Format: double |
balance_tracking_flexible_custom_request_amount | JSON | Required within parent | |
balance_tracking_flexible_custom_request_amount (anyOf 1) | JSON | Alternative | |
balance_tracking_flexible_custom_request_amount (anyOf 1) (anyOf 1) | number | Alternative | Amount for flexible custom request balance tracking. The flexible custom extra amount request of the policy allowance. Format: double |
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 | Amount for flexible custom request balance tracking. The flexible custom extra amount request of the policy allowance. Format: double |
balance_tracking_type | JSON | Required within parent | Type of balance tracking. Determines how workers can request their time off. |
balance_tracking_type (anyOf 1) | string | Alternative | Type of balance tracking. Determines how workers can request their time off. Known values: INFLEXIBLE, FLEXIBLE_NO_LIMIT, FLEXIBLE_CUSTOM_AMOUNT, FLEXIBLE_UP_TO_YEARLY_ALLOWANCE |
balance_tracking_type (anyOf 2) | null | Alternative | |
enable_bank_holidays | boolean | Required within parent | Whether bank holidays are enabled for this allowance |
entitlement_expiration_unit | JSON | Required within parent | Unit used for entitlement expiration |
entitlement_expiration_unit (anyOf 1) | string | Alternative | Unit used for entitlement expiration Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
entitlement_expiration_unit (anyOf 2) | null | Alternative | |
entitlement_expiration_unit_amount | JSON | Required within parent | |
entitlement_expiration_unit_amount (anyOf 1) | JSON | Alternative | |
entitlement_expiration_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | Amount of entitlement expiration units Format: double |
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 of entitlement expiration units Format: double |
entitlement_start_date | JSON | Required within parent | |
entitlement_start_date (anyOf 1) | string | Alternative | Start date for entitlement Format: date |
entitlement_start_date (anyOf 2) | null | Alternative | Start date for entitlement Format: date |
entitlement_start_type | string | Required within parent | Type of entitlement start Known values: IMMEDIATELY, FIXED_PERIOD, FIXED_DAY |
entitlement_start_unit | JSON | Required within parent | Unit used for entitlement start |
entitlement_start_unit (anyOf 1) | string | Alternative | Unit used for entitlement start Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
entitlement_start_unit (anyOf 2) | null | Alternative | |
entitlement_start_unit_amount | JSON | Required within parent | |
entitlement_start_unit_amount (anyOf 1) | JSON | Alternative | |
entitlement_start_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | Amount of entitlement start units Format: double |
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 of entitlement start units Format: double |
entitlement_unit | JSON | Required within parent | Unit used for entitlement |
entitlement_unit (anyOf 1) | string | Alternative | Unit used for entitlement Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
entitlement_unit (anyOf 2) | null | Alternative | |
entitlement_unit_amount | JSON | Required within parent | |
entitlement_unit_amount (anyOf 1) | JSON | Alternative | |
entitlement_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | Amount of entitlement units 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 units Format: double |
id | string | Required within parent | Unique identifier of the policy allowance Format: uuid |
part_time_prorated_entitlement_unit_amount | JSON | Optional | |
part_time_prorated_entitlement_unit_amount (anyOf 1) | JSON | Alternative | |
part_time_prorated_entitlement_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | The total prorated policy allowance entitlement amount if the worker is part-time. Format: double |
part_time_prorated_entitlement_unit_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
part_time_prorated_entitlement_unit_amount (anyOf 2) | null | Alternative | The total prorated policy allowance entitlement amount if the worker is part-time. Format: double |
rollover_expiration_unit | JSON | Required within parent | Unit used for rollover expiration |
rollover_expiration_unit (anyOf 1) | string | Alternative | Unit used for rollover expiration Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
rollover_expiration_unit (anyOf 2) | null | Alternative | |
rollover_expiration_unit_amount | JSON | Required within parent | |
rollover_expiration_unit_amount (anyOf 1) | JSON | Alternative | |
rollover_expiration_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | Amount of rollover expiration units Format: double |
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 of rollover expiration units Format: double |
rollover_limit_unit_amount | JSON | Required within parent | |
rollover_limit_unit_amount (anyOf 1) | JSON | Alternative | |
rollover_limit_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | Amount of rollover limit units Format: double |
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 | Amount of rollover limit units Format: double |
rollover_type | JSON | Required within parent | Type of rollover |
rollover_type (anyOf 1) | string | Alternative | Type of rollover Known values: NO_ROLLOVER, PAY_OUT, CARRY_OVER, CARRY_OVER_PAY_OUT |
rollover_type (anyOf 2) | null | Alternative | |
type | string | Required within parent | Type of the policy allowance Known values: BASE_ALLOWANCE, ADDITIONAL_ALLOWANCE |
zero_out_negative_balances_on_rollover | boolean | Required within parent | Whether negative balances are zeroed out on rollover |