Skip to content

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.

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 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.update_contract_amendment(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
path.amendment_idstringRequired within parentFormat: uuid
bodyobjectOptional
body.dataModelOptionalExpand Create amendment — request body — body data

Referenced models: Create amendment — request body — body data

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Update amendment — 200 response body

Referenced models: Update amendment — 200 response body

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

Create amendment — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
additional_infoJSONOptionalAdditional metadata related to job validation and categorisation
additional_info (oneOf 1)ModelAlternativeExpand Create amendment — request body — body data additional info ai scope check public id, job categorization log id
additional_info (oneOf 2)nullAlternative
customarrayOptionalAn optional array of custom objects.
custom[]ModelEach itemExpand Create amendment — request body — body data custom item
effective_datestringOptionalEffective date for the amendment.
Format: date
employment_statestringOptionalState of employment.
employment_typestringOptionalType of employment.
One of: FULL_TIME, PART_TIME
end_datestringOptionalEnd date of the employment.
Format: date
fixed_adjustmentsarrayOptionalArray of fixed adjustments to be submitted for the amendment request.
fixed_adjustments[]ModelEach itemExpand Create amendment — request body — body data fixed adjustments item
holidaysnumberOptionalNumber of holidays.
Format: double
hourly_ratenumberOptionalHourly rate of the amendment. The max value supported is 1e19
Format: double
job_titlestringOptionalJob title associated with the amendment.
Maximum length: 1000
notice_period_after_probationnumberOptionalNotice period after probation.
Format: double
notice_period_during_probationnumberOptionalNotice period during probation.
Format: double
notice_period_typestringOptionalType of notice period.
One of: STANDARD, CUSTOM
probation_periodnumberOptionalDuration of the probation period.
Format: double
probation_period_type_for_definitestringOptionalType of probation period for definite contracts.
One of: STANDARD, CUSTOM
salarynumberOptionalSalary for the amendment.
Format: double
scopestringOptionalScope of the amendment.
Maximum length: 20000
seniority_datestring or nullOptionalThe 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_idstringOptionalPublic Id of the seniority level.
Format: uuid
start_datestringOptionalStart date of the employment.
Format: date
time_off_typestringOptionalType of time off.
One of: STANDARD, SPECIFIC, PRORATED
variable_compensationModelOptionalExpand 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_weeknumberOptionalNumber 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
FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRootAdditional metadata related to job validation and categorisation
ai_scope_check_public_idstringOptionalIdentifier or flag for AI scope validation check
Format: uuid
job_categorization_log_idstringOptionalIdentifier for job categorisation log
Format: uuid
Create amendment — request body — body data custom item
FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentA required description for the custom object.
Maximum length: 1000
Minimum length: 50
idstringOptionalAn optional identifier for the custom object.
Format: uuid
typestringRequired within parentThe type of the custom object. Must be one of the valid custom types.
Create amendment — request body — body data fixed adjustments item
FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentDescription of the fixed adjustment.
Maximum length: 256
Minimum length: 1
idstringOptionalThe 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_deletedbooleanOptionalFlag to mark the fixed adjustment as deleted. Required only when the fixed adjustment needs to be removed; omit it otherwise.
is_recurringbooleanRequired within parentWhether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance.
valuestringRequired within parentValue of the fixed adjustment. Must be a positive number, not zero.
Pattern: ^(?!0+(\.0+)?$)\d+(?:\.\d+)?$
Create amendment — request body — body data variable compensation
FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
amountnumberRequired within parentPositive amount for the variable compensation.
Format: double
Minimum: 0
effective_datestringOptionalThe date when this compensation starts or becomes effective. Required when creating a new compensation. Optional when updating an existing compensation.
Format: date
idstringOptionalThe 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_deletedbooleanOptionalFlag to mark the variable compensation as deleted. Required only when the variable compensation needs to be removed; omit it otherwise
timelinestringOptionalHow often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation.
One of: MONTHLY, QUARTERLY, ANNUALLY, BIANNUALLY
titlestringOptionalThe title of the compensation. Required when creating a new compensation. Optional when updating an existing compensation.
Maximum length: 250
Minimum length: 1
typestringRequired within parentType of variable compensation.
One of: PERCENTAGE, FIXED
Create amendment — 201 response body — data amendment statuses item
FieldTypePresenceDescription and constraints
$objectRoot
amendment_flow_statusModelOptionalExpand Create amendment — 201 response body — data amendment statuses item amendment flow status
Metadata about the amendment status, including when it was created.
friendly_namestringOptionalFriendly name of amendment status
namestringOptionalLogical, 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
FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONOptional
description (anyOf 1)stringAlternativeDetailed description of the custom amendment item
description (anyOf 2)nullAlternativeDetailed description of the custom amendment item
idstringRequired within parentUnique identifier for the custom amendment item
Format: uuid
rejection_reasonJSONOptional
rejection_reason (anyOf 1)stringAlternativeReason for rejection if the item was rejected
rejection_reason (anyOf 2)nullAlternativeReason for rejection if the item was rejected
statusstringRequired within parentCurrent status of the custom amendment item
Known values: REJECTED, APPROVED, PENDING_REVIEW, PENDING_LEGAL
typestringRequired within parentType/context of the custom amendment item
Create amendment — 201 response body — data amendment statuses item amendment flow status
FieldTypePresenceDescription and constraints
$objectRootMetadata about the amendment status, including when it was created.
created_atstringOptionalCreation date
Format: date-time

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

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.