Deel: Update amendment
Deel eorAmendments.updateContractAmendment: arguments, response, policy and SDK examples.
← EOR amendments operations · Get started
Operation deel.eoramendments_updatecontractamendment
Provider route: PATCH /eor/contracts/{contract_id}/amendments/{amendment_id}. 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"]["updateContractAmendment"]>[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.updateContractAmendment(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.update_contract_amendment(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 |
path.amendment_id | string | Required within parent | Format: uuid |
body | object | Optional | |
body.data | Model | Optional | Expand Create amendment — request body — body data |
Referenced models: Create amendment — request body — body data
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 Update amendment — 200 response body |
Referenced models: Update amendment — 200 response body
Schemas
Section titled “Schemas”7 more schemas are linked from the tables above, on the schema pages.
Create amendment — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_info | JSON | Optional | Additional metadata related to job validation and categorisation |
additional_info (oneOf 1) | Model | Alternative | Expand Create amendment — request body — body data additional info ai scope check public id, job categorization log id |
additional_info (oneOf 2) | null | Alternative | |
custom | array | Optional | An optional array of custom objects. |
custom[] | Model | Each item | Expand Create amendment — request body — body data custom item |
effective_date | string | Optional | Effective date for the amendment. Format: date |
employment_state | string | Optional | State of employment. |
employment_type | string | Optional | Type of employment. One of: FULL_TIME, PART_TIME |
end_date | string | Optional | End date of the employment. Format: date |
fixed_adjustments | array | Optional | Array of fixed adjustments to be submitted for the amendment request. |
fixed_adjustments[] | Model | Each item | Expand Create amendment — request body — body data fixed adjustments item |
holidays | number | Optional | Number of holidays. Format: double |
hourly_rate | number | Optional | Hourly rate of the amendment. The max value supported is 1e19 Format: double |
job_title | string | Optional | Job title associated with the amendment. Maximum length: 1000 |
notice_period_after_probation | number | Optional | Notice period after probation. Format: double |
notice_period_during_probation | number | Optional | Notice period during probation. Format: double |
notice_period_type | string | Optional | Type of notice period. One of: STANDARD, CUSTOM |
probation_period | number | Optional | Duration of the probation period. Format: double |
probation_period_type_for_definite | string | Optional | Type of probation period for definite contracts. One of: STANDARD, CUSTOM |
salary | number | Optional | Salary for the amendment. Format: double |
scope | string | Optional | Scope of the amendment. Maximum length: 20000 |
seniority_date | string or null | Optional | The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable. Format: date |
seniority_id | string | Optional | Public Id of the seniority level. Format: uuid |
start_date | string | Optional | Start date of the employment. Format: date |
time_off_type | string | Optional | Type of time off. One of: STANDARD, SPECIFIC, PRORATED |
variable_compensation | Model | Optional | Expand Create amendment — request body — body data variable compensation Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description. |
work_hours_per_week | number | Optional | Number of work hours per week. Format: double |
Referenced models: Create amendment — request body — body data additional info ai scope check public id, job categorization log id, Create amendment — request body — body data custom item, Create amendment — request body — body data fixed adjustments item, Create amendment — request body — body data variable compensation
Update amendment — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Update amendment — 200 response body — data |
Referenced models: Update amendment — 200 response body — data
Create amendment — request body — body data additional info ai scope check public id, job categorization log id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional metadata related to job validation and categorisation |
ai_scope_check_public_id | string | Optional | Identifier or flag for AI scope validation check Format: uuid |
job_categorization_log_id | string | Optional | Identifier for job categorisation log Format: uuid |
Create amendment — request body — body data custom item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | A required description for the custom object. Maximum length: 1000 Minimum length: 50 |
id | string | Optional | An optional identifier for the custom object. Format: uuid |
type | string | Required within parent | The type of the custom object. Must be one of the valid custom types. |
Create amendment — request body — body data fixed adjustments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | Description of the fixed adjustment. Maximum length: 256 Minimum length: 1 |
id | string | Optional | The ID of an existing active fixed adjustment to update or delete. Include this in the request only if you are updating or deleting an existing adjustment. Do not include it when creating a new one. |
is_deleted | boolean | Optional | Flag to mark the fixed adjustment as deleted. Required only when the fixed adjustment needs to be removed; omit it otherwise. |
is_recurring | boolean | Required within parent | Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance. |
value | string | Required within parent | Value of the fixed adjustment. Must be a positive number, not zero. Pattern: ^(?!0+(\.0+)?$)\d+(?:\.\d+)?$ |
Create amendment — request body — body data variable compensation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description. |
amount | number | Required within parent | Positive amount for the variable compensation. Format: double Minimum: 0 |
effective_date | string | Optional | The date when this compensation starts or becomes effective. Required when creating a new compensation. Optional when updating an existing compensation. Format: date |
id | string | Optional | The ID of an existing active variable compensation to update or delete. Include this in the request only if you are updating or deleting an existing compensation. Do not include it when creating a new one. |
is_deleted | boolean | Optional | Flag to mark the variable compensation as deleted. Required only when the variable compensation needs to be removed; omit it otherwise |
timeline | string | Optional | How often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation. One of: MONTHLY, QUARTERLY, ANNUALLY, BIANNUALLY |
title | string | Optional | The title of the compensation. Required when creating a new compensation. Optional when updating an existing compensation. Maximum length: 250 Minimum length: 1 |
type | string | Required within parent | Type of variable compensation. One of: PERCENTAGE, FIXED |
Create amendment — 201 response body — data amendment statuses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amendment_flow_status | Model | Optional | Expand Create amendment — 201 response body — data amendment statuses item amendment flow status Metadata about the amendment status, including when it was created. |
friendly_name | string | Optional | Friendly name of amendment status |
name | string | Optional | Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses. |
Referenced models: Create amendment — 201 response body — data amendment statuses item amendment flow status
Accept amendment — 200 response body — data custom items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Detailed description of the custom amendment item |
description (anyOf 2) | null | Alternative | Detailed description of the custom amendment item |
id | string | Required within parent | Unique identifier for the custom amendment item Format: uuid |
rejection_reason | JSON | Optional | |
rejection_reason (anyOf 1) | string | Alternative | Reason for rejection if the item was rejected |
rejection_reason (anyOf 2) | null | Alternative | Reason for rejection if the item was rejected |
status | string | Required within parent | Current status of the custom amendment item Known values: REJECTED, APPROVED, PENDING_REVIEW, PENDING_LEGAL |
type | string | Required within parent | Type/context of the custom amendment item |
Create amendment — 201 response body — data amendment statuses item amendment flow status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Metadata about the amendment status, including when it was created. |
created_at | string | Optional | Creation date Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eoramendments_updatecontractamendment. Catalog operation: eoramendments_updatecontractamendment. 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:write"]
Pinned headers: {"X-Version": "2026-01-01"}