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.
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["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 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.eor_amendments.get_contract_amendments_validation_settings(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.contract_id | string | Required within parent | Format: alphanumeric |
query | object | Optional | Additional keys: not allowed |
query.employment_state | string | Optional |
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 Get amendment validation settings — 200 response body |
Referenced models: Get amendment validation settings — 200 response body
Schemas
Section titled “Schemas”Get amendment validation settings — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data_point | string | Optional | The name of the data point being configured. |
rules | array | Optional | The rules for the data point. |
rules[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_details | Model | Optional | Expand Get amendment validation settings — 200 response body — data item rules item additional details Optional additional information for rules, if applicable. |
external_validation | boolean | Optional | Indicates 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_editable | boolean | Optional | Indicates whether the data point can be updated. |
max | JSON | Optional | |
max (anyOf 1) | number | Alternative | The maximum allowable value for numerical data points. Format: double |
max (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_date | JSON | Optional | |
max_date (anyOf 1) | string | Alternative | The latest allowable date for date-type data points. Format: date |
max_date (anyOf 2) | null | Alternative | The latest allowable date for date-type data points. Format: date |
min | JSON | Optional | |
min (anyOf 1) | JSON | Alternative | |
min (anyOf 1) (anyOf 1) | number | Alternative | The minimum allowable value for numerical data points. Format: double |
min (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min (anyOf 2) | null | Alternative | The minimum allowable value for numerical data points. Format: double |
min_date | JSON | Optional | |
min_date (anyOf 1) | string | Alternative | The earliest allowable date for date-type data points. Format: date |
min_date (anyOf 2) | null | Alternative | The earliest allowable date for date-type data points. Format: date |
nullable | boolean | Optional | Indicates whether the data point can be null. |
possible_options | array | Optional | A list of possible values the data point can have. Unique for each data point. |
possible_options[] | string | Each item | |
requires | Model | Optional | Expand 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_rules | array | Optional | Defines notice period rules based on the duration of employment. |
tenure_based_rules[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contract conditions that must be met for this rule to be applied. |
Get amendment validation settings — 200 response body — data item rules item additional details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Optional additional information for rules, if applicable. |
cap | JSON | Optional | |
cap (anyOf 1) | JSON | Alternative | |
cap (anyOf 1) (anyOf 1) | number | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cap (anyOf 2) | null | Alternative | The maximum limit imposed for probation period for definite contract when specific calculation is used, it will be in additional_details.rule. Format: double |
note | JSON | Optional | |
note (anyOf 1) | string | Alternative | Additional explanation or notes related to this rule. |
note (anyOf 2) | null | Alternative | Additional explanation or notes related to this rule. |
rule | JSON | Optional | Specific rule that applies for probation period. |
rule (anyOf 1) | string | Alternative | Specific 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) | null | Alternative | |
time_unit | JSON | Optional | The unit of time applicable to notice period. |
time_unit (anyOf 1) | string | Alternative | The unit of time applicable to notice period. Known values: WEEK, MONTH, DAY |
time_unit (anyOf 2) | null | Alternative |
Get amendment validation settings — 200 response body — data item rules item tenure based rules item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employment_duration_type | JSON | Optional | The unit of measurement for the employment duration. |
employment_duration_type (anyOf 1) | string | Alternative | The unit of measurement for the employment duration. Known values: DAY, WEEK, MONTH, YEAR |
employment_duration_type (anyOf 2) | null | Alternative | |
max_employment_duration | JSON | Optional | |
max_employment_duration (anyOf 1) | JSON | Alternative | |
max_employment_duration (anyOf 1) (anyOf 1) | integer | Alternative | The maximum duration of employment for this rule to apply. |
max_employment_duration (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_employment_duration (anyOf 2) | null | Alternative | The maximum duration of employment for this rule to apply. |
min_employment_duration | JSON | Optional | |
min_employment_duration (anyOf 1) | JSON | Alternative | |
min_employment_duration (anyOf 1) (anyOf 1) | integer | Alternative | The minimum duration of employment for this rule to apply. |
min_employment_duration (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_employment_duration (anyOf 2) | null | Alternative | The minimum duration of employment for this rule to apply. |
notice_value | JSON | Optional | |
notice_value (anyOf 1) | JSON | Alternative | |
notice_value (anyOf 1) (anyOf 1) | integer | Alternative | The required notice period for this range of employment duration. |
notice_value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
notice_value (anyOf 2) | null | Alternative | The required notice period for this range of employment duration. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}