Deel: Retrieve policy validation templates
Deel timeOff.getTimeOffPolicyValidationTemplates: arguments, response, policy and SDK examples.
← Time off operations · Get started
Operation deel.timeoff_gettimeoffpolicyvalidationtemplates
Provider route: GET /time_offs/policy-validation-templates. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["timeOff"]["getTimeOffPolicyValidationTemplates"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.timeOff.getTimeOffPolicyValidationTemplates(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.time_off.get_time_off_policy_validation_templates(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Required within parent | Additional keys: not allowed |
query.countries | array | Required within parent | |
query.countries[] | string | Each item | Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve policy validation templates — 200 response body |
Referenced models: Retrieve policy validation templates — 200 response body
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
Retrieve policy validation templates — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Retrieve policy validation templates — 200 response body — data |
Referenced models: Retrieve policy validation templates — 200 response body — data
Retrieve policy validation templates — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
policy_types | array | Optional | List of unique policy types associated with the retrieved templates. |
policy_types[] | Model | Each item | Expand Retrieve policy validation templates — 200 response body — data policy types item |
policy_validation_templates | array | Optional | List of policy validation templates matching the criteria. |
policy_validation_templates[] | Model | Each item | Expand Retrieve policy validation templates — 200 response body — data policy validation templates item |
Referenced models: Retrieve policy validation templates — 200 response body — data policy types item, Retrieve policy validation templates — 200 response body — data policy validation templates item
Retrieve policy validation templates — 200 response body — data policy types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
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. |
Get Organization Structure — 200 response body — data teams item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root |
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 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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.timeoff_gettimeoffpolicyvalidationtemplates. Catalog operation: timeoff_gettimeoffpolicyvalidationtemplates. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["time-off:read"]
Pinned headers: {"X-Version": "2026-01-01"}