Skip to content

Deel: Get amendment validation settings

Deel eorAmendments.getContractAmendmentsValidationSettings: arguments, response, policy and SDK examples.

← EOR amendments operations · Get started

Operation deel.eoramendments_getcontractamendmentsvalidationsettings

Provider route: GET /eor/contracts/{contract_id}/amendments/validation/settings. 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["eorAmendments"]["getContractAmendmentsValidationSettings"]>[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.eorAmendments.getContractAmendmentsValidationSettings(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.eor_amendments.get_contract_amendments_validation_settings(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contract_idstringRequired within parentFormat: alphanumeric
queryobjectOptionalAdditional keys: not allowed
query.employment_statestringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get amendment validation settings — 200 response body

Referenced models: Get amendment validation settings — 200 response body

Get amendment validation settings — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand Get amendment validation settings — 200 response body — data item

Referenced models: Get amendment validation settings — 200 response body — data item

Get amendment validation settings — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
data_pointstringOptionalThe name of the data point being configured.
rulesarrayOptionalThe rules for the data point.
rules[]ModelEach itemExpand Get amendment validation settings — 200 response body — data item rules item

Referenced models: Get amendment validation settings — 200 response body — data item rules item

Get amendment validation settings — 200 response body — data item rules item
FieldTypePresenceDescription and constraints
$objectRoot
additional_detailsModelOptionalExpand Get amendment validation settings — 200 response body — data item rules item additional details
Optional additional information for rules, if applicable.
external_validationbooleanOptionalIndicates whether external validation/fetching is required for this data point. If yes, the information for this data point must be retrieved using another endpoint.
is_editablebooleanOptionalIndicates whether the data point can be updated.
maxJSONOptional
max (anyOf 1)numberAlternativeThe maximum allowable value for numerical data points.
Format: double
max (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_dateJSONOptional
max_date (anyOf 1)stringAlternativeThe latest allowable date for date-type data points.
Format: date
max_date (anyOf 2)nullAlternativeThe latest allowable date for date-type data points.
Format: date
minJSONOptional
min (anyOf 1)JSONAlternative
min (anyOf 1) (anyOf 1)numberAlternativeThe minimum allowable value for numerical data points.
Format: double
min (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min (anyOf 2)nullAlternativeThe minimum allowable value for numerical data points.
Format: double
min_dateJSONOptional
min_date (anyOf 1)stringAlternativeThe earliest allowable date for date-type data points.
Format: date
min_date (anyOf 2)nullAlternativeThe earliest allowable date for date-type data points.
Format: date
nullablebooleanOptionalIndicates whether the data point can be null.
possible_optionsarrayOptionalA list of possible values the data point can have. Unique for each data point.
possible_options[]stringEach item
requiresModelOptionalExpand Get amendment validation settings — 200 response body — data item rules item requires
Contract conditions that must be met for this rule to be applied.
tenure_based_rulesarrayOptionalDefines notice period rules based on the duration of employment.
tenure_based_rules[]ModelEach itemExpand Get amendment validation settings — 200 response body — data item rules item tenure based rules item

Referenced models: Get amendment validation settings — 200 response body — data item rules item requires, Get amendment validation settings — 200 response body — data item rules item additional details, Get amendment validation settings — 200 response body — data item rules item tenure based rules item

Get amendment validation settings — 200 response body — data item rules item requires
FieldTypePresenceDescription and constraints
$objectRootContract conditions that must be met for this rule to be applied.
Get amendment validation settings — 200 response body — data item rules item additional details
FieldTypePresenceDescription and constraints
$objectRootOptional additional information for rules, if applicable.
capJSONOptional
cap (anyOf 1)JSONAlternative
cap (anyOf 1) (anyOf 1)numberAlternativeThe maximum limit imposed for probation period for definite contract when specific calculation is used, it will be in additional_details.rule.
Format: double
cap (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cap (anyOf 2)nullAlternativeThe maximum limit imposed for probation period for definite contract when specific calculation is used, it will be in additional_details.rule.
Format: double
noteJSONOptional
note (anyOf 1)stringAlternativeAdditional explanation or notes related to this rule.
note (anyOf 2)nullAlternativeAdditional explanation or notes related to this rule.
ruleJSONOptionalSpecific rule that applies for probation period.
rule (anyOf 1)stringAlternativeSpecific rule that applies for probation period.
Known values: ONE_QUARTER_OF_CONTRACT_DURATION, ONE_THIRD_OF_CONTRACT_DURATION, HALF_OF_CONTRACT_DURATION
rule (anyOf 2)nullAlternative
time_unitJSONOptionalThe unit of time applicable to notice period.
time_unit (anyOf 1)stringAlternativeThe unit of time applicable to notice period.
Known values: WEEK, MONTH, DAY
time_unit (anyOf 2)nullAlternative
Get amendment validation settings — 200 response body — data item rules item tenure based rules item
FieldTypePresenceDescription and constraints
$objectRoot
employment_duration_typeJSONOptionalThe unit of measurement for the employment duration.
employment_duration_type (anyOf 1)stringAlternativeThe unit of measurement for the employment duration.
Known values: DAY, WEEK, MONTH, YEAR
employment_duration_type (anyOf 2)nullAlternative
max_employment_durationJSONOptional
max_employment_duration (anyOf 1)JSONAlternative
max_employment_duration (anyOf 1) (anyOf 1)integerAlternativeThe maximum duration of employment for this rule to apply.
max_employment_duration (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_employment_duration (anyOf 2)nullAlternativeThe maximum duration of employment for this rule to apply.
min_employment_durationJSONOptional
min_employment_duration (anyOf 1)JSONAlternative
min_employment_duration (anyOf 1) (anyOf 1)integerAlternativeThe minimum duration of employment for this rule to apply.
min_employment_duration (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_employment_duration (anyOf 2)nullAlternativeThe minimum duration of employment for this rule to apply.
notice_valueJSONOptional
notice_value (anyOf 1)JSONAlternative
notice_value (anyOf 1) (anyOf 1)integerAlternativeThe required notice period for this range of employment duration.
notice_value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
notice_value (anyOf 2)nullAlternativeThe required notice period for this range of employment duration.

SDK function policy ID: deel.eoramendments_getcontractamendmentsvalidationsettings. Catalog operation: eoramendments_getcontractamendmentsvalidationsettings. 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: ["contracts: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.