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.
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"]["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 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.create_eorcontract(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Optional | |
body.data | Model | Required within parent | Expand Create an EOR contract — request body — body data |
Referenced models: Create an 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 Create an EOR contract — 201 response body |
Referenced models: Create an EOR contract — 201 response body
Schemas
Section titled “Schemas”32 more schemas are linked from the tables above, on the schema pages.
Create an EOR contract — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
benefits | array | Optional | |
benefits[] | Model | Each item | Expand Create an EOR contract — request body — body data benefits item |
client | Model | Required within parent | Expand Create an EOR contract — request body — body data client Client details for the contract. |
compensation_details | Model | Required within parent | Expand Create an EOR contract — request body — body data compensation details |
employee | Model | Required within parent | Expand Create an EOR contract — request body — body data employee |
employment | Model | Required within parent | Expand Create an EOR contract — request body — body data employment Employment contract specific details. |
health_plan_id | string | Optional | Healthcare plan id. You can see available healthcare plans in the country guide endpoint. |
is_team_manager | boolean | Optional | Italy only. Whether the role is responsible for managing a team. Required when job_category is provided. |
job_category | string | Optional | Italy 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_title | string | Required within parent | Employee's job title. |
pension | Model | Optional | Expand Create an EOR contract — request body — body data pension Some countries required a pension benefit. |
quote_additional_fields | JSON | Optional | Some countries require additional employee information for employment contracts. |
quote_additional_fields (oneOf 1) | Model | Alternative | Expand Create an EOR contract — request body — body / data / quote_additional_fields / worker_type: Skilled, Unskilled |
quote_additional_fields (oneOf 2) | null | Alternative | |
reports_to_job_title | string | Optional | Italy only. Job title of the person this role reports to. Required when job_category is provided. Maximum length: 255 Minimum length: 1 |
seniority | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List of additional benefits to include in the calculation |
contribution | number | Optional | The 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_all | boolean | Optional | Flag indicating if benefit will fully cover the employee. |
cover_dependents | boolean | Optional | Flag indicating if benefit will cover dependents. Only needed if cover_all is set to true. |
plan_id | string | Optional | The ID of a benefits plan to include in the calculation. |
provider_id | string | Optional | The ID of a benefits provider to include in the calculation. |
Create an EOR contract — request body — body data client
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Client details for the contract. |
legal_entity | Model | Optional | Expand Create an EOR contract — request body — body data client legal entity |
team | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Required within parent | Salary currency. |
fixed_adjustments | array | Optional | |
fixed_adjustments[] | Model | Each item | Expand Create an EOR contract — request body — body data compensation details fixed adjustments item |
hourly_rate | number | Optional | Employee's hourly rate. Required only if contract is set as hourly. Format: double |
salary | number | Optional | Employee's gross annual salary. Required only if contract is salaried. Format: double |
signing_bonus | number or null | Optional | Signing bonus amount. Format: double |
signing_bonus_payout_type | JSON | Optional | Should be set only if signing_bonus is set. It defines when the bonus is paid. |
signing_bonus_payout_type (oneOf 1) | string | Alternative | Should 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) | null | Alternative | |
variable_compensation | number or null | Optional | Variable 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_date | string | Optional | Variable compensation effective date. Format: date |
variable_compensation_timeline | JSON | Optional | Variable compensation timeline. |
variable_compensation_timeline (oneOf 1) | string | Alternative | Variable compensation timeline. One of: ANNUALLY, BIANNUALLY, QUARTERLY, MONTHLY |
variable_compensation_timeline (oneOf 2) | null | Alternative | |
variable_compensation_title | string | Optional | Variable compensation title. |
variable_compensation_type | JSON | Optional | Should be set only if variable_compensation is set. It can be PERCENTAGE or FIXED. |
variable_compensation_type (oneOf 1) | string | Alternative | Should be set only if variable_compensation is set. It can be PERCENTAGE or FIXED. One of: PERCENTAGE, FIXED |
variable_compensation_type (oneOf 2) | null | Alternative |
Referenced models: Create an EOR contract — request body — body data compensation details fixed adjustments item
Create an EOR contract — request body — body data employee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (oneOf 1) | Model | Alternative | Expand Create an EOR contract — request body — body data employee address city, country, state, street, zip |
address (oneOf 2) | null | Alternative | |
email | string | Optional | Employee's email address. |
external_id | string | Optional | External identifier of the employee. |
first_name | string | Required within parent | Employee's first name. |
last_name | string | Required within parent | Employee's last name. |
nationality | string | Required within parent | Employee's nationality. |
pf_deductions | string | Optional | Employee'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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Some countries required a pension benefit. |
contribution | string | Optional | Enter 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. |
id | string | Optional | Pension provider id. You can see available pension providers in the country guide endpoint. |
Create an EOR contract — request body — body data seniority id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Identifier for the seniority level (string or numeric ID). |
$ (oneOf 1) | string | Alternative | |
$ (oneOf 2) | integer | Alternative | Format: int64 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}