Deel: Retrieve EOR Contract Details
Deel eorContract.getEorcontractDetails: arguments, response, policy and SDK examples.
← EOR contract operations · Get started
Operation deel.eorcontract_geteorcontractdetails
Provider route: GET /eor/contracts/{contract_id}/details. 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"]["getEorcontractDetails"]>[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.getEorcontractDetails(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.get_eorcontract_details(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 |
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 Retrieve EOR Contract Details — 200 response body |
Referenced models: Retrieve EOR Contract Details — 200 response body
Schemas
Section titled “Schemas”10 more schemas are linked from the tables above, on the schema pages.
Retrieve EOR Contract Details — 200 response body — can adjust on Time frame when adjustments can be made
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Time frame when adjustments can be made. |
end | string | Optional | End of the period when adjustments can be made. |
start | string | Optional | Start of the period when adjustments can be made. |
Retrieve EOR Contract Details — 200 response body — creator
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | The email address of the contract creator. |
firstname | string | Optional | The first name of the contract creator. |
name | string | Optional | The name of the contract creator. |
Create an EOR contract — 201 response body — data costs
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes. |
additional_data | Model | Optional | Expand Create an EOR contract — 201 response body — data costs additional data Supplementary notes and contextual information relevant to the cost quote. |
sections | array | Optional | Detailed and categorized cost sections including grouped and standalone items. |
sections[] | Model | Each item | Expand Create an EOR contract — 201 response body — data costs sections item |
summary | Model | Optional | Expand Create an EOR contract — 201 response body — data costs summary Top-level overview of costs, including key totals and currency metadata. |
Referenced models: Create an EOR contract — 201 response body — data costs additional data, Create an EOR contract — 201 response body — data costs sections item, Create an EOR contract — 201 response body — data costs summary
Retrieve EOR Contract Details — 200 response body — team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | The unique identifier for the team. |
name | string | Optional | The name of the team. |
Retrieve EOR Contract Details — 200 response body — employee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employee details |
email | string | Optional | The email of the employee. |
first_name | string | Optional | The first name of the employee. |
last_name | string | Optional | The last name of the employee. |
legal_name | string | Optional | The legal name of the employee. |
nationality | string | Optional | Two letter country code of the employee nationality. |
pic_url | JSON | Optional | |
pic_url (anyOf 1) | string | Alternative | URL to employee's picture. |
pic_url (anyOf 2) | null | Alternative | URL to employee's picture. |
Retrieve EOR Contract Details — 200 response body — hiring objective Information about the hiring objective
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the hiring objective. |
extra_info | JSON | Optional | |
extra_info (anyOf 1) | string | Alternative | |
extra_info (anyOf 2) | null | Alternative | |
type | string | Optional | Known values: EXPANDING_TO_NEW_COUNTRY, TEMP_EOR_OPENING_ENTITY, ONE_OFF_HIRE, CONVERTING_CONTRACTOR, OTHER |
Retrieve EOR Contract Details — 200 response body — last quote rejection Timestamp of last quote rejection
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timestamp of last quote rejection. |
created_at | string | Optional | Timestamp of when the rejection was made. |
rejected_by | Model | Optional | Expand Retrieve EOR Contract Details — 200 response body — last quote rejection Timestamp of last quote rejection rejected by Details of the person who rejected. |
rejection_message | JSON | Optional | |
rejection_message (anyOf 1) | string | Alternative | Optional message explaining the rejection. |
rejection_message (anyOf 2) | null | Alternative | Optional message explaining the rejection. |
rejection_reason | string | Optional | Reason why the rejection occurred. Known values: TOO_EXPENSIVE, DECIDED_AGAINST_EMPLOYING_EOR, TEST_QUOTE, NOT_SATISFIED_WITH_DEEL, INACCURATE_INFO_JOB_TITLE, INACCURATE_INFO_JOB_DESCRIPTION, INACCURATE_INFO_JOB_DUTIES_SCOPE_OF_WORK, COMPLIANCE_RESTRICTIONS, OTHER |
rejection_type | JSON | Optional | Type of rejection. |
rejection_type (anyOf 1) | string | Alternative | Type of rejection. Known values: CLIENT, EOR_AGENT |
rejection_type (anyOf 2) | null | Alternative |
Referenced models: Retrieve EOR Contract Details — 200 response body — last quote rejection Timestamp of last quote rejection rejected by
Retrieve EOR Contract Details — 200 response body — seniority
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Optional | |
id (anyOf 1) | number | Alternative | The unique identifier for the seniority level. Format: double |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | The name of the seniority level. |
Retrieve EOR Contract Details — 200 response body — sick days
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Allowed sick days range. |
max | JSON | Optional | |
max (anyOf 1) | string | Alternative | Maximum number of sick days allowed. |
max (anyOf 2) | null | Alternative | Maximum number of sick days allowed. |
min | JSON | Optional | |
min (anyOf 1) | string | Alternative | Minimum number of sick days allowed. |
min (anyOf 2) | null | Alternative | Minimum number of sick days allowed. |
Create an EOR contract — 201 response body — data costs additional data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Supplementary notes and contextual information relevant to the cost quote. |
additional_notes | array | Optional | General conditions, assumptions, or fees that may apply to the quote. |
additional_notes[] | string | Each item | |
annual_notes | array | Optional | Notes or assumptions specifically relevant to annual cost calculations. |
annual_notes[] | string | Each item | |
monthly_notes | array | Optional | Notes or assumptions specifically relevant to monthly cost calculations. |
monthly_notes[] | string | Each item | |
once_off_notes | array | Optional | Notes regarding one-time costs or irregular payments in the quote. |
once_off_notes[] | string | Each item |
Create an EOR contract — 201 response body — data costs sections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
groups | array | Optional | Collections of related costs grouped under a common label. |
groups[] | Model | Each item | Expand Create an EOR contract — 201 response body — data costs sections item groups item |
is_summarized | boolean | Optional | Indicates whether the section is presented in summarized form. |
label | string | Optional | Display name for the cost section. |
name | string | Optional | Internal identifier for the cost section (e.g., MONTHLY_EMPLOYMENT_BREAKDOWN). |
standalone_items | array | Optional | Cost items that do not belong to regular groups, often irregular or one-off costs. |
standalone_items[] | Model | Each item | Expand Create an EOR contract — 201 response body — data costs sections item standalone items item |
totals | array | Optional | Overall totals for the section, summing all groups and standalone items. |
totals[] | Model | Each item | Expand Create an EOR contract — 201 response body — data costs sections item totals item |
Referenced models: Create an EOR contract — 201 response body — data costs sections item groups item, Create an EOR contract — 201 response body — data costs sections item standalone items item, Create an EOR contract — 201 response body — data costs sections item totals item
Retrieve EOR Contract Details — 200 response body — last quote rejection Timestamp of last quote rejection rejected by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the person who rejected. |
name | string | Optional | Full name of the rejecting person. |
profile_public_id | string | Optional | Public identifier for the rejecting person's profile. Format: uuid |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eorcontract_geteorcontractdetails. Catalog operation: eorcontract_geteorcontractdetails. 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:read"]
Pinned headers: {"X-Version": "2026-01-01"}