eorContract

Retrieve EOR Contract Details

Returns basic contract information and associated employment costs for a specific EOR contract.

Token scopes: contracts:read

get/eor/contracts/{contract_id}/details

Request

  • Base URL: https://api.letsdeel.com/rest
  • URL: https://api.letsdeel.com/rest/eor/contracts/{contract_id}/details
  • Auth: HTTP bearer

Path parameters

contract_idstring required

The unique identifier for the Deel contract

Response

Successful response

idstring

The unique identifier for the Deel contract.

namestring

Contract name

salarystring

Annual salary as a string to preserve decimal precision.

status'under_review' | 'waiting_for_employee_contract' | 'waiting_for_client_sign' | 'waiting_for_eor_sign' | 'waiting_for_employee_sign' | 'awaiting_deposit_payment' | 'in_progress' | 'completed' | 'cancelled' | 'user_cancelled' | 'rejected'

The current status of the contract.

currencystring

The currency used in the contract.

end_datestring date-time nullable

The end date of the contract, if applicable.

holidaysinteger nullable

Number of holidays for the contract.

timezonestring

The timezone of the contract.

work_visaboolean

Indicates if a work visa is required.

created_atstring date-time

The date and time when the contract was created.

start_datestring date-time

The start date of the contract.

updated_atstring date-time

The date and time when the contract was last updated.

descriptionstring

Contract description

hourly_ratestring nullable

Hourly rate as a string to preserve decimal precision.

signed_datestring date-time nullable

The date and time when the contract was signed by both parties.

cancelled_atstring date-time nullable

The date and time when the contract was cancelled.

completed_atstring date-time nullable

The date and time when the contract was completed.

payroll_type'BIMONTHLY' | 'MONTHLY'

Payroll frequency for the contract

contract_type'eor'

The type of contract.

scope_of_workstring

Description of job scope and responsibilities.

signing_bonusstring nullable

One-time bonus paid at contract sign.

time_off_type'STANDARD' | 'SPECIFIC' | 'PRORATED'

Type of time off policy.

deposit_monthsstring nullable

Number of deposit months required.

effective_datestring date-time

The date and time when the contract is effective.

job_title_namestring nullable

The contract's job title.

completion_datestring date-time nullable

The completion date of the contract.

employment_type'Full-time' | 'Part-time'

The type of employment.

hris_profile_idstring uuid nullable

The HRIS profile ID linked to this contract.

client_signaturestring nullable

The signature of the client.

client_signed_atstring date-time nullable

The date and time when the client signed the contract.

employment_statestring nullable

The state of the employment.

probation_periodinteger

Number of days in the probation period.

compensation_type'HOURLY' | 'ANNUAL'

Compensation type for the contract.

employee_signed_atstring date-time nullable

Date and time when the employee signed.

employment_countrystring

Two letter country code of the employment country.

notice_period_type'STANDARD' | 'CUSTOM'

Type of notice period if applicable.

calculated_holidaysstring nullable

Calculated number of holidays as a string.

original_start_datestring date-time

The originally planned start date.

work_hours_per_weekstring

Number of work hours per week.

contractor_signaturestring nullable

The signature of the EOR entity representative.

contractor_signed_atstring date-time nullable

The date and time when the contractor signed the contract.

effective_plain_datestring date

The effective date in plain format.

fixed_adjustment_idsstring[] nullable

List of fixed adjustment ids.

invited_client_emailstring nullable

The email address of the invited client.

completion_plain_datestring date nullable

The completion date of the contract in plain contract.

is_onboarding_on_holdboolean

Whether onboarding is currently on hold or not.

monthly_employer_coststring

Monthly cost to the employer.

employee_late_sign_startstring date-time nullable

Date when employee signed late, if applicable.

is_early_invoice_enabledboolean

Whether early invoicing is enabled or not.

onboarding_step_durationinteger nullable

Duration of onboarding steps in days.

signing_bonus_payout_type'FIRST_CYCLE' | 'AFTER_PROBATION' | 'AFTER_FIRST_CONTRACT_ANNIVERSARY'

Defines when the signing bonus is paid. Set only when signing_bonus is present.

variable_compensation_idsstring[]

List of variable compensation IDs.

can_remind_employee_to_signboolean

Whether reminders to sign the employee resignation can be sent to the employee or not.

initial_effective_plain_datestring date

The initial effective date in plain format.

is_foreign_currency_contractboolean

Whether the contract uses foreign currency or not.

is_employee_onboarding_delayedboolean

Determines if the invite for employee onboarding should be dispatch manually.

monthly_eor_management_fee_usdstring

Monthly EOR management fee in USD.

work_schedule_assignment_settings'NOT_AVAILABLE' | 'SPECIFIC_SCHEDULES' | 'GENERAL_SCHEDULES' | 'ONE_TIME_AMENDMENT'

Work schedule assignment setting.

probation_period_type_for_definite'STANDARD' | 'CUSTOM'

Probation period type for definite contracts.

Changes

No recorded changes to this operation across all 1 revision of this API.