Skip to content

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.

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 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.get_eorcontract_details(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 parent

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve EOR Contract Details — 200 response body

Referenced models: Retrieve EOR Contract Details — 200 response body

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
FieldTypePresenceDescription and constraints
$objectRootTime frame when adjustments can be made.
endstringOptionalEnd of the period when adjustments can be made.
startstringOptionalStart of the period when adjustments can be made.
Retrieve EOR Contract Details — 200 response body — creator
FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptionalThe email address of the contract creator.
firstnamestringOptionalThe first name of the contract creator.
namestringOptionalThe name of the contract creator.
Create an EOR contract — 201 response body — data costs
FieldTypePresenceDescription and constraints
$objectRootDetailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes.
additional_dataModelOptionalExpand Create an EOR contract — 201 response body — data costs additional data
Supplementary notes and contextual information relevant to the cost quote.
sectionsarrayOptionalDetailed and categorized cost sections including grouped and standalone items.
sections[]ModelEach itemExpand Create an EOR contract — 201 response body — data costs sections item
summaryModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalThe unique identifier for the team.
namestringOptionalThe name of the team.
Retrieve EOR Contract Details — 200 response body — employee
FieldTypePresenceDescription and constraints
$objectRootEmployee details
emailstringOptionalThe email of the employee.
first_namestringOptionalThe first name of the employee.
last_namestringOptionalThe last name of the employee.
legal_namestringOptionalThe legal name of the employee.
nationalitystringOptionalTwo letter country code of the employee nationality.
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeURL to employee's picture.
pic_url (anyOf 2)nullAlternativeURL to employee's picture.
Retrieve EOR Contract Details — 200 response body — hiring objective Information about the hiring objective
FieldTypePresenceDescription and constraints
$objectRootInformation about the hiring objective.
extra_infoJSONOptional
extra_info (anyOf 1)stringAlternative
extra_info (anyOf 2)nullAlternative
typestringOptionalKnown 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
FieldTypePresenceDescription and constraints
$objectRootTimestamp of last quote rejection.
created_atstringOptionalTimestamp of when the rejection was made.
rejected_byModelOptionalExpand Retrieve EOR Contract Details — 200 response body — last quote rejection Timestamp of last quote rejection rejected by
Details of the person who rejected.
rejection_messageJSONOptional
rejection_message (anyOf 1)stringAlternativeOptional message explaining the rejection.
rejection_message (anyOf 2)nullAlternativeOptional message explaining the rejection.
rejection_reasonstringOptionalReason 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_typeJSONOptionalType of rejection.
rejection_type (anyOf 1)stringAlternativeType of rejection.
Known values: CLIENT, EOR_AGENT
rejection_type (anyOf 2)nullAlternative

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
FieldTypePresenceDescription and constraints
$objectRoot
idJSONOptional
id (anyOf 1)numberAlternativeThe unique identifier for the seniority level.
Format: double
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalThe name of the seniority level.
Retrieve EOR Contract Details — 200 response body — sick days
FieldTypePresenceDescription and constraints
$objectRootAllowed sick days range.
maxJSONOptional
max (anyOf 1)stringAlternativeMaximum number of sick days allowed.
max (anyOf 2)nullAlternativeMaximum number of sick days allowed.
minJSONOptional
min (anyOf 1)stringAlternativeMinimum number of sick days allowed.
min (anyOf 2)nullAlternativeMinimum number of sick days allowed.
Create an EOR contract — 201 response body — data costs additional data
FieldTypePresenceDescription and constraints
$objectRootSupplementary notes and contextual information relevant to the cost quote.
additional_notesarrayOptionalGeneral conditions, assumptions, or fees that may apply to the quote.
additional_notes[]stringEach item
annual_notesarrayOptionalNotes or assumptions specifically relevant to annual cost calculations.
annual_notes[]stringEach item
monthly_notesarrayOptionalNotes or assumptions specifically relevant to monthly cost calculations.
monthly_notes[]stringEach item
once_off_notesarrayOptionalNotes regarding one-time costs or irregular payments in the quote.
once_off_notes[]stringEach item
Create an EOR contract — 201 response body — data costs sections item
FieldTypePresenceDescription and constraints
$objectRoot
groupsarrayOptionalCollections of related costs grouped under a common label.
groups[]ModelEach itemExpand Create an EOR contract — 201 response body — data costs sections item groups item
is_summarizedbooleanOptionalIndicates whether the section is presented in summarized form.
labelstringOptionalDisplay name for the cost section.
namestringOptionalInternal identifier for the cost section (e.g., MONTHLY_EMPLOYMENT_BREAKDOWN).
standalone_itemsarrayOptionalCost items that do not belong to regular groups, often irregular or one-off costs.
standalone_items[]ModelEach itemExpand Create an EOR contract — 201 response body — data costs sections item standalone items item
totalsarrayOptionalOverall totals for the section, summing all groups and standalone items.
totals[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootDetails of the person who rejected.
namestringOptionalFull name of the rejecting person.
profile_public_idstringOptionalPublic identifier for the rejecting person's profile.
Format: uuid

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

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.