Deel: Get Policies for Organization — 200 response body — data item policy allowances item
Get Policies for Organization: 200 response body, field data / item / policy_allowances / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Get Policies for Organization — 200 response body — data item policy allowances item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accrual_application_type | string | Optional | Defines when the accruals are applied. Either at the beginning of the cycle, at the end of the cycle, or at the beginning of the next cycle Known values: BEGIN_OF_CYCLE, END_OF_CYCLE, BEGIN_OF_NEXT_CYCLE |
accrual_type | Model | Required within parent | Expand Get Policies for Organization — 200 response body — data item policy allowances item accrual type Determines how and when profiles earn this allowance: LUMPSUM (accrued all at once at the start of the tracking period), TIMEFRAME (accrued periodically, e.g. monthly), EVENT (accrued based on a life event, e.g. child birth), TIME_OFF_IN_LIEU (accrued from extra hours worked), HOURLY (accrued based on hours worked), or NO_AUTO_ACCRUAL (balance managed only via manual adjustments) |
accrual_unit | string | Optional | Unit for how long are the accrual period in each tracking period Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
accrual_unit_amount | JSON | Optional | |
accrual_unit_amount (anyOf 1) | number | Alternative | Amount of time units for how long are the accrual period in each tracking period Format: double |
accrual_unit_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
balance_tracking_flexible_custom_request_amount | JSON | Optional | |
balance_tracking_flexible_custom_request_amount (anyOf 1) | number | Alternative | Limit allowed for the worker balance to be negative. This value if applicable is always positive Format: double |
balance_tracking_flexible_custom_request_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
balance_tracking_type | Model | Required within parent | Expand Get Policies for Organization — 200 response body — data item policy allowances item balance tracking type Defines if the balance tracking is flexible or inflexible. INFLEXIBLE means the worker cannot go below zero. The FLEXIBLE_* values allow the worker to request more time off than their allowance and go negative, either without limit (FLEXIBLE_NO_LIMIT), up to a custom amount (FLEXIBLE_CUSTOM_AMOUNT), or up to the yearly allowance (FLEXIBLE_UP_TO_YEARLY_ALLOWANCE) |
entitlement_expiration_unit | string | Optional | Unit for the entitlement expiration period, if applicable Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
entitlement_expiration_unit_amount | JSON | Optional | |
entitlement_expiration_unit_amount (anyOf 1) | number | Alternative | Amount of time units for the entitlement expiration period, if applicable Format: double |
entitlement_expiration_unit_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
entitlement_start_date | string | Optional | Start date for the entitlement, if applicable. This is used when the entitlement start type is FIXED_DAY. So all entitlements starts in the given month and day of each year Format: date |
entitlement_start_type | string | Required within parent | Defines when the workers start to receive their allowance Known values: IMMEDIATELY, FIXED_PERIOD, FIXED_DAY |
entitlement_start_unit | string | Optional | Unit for the entitlement start period, if applicable. This is used when the entitlement start type is FIXED_PERIOD Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
entitlement_start_unit_amount | JSON | Optional | |
entitlement_start_unit_amount (anyOf 1) | number | Alternative | Amount of time units for the entitlement start period, if applicable. This is used when the entitlement start type is FIXED_PERIOD Format: double |
entitlement_start_unit_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
entitlement_unit | string | Optional | Unit for the entitled allowance Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
entitlement_unit_amount | JSON | Optional | |
entitlement_unit_amount (anyOf 1) | JSON | Alternative | |
entitlement_unit_amount (anyOf 1) (anyOf 1) | number | Alternative | Amount of time units for the entitled allowance. Null means unlimited allowance 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 time units for the entitled allowance. Null means unlimited allowance Format: double |
id | string | Required within parent | Policy allowance UID Format: uuid |
is_bank_holidays_enabled | boolean | Required within parent | Indicates if bank holidays are enabled used considered non-working days when calculating leave usage for this allowance |
is_unlimited_allowance | boolean | Required within parent | Indicates if the allowance is unlimited. Unlimited means that the worker can request any amount of time off without any limit |
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 | Amount of time units for part-time prorated entitlement, if applicable 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 | Amount of time units for part-time prorated entitlement, if applicable Format: double |
rollover_expiration_unit | string | Optional | Unit for the rollover expiration period, if applicable Known values: HOUR, BUSINESS_DAY, CALENDAR_DAY, WEEK, MONTH, YEAR |
rollover_expiration_unit_amount | JSON | Optional | |
rollover_expiration_unit_amount (anyOf 1) | number | Alternative | Amount of time units for the rollover expiration period, if applicable Format: double |
rollover_expiration_unit_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rollover_limit_unit_amount | JSON | Optional | |
rollover_limit_unit_amount (anyOf 1) | number | Alternative | Maximum amount that can be rolled over, if applicable Format: double |
rollover_limit_unit_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rollover_type | string | Required within parent | Defines if the rollover carryover treatment for the policy allowance Known values: NO_ROLLOVER, PAY_OUT, CARRY_OVER, CARRY_OVER_PAY_OUT |
should_zero_out_negative_balances_on_rollover | boolean | Required within parent | Indicates if negative balances should be zeroed out on rollover |
type | string | Required within parent | Type of policy allowance. Either a base allowance or an additional allowance Known values: BASE_ALLOWANCE, ADDITIONAL_ALLOWANCE |
Referenced models: Get Policies for Organization — 200 response body — data item policy allowances item accrual type, Get Policies for Organization — 200 response body — data item policy allowances item balance tracking type