contracts

Add external Id

Sets an external identifier. Link your internal reference IDs, such as employee numbers or ERP keys, to a Deel worker. The external ID must be unique and, once set, can be used as a filter when listing contracts to directly look up Deel records from an external system.

Token scopes: contracts:write

patch/contracts/{contract_id}

Request

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

Path parameters

contract_idstring required

Deel contract id.

Request body

Response

Successful operation.

idstring required

Unique identifier for the contract.

type'ongoing_time_based' | 'milestones' | 'time_based' | 'pay_as_you_go_time_based' | 'commission' | 'payg_milestones' | 'payg_tasks' | 'contractor_outside_deel' | 'eor' | 'unknown' | 'employee' | 'global_payroll' | 'shield_msa' | 'hris_direct_employee' | 'peo' required

Type of a contract.

titlestring required

Title of the contract.

status'new' | 'under_review' | 'waiting_for_employee_contract' | 'waiting_for_client_sign' | 'processing_payment' | 'waiting_for_contractor_sign' | 'waiting_for_eor_sign' | 'waiting_for_employee_sign' | 'awaiting_deposit_payment' | 'in_progress' | 'completed' | 'cancelled' | 'user_cancelled' | 'rejected' | 'waiting_for_client_payment' | 'onboarding' | 'waiting_for_approval' | 'onboarded' required

Status of a contract in Deel workflow.

job_titlestring

Job title associated with the contract.

created_atstring date-time required

Date and time when the contract was created.

start_datestring date-time required

Date and time when the contract starts.

updated_atstring date-time required

Date and time when the contract was updated.

external_idstring nullable

External identifier of the contract.

is_archivedboolean nullable required

Flag to indicate if the contract is archived.

who_reportsstring

Who reports the hours.

notice_periodnumber double nullable

Notice period in days.

scope_of_workstring nullable

Scope of work of the contract.

special_clausestring nullable required

Special clause of the contract.

employment_type'FULL_TIME' | 'PART_TIME'

Type of employment.

termination_datestring nullable required

Date and time when the contract ends.

work_statement_idstring nullable

The unique identifier of the associated work statement.

Changes

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