Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectRequired within parentAdditional keys: not allowed
query.countriesarrayRequired within parent
query.countries[]stringEach itemMaximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve policy validation templates — 200 response body

Referenced models: Retrieve policy validation templates — 200 response body

2 more schemas are linked from the tables above, on the schema pages.

Retrieve policy validation templates — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
policy_typesarrayOptionalList of unique policy types associated with the retrieved templates.
policy_types[]ModelEach itemExpand Retrieve policy validation templates — 200 response body — data policy types item
policy_validation_templatesarrayOptionalList of policy validation templates matching the criteria.
policy_validation_templates[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the policy type.
description (anyOf 2)nullAlternativeDescription of the policy type.
idstringOptionalUnique identifier of the policy type.
Format: uuid
namestringOptionalName of the policy type.
Get Organization Structure — 200 response body — data teams item
FieldTypePresenceDescription and constraints
$objectRoot
Retrieve policy validation templates — 200 response body — data policy validation templates item policy allowance proration Proration rules applied to the policy allowances
FieldTypePresenceDescription and constraints
$objectRootProration rules applied to the policy allowances.
has_partial_proratebooleanOptionalIndicates if partial proration rules are applied.
hire_proration_cut_off_dateJSONOptional
hire_proration_cut_off_date (anyOf 1)JSONAlternative
hire_proration_cut_off_date (anyOf 1) (anyOf 1)integerAlternativeDay of the month used as cut-off for hire proration.
hire_proration_cut_off_date (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hire_proration_cut_off_date (anyOf 2)nullAlternativeDay of the month used as cut-off for hire proration.
hire_proration_rulestringOptionalRule 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
idstringOptionalUnique identifier for the proration settings.
Format: uuid
is_accrual_prorate_policybooleanOptionalIndicates if accrual is prorated based on policy rules.
max_part_time_worker_treatment_specific_amountJSONOptional
max_part_time_worker_treatment_specific_amount (anyOf 1)JSONAlternative
max_part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 1)numberAlternativeMaximum specific amount for part-time treatment.
Format: double
max_part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_part_time_worker_treatment_specific_amount (anyOf 2)nullAlternativeMaximum specific amount for part-time treatment.
Format: double
min_part_time_worker_treatment_specific_amountJSONOptional
min_part_time_worker_treatment_specific_amount (anyOf 1)JSONAlternative
min_part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 1)numberAlternativeMinimum specific amount for part-time treatment.
Format: double
min_part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_part_time_worker_treatment_specific_amount (anyOf 2)nullAlternativeMinimum specific amount for part-time treatment.
Format: double
part_time_worker_treatment_specific_amountJSONOptional
part_time_worker_treatment_specific_amount (anyOf 1)JSONAlternative
part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 1)numberAlternativeSpecific amount if treatment type is SPECIFIC_AMOUNT.
Format: double
part_time_worker_treatment_specific_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
part_time_worker_treatment_specific_amount (anyOf 2)nullAlternativeSpecific amount if treatment type is SPECIFIC_AMOUNT.
Format: double
part_time_worker_treatment_typestringOptionalHow 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_dateJSONOptional
termination_proration_cut_off_date (anyOf 1)JSONAlternative
termination_proration_cut_off_date (anyOf 1) (anyOf 1)integerAlternativeDay of the month used as cut-off for termination proration.
termination_proration_cut_off_date (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
termination_proration_cut_off_date (anyOf 2)nullAlternativeDay of the month used as cut-off for termination proration.
termination_proration_rulestringOptionalRule 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
FieldTypePresenceDescription and constraints
$objectRootDetails of the associated policy type.
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the policy type.
description (anyOf 2)nullAlternativeDescription of the policy type.
idstringOptionalUnique identifier of the policy type.
Format: uuid
namestringOptionalName of the policy type.

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"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.