Deel: Update EOR Contract
Deel eorContract.updateEorcontract: arguments, response, policy and SDK examples.
← EOR contract operations · Get started
Operation deel.eorcontract_updateeorcontract
Provider route: PATCH /eor/contract/{contract_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["eorContract"]["updateEorcontract"]>[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.eorContract.updateEorcontract(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_contract.update_eorcontract(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 | |
body | object | Optional | |
body.data | Model | Required within parent | Expand Update EOR Contract — request body — body data |
Referenced models: Update EOR Contract — 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 EOR Contract — 200 response body |
Referenced models: Update EOR Contract — 200 response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Update EOR Contract — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allow_consultant_equipment_reimbursement | boolean | Optional | Allow equipment reimbursement for consultants |
benefits | array or null | Optional | Array of employee benefits |
benefits[] | Model | Each item | Expand Update EOR Contract — request body — body data benefits item |
contract_term_type | string | Optional | Type of contract term One of: DEFINITE, INDEFINITE |
currency | string | Optional | Currency code for salary and benefits |
employee_address | Model | Optional | Expand Update EOR Contract — request body — body data employee address Employee's address information |
employee_email | string | Required within parent | Employee's email address Format: email |
employee_first_name | string | Required within parent | Employee's first name |
employee_id | string | Optional | Employee's unique identifier |
employee_last_name | string | Required within parent | Employee's last name |
employee_nationality | string | Optional | Employee's nationality |
employment_country | string | Required within parent | Country of employment |
employment_state | string or null | Optional | State/Province of employment |
employment_type | string | Required within parent | Type of employment One of: Full-time, Part-time |
end_date | string or null | Optional | Employment end date Format: date |
hiring_objective | string | Optional | Objective for hiring One of: EXPANDING_TO_NEW_COUNTRY, TEMP_EOR_OPENING_ENTITY, ONE_OFF_HIRE, CONVERTING_CONTRACTOR, OTHER |
hiring_objective_extra_info | string or null | Optional | Additional information about hiring objective |
holidays | number or null | Optional | Number of holiday days per year Format: double Minimum: 0 |
hourly_rate | string or null | Optional | Hourly rate. Required when is_hourly is true. Must not be sent when is_hourly is false or omitted. |
is_auto_quote_validation_passed | boolean or null | Optional | Auto quote validation status |
is_hourly | boolean or null | Optional | Indicates if compensation is hourly |
is_resubmit | boolean or null | Optional | Indicates if this is a resubmission |
job_title | string | Required within parent | Job title (cannot be C-level position) |
medical_insurance | boolean | Optional | Medical insurance coverage |
notice_period_after_probation | number | Optional | Notice period after probation (days) Format: double Minimum: 0 |
notice_period_during_probation | number | Optional | Notice period during probation (days) Format: double Minimum: 0 |
notice_period_type | string | Optional | Type of notice period One of: STANDARD, CUSTOM |
probation_period | number or null | Optional | Probation period duration Format: double Minimum: 0 |
probation_period_type_for_definite | string | Optional | Unit of time for probation period One of: CUSTOM, STANDARD |
quote_additional_fields | Model | Optional | Expand Update EOR Contract — request body — body data quote additional fields Additional quote-specific information |
reason_for_fixed_term | JSON | Optional | Reason for fixed-term contract |
reason_for_fixed_term (oneOf 1) | string | Alternative | Reason for fixed-term contract One of: SEASONAL_OR_TEMPORARY_WORK, PROJECT_BASED_EMPLOYMENT, REPLACEMENT_FOR_PERMANENT_STAFF, TRIAL_PERIODS_FOR_NEW_ROLES_OR_BUSINESSES |
reason_for_fixed_term (oneOf 2) | null | Alternative | |
salary | string | Optional | Annual salary amount. Optional; must not be sent when is_hourly is true. |
schedule_id | string or null | Optional | Unique identifier for the employee's work schedule |
scope | Model | Optional | Expand Update EOR Contract — request body — body data scope Scope of work description, either as a plain string or as a reference to a scope template. |
seniority_date | string | Optional | Employee seniority date Format: date |
seniority_id | number | Optional | Seniority level identifier Format: double |
sick_leave_days | number or null | Optional | Number of sick leave days per year Format: double Maximum: 90 Minimum: 0 |
signing_bonus | string or null | Optional | Signing bonus amount |
signing_bonus_payout_type | JSON | Optional | Determines when the signing bonus will be paid out Default: FIRST_CYCLE |
signing_bonus_payout_type (oneOf 1) | string | Alternative | Determines when the signing bonus will be paid out Default: FIRST_CYCLE One of: FIRST_CYCLE, AFTER_PROBATION, AFTER_FIRST_CONTRACT_ANNIVERSARY |
signing_bonus_payout_type (oneOf 2) | null | Alternative | |
start_date | string | Required within parent | Employment start date Format: date |
time_off_type | string | Optional | Type of time off One of: STANDARD, SPECIFIC, PRORATED |
work_arrangement | JSON | Optional | Work arrangement type |
work_arrangement (oneOf 1) | string | Alternative | Work arrangement type One of: REMOTE, ON_SITE_OR_HYBRID |
work_arrangement (oneOf 2) | null | Alternative | |
work_eligibility | Model | Optional | Expand Update EOR Contract — request body — body data work eligibility Work eligibility documentation |
work_hours_per_week | number | Optional | Working hours per week Format: double Maximum: 168 Minimum: 0 |
work_pension | boolean or null | Optional | Indicates if work pension is included |
work_visa | boolean or null | Optional | Indicates if work visa is required |
Referenced models: Update EOR Contract — request body — body data benefits item, Update EOR Contract — request body — body data employee address, Update EOR Contract — request body — body data quote additional fields, Update EOR Contract — request body — body data scope, Update EOR Contract — request body — body data work eligibility
Update EOR Contract — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
oid | string | Required within parent | The unique identifier of the employee contract. |
scope_of_work | string | Optional | Scope of work description. |
status | string | Required within parent | Current status of the contract Known values: new, under_review, waiting_for_client_sign, waiting_for_eor_sign, waiting_for_employee_sign, awaiting_deposit_payment, rejected |
Update EOR Contract — request body — body data benefits item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Benefit plan details |
contribution | number or null | Optional | Contribution amount Format: double Maximum: 9999999999999 Minimum: 0 |
cover_all | boolean | Optional | Indicates if benefit covers all |
cover_dependents | boolean | Optional | Indicates if benefit covers dependents |
plan_id | string or null | Optional | Benefit plan ID |
provider_id | string or null | Optional | Benefit provider ID |
Update EOR Contract — request body — body data employee address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employee's address information |
calling_code | string | Optional | Country calling code |
city | string | Required within parent | City of residence |
country | string | Required within parent | Country of residence (can be country code or name) |
phone | string | Optional | Phone number |
province | string | Optional | Province of residence |
state | string | Optional | State of residence |
street | string | Required within parent | Street address |
zip | string | Optional | ZIP/Postal code |
Update EOR Contract — request body — body data quote additional fields
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional quote-specific information |
employee_type | string | Optional | Type of employee One of: Employee, Manager |
qualifications | string | Optional | Required qualifications |
qualifications_german_translation | string | Optional | German translation of qualifications |
scope_german_translation | string | Optional | German translation of scope |
Update EOR Contract — request body — body data scope
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Scope of work description, either as a plain string or as a reference to a scope template. |
$ (oneOf 1) | string | Alternative | Maximum length: 10000 Minimum length: 100 |
$ (oneOf 2) | Model | Alternative | Expand Update EOR Contract — request body — body data scope Reference to a scope template or validation |
Referenced models: Update EOR Contract — request body — body data scope Reference to a scope template or validation
Update EOR Contract — request body — body data work eligibility
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Work eligibility documentation |
file_name | string | Required within parent | Name of the work eligibility document file |
key | string | Required within parent | Unique identifier for the work eligibility document |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eorcontract_updateeorcontract. Catalog operation: eorcontract_updateeorcontract. 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"}