Skip to content

Deel: Create an EOR contract

Deel eorContract.createEorcontract: arguments, response, policy and SDK examples.

← EOR contract operations · Get started

Operation deel.eorcontract_createeorcontract

Provider route: POST /eor. 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["eorContract"]["createEorcontract"]>[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.createEorcontract(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_contract.create_eorcontract(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyobjectOptional
body.dataModelRequired within parentExpand Create an EOR contract — request body — body data

Referenced models: Create an EOR contract — 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 Create an EOR contract — 201 response body

Referenced models: Create an EOR contract — 201 response body

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

Create an EOR contract — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
benefitsarrayOptional
benefits[]ModelEach itemExpand Create an EOR contract — request body — body data benefits item
clientModelRequired within parentExpand Create an EOR contract — request body — body data client
Client details for the contract.
compensation_detailsModelRequired within parentExpand Create an EOR contract — request body — body data compensation details
employeeModelRequired within parentExpand Create an EOR contract — request body — body data employee
employmentModelRequired within parentExpand Create an EOR contract — request body — body data employment
Employment contract specific details.
health_plan_idstringOptionalHealthcare plan id. You can see available healthcare plans in the country guide endpoint.
is_team_managerbooleanOptionalItaly only. Whether the role is responsible for managing a team. Required when job_category is provided.
job_categorystringOptionalItaly only. Job category chosen by the client. If omitted, Deel assigns one automatically. When provided, is_team_manager, reports_to_job_title and employment.probation_period are required.
One of: Impiegato, Quadro, Dirigente
job_titlestringRequired within parentEmployee's job title.
pensionModelOptionalExpand Create an EOR contract — request body — body data pension
Some countries required a pension benefit.
quote_additional_fieldsJSONOptionalSome countries require additional employee information for employment contracts.
quote_additional_fields (oneOf 1)ModelAlternativeExpand Create an EOR contract — request body — body / data / quote_additional_fields / worker_type: Skilled, Unskilled
quote_additional_fields (oneOf 2)nullAlternative
reports_to_job_titlestringOptionalItaly only. Job title of the person this role reports to. Required when job_category is provided.
Maximum length: 255
Minimum length: 1
seniorityModelRequired within parentExpand Create an EOR contract — request body — body data seniority
Seniority selection for the role.

Referenced models: Create an EOR contract — request body — body data benefits item, Create an EOR contract — request body — body data client, Create an EOR contract — request body — body data compensation details, Create an EOR contract — request body — body data employee, Create an EOR contract — request body — body data employment, Create an EOR contract — request body — body data pension, Create an EOR contract — request body — body / data / quote_additional_fields / worker_type: Skilled, Unskilled, Create an EOR contract — request body — body data seniority

Create an EOR contract — 201 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Create an EOR contract — 201 response body — data

Referenced models: Create an EOR contract — 201 response body — data

Create an EOR contract — request body — body data benefits item
FieldTypePresenceDescription and constraints
$objectRootList of additional benefits to include in the calculation
contributionnumberOptionalThe amount the client will contribute for the benefit in the currency of the contract. Only taken into account if cover_all is set to false. For Unisure provider contribution is always in USD.
Format: double
cover_allbooleanOptionalFlag indicating if benefit will fully cover the employee.
cover_dependentsbooleanOptionalFlag indicating if benefit will cover dependents. Only needed if cover_all is set to true.
plan_idstringOptionalThe ID of a benefits plan to include in the calculation.
provider_idstringOptionalThe ID of a benefits provider to include in the calculation.
Create an EOR contract — request body — body data client
FieldTypePresenceDescription and constraints
$objectRootClient details for the contract.
legal_entityModelOptionalExpand Create an EOR contract — request body — body data client legal entity
teamModelRequired within parentExpand Create an EOR contract — request body — body data client team

Referenced models: Create an EOR contract — request body — body data client legal entity, Create an EOR contract — request body — body data client team

Create an EOR contract — request body — body data compensation details
FieldTypePresenceDescription and constraints
$objectRoot
currencystringRequired within parentSalary currency.
fixed_adjustmentsarrayOptional
fixed_adjustments[]ModelEach itemExpand Create an EOR contract — request body — body data compensation details fixed adjustments item
hourly_ratenumberOptionalEmployee's hourly rate. Required only if contract is set as hourly.
Format: double
salarynumberOptionalEmployee's gross annual salary. Required only if contract is salaried.
Format: double
signing_bonusnumber or nullOptionalSigning bonus amount.
Format: double
signing_bonus_payout_typeJSONOptionalShould be set only if signing_bonus is set. It defines when the bonus is paid.
signing_bonus_payout_type (oneOf 1)stringAlternativeShould be set only if signing_bonus is set. It defines when the bonus is paid.
One of: FIRST_CYCLE, AFTER_PROBATION, AFTER_FIRST_CONTRACT_ANNIVERSARY
signing_bonus_payout_type (oneOf 2)nullAlternative
variable_compensationnumber or nullOptionalVariable compensation. For example, if the person will earn 5% of the gross annual salary as the variable compensation, enter 5.
Format: double
variable_compensation_effective_datestringOptionalVariable compensation effective date.
Format: date
variable_compensation_timelineJSONOptionalVariable compensation timeline.
variable_compensation_timeline (oneOf 1)stringAlternativeVariable compensation timeline.
One of: ANNUALLY, BIANNUALLY, QUARTERLY, MONTHLY
variable_compensation_timeline (oneOf 2)nullAlternative
variable_compensation_titlestringOptionalVariable compensation title.
variable_compensation_typeJSONOptionalShould be set only if variable_compensation is set. It can be PERCENTAGE or FIXED.
variable_compensation_type (oneOf 1)stringAlternativeShould be set only if variable_compensation is set. It can be PERCENTAGE or FIXED.
One of: PERCENTAGE, FIXED
variable_compensation_type (oneOf 2)nullAlternative

Referenced models: Create an EOR contract — request body — body data compensation details fixed adjustments item

Create an EOR contract — request body — body data employee
FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (oneOf 1)ModelAlternativeExpand Create an EOR contract — request body — body data employee address city, country, state, street, zip
address (oneOf 2)nullAlternative
emailstringOptionalEmployee's email address.
external_idstringOptionalExternal identifier of the employee.
first_namestringRequired within parentEmployee's first name.
last_namestringRequired within parentEmployee's last name.
nationalitystringRequired within parentEmployee's nationality.
pf_deductionsstringOptionalEmployee's PF deductions. Required only for India contracts.
One of: 12% of Basic, 12% of Rs 15,000 (Rs 1,800)

Referenced models: Create an EOR contract — request body — body data employee address city, country, state, street, zip

Create an EOR contract — request body — body data pension
FieldTypePresenceDescription and constraints
$objectRootSome countries required a pension benefit.
contributionstringOptionalEnter the value of pension contribution. You should send this value only if the contribution object is available in the country guide endpoint and the value should be there between minimum and maximum values indicated.
idstringOptionalPension provider id. You can see available pension providers in the country guide endpoint.
Create an EOR contract — request body — body data seniority id
FieldTypePresenceDescription and constraints
$JSONRootIdentifier for the seniority level (string or numeric ID).
$ (oneOf 1)stringAlternative
$ (oneOf 2)integerAlternativeFormat: int64

SDK function policy ID: deel.eorcontract_createeorcontract. Catalog operation: eorcontract_createeorcontract. 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.