Add external Id | Deel | Documentation

curl -X PATCH https://api.letsdeel.com/rest/v2/contracts/37nex2x \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "data": {
    "external_id": "5f0b87ae-58bf-4ca6-944a-ecbecf3025d6"
  }
}'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "ongoing_time_based",
  "title": "Software Development Contract",
  "client": {
    "team": {
      "id": "team-xyz789",
      "name": "Engineering Team"
    },
    "legal_entity": {
      "id": "team-xyz789",
      "name": "Engineering Team",
      "type": "company",
      "email": "test@example.com",
      "subtype": "general-partnership",
      "vat_number": "123456789",
      "registration_number": "123456789"
    },
    "id": "team-abc123",
    "email": "client@example.com",
    "full_name": "Acme Corp"
  },
  "status": "in_progress",
  "worker": {
    "id": "team-abc123",
    "email": "client@example.com",
    "country": "US",
    "full_name": "Acme Corp",
    "last_name": "Doe",
    "first_name": "John",
    "nationality": "US",
    "date_of_birth": "1990-01-01T00:00:00Z",
    "expected_email": "test@example.com",
    "alternate_email": [
      {
        "email": "test@example.com",
        "isVerified": true
      }
    ]
  },
  "created_at": "2022-01-01T00:00:00Z",
  "signatures": {
    "signed_at": "2022-01-01T00:00:00Z",
    "client_signature": "Jane Doe",
    "client_signed_at": "2022-01-01T00:00:00Z",
    "worker_signature": "Jane Doe",
    "worker_signed_at": "2022-01-01T00:00:00Z"
  },
  "start_date": "2022-01-01T00:00:00Z",
  "updated_at": "2022-05-02T00:00:00Z",
  "invitations": {
    "client_email": "client@example.com",
    "worker_email": "worker@example.com"
  },
  "is_archived": "false",
  "special_clause": "Special clause",
  "termination_date": "2022-01-01T00:00:00Z",
  "quote": {
    "benefits": [
      {
        "fee": 200.5,
        "name": "Health Insurance",
        "plan": "Premium",
        "price": 150.75,
        "fee_usd": 220,
        "currency": "USD",
        "price_usd": 170.5
      }
    ],
    "currency": "USD"
  },
  "job_title": "Backend Developer",
  "seniority": {
    "id": 1,
    "name": "Mid (Individual Contributor Level 2)",
    "level": 2
  },
  "external_id": "external_id",
  "who_reports": "client",
  "cost_centers": [
    {
      "name": "6P73USR022JKJ2KU1",
      "number": "553",
      "allocation_percentage": 100
    }
  ],
  "custom_fields": [
    {
      "name": "Employee ID",
      "value": "54234"
    }
  ],
  "notice_period": 30,
  "scope_of_work": "Scope of work",
  "work_schedule": {
    "days": [
      {
        "day": "MONDAY",
        "end": "17:00:00",
        "start": "09:00:00",
        "work_hours": 8
      }
    ],
    "name": "34ZNYKYL3G",
    "country": "IN",
    "worker_types": [
      "SALARIED_DIRECT_EMPLOYEE_PAYROLL"
    ],
    "employment_type": "FULL_TIME",
    "work_schedule_type": "Fixed work schedule",
    "work_hours_per_week": 40
  },
  "employment_type": "FULL_TIME",
  "contract_template": {
    "id": "37nex2x",
    "title": "UK Employment Contract 2022."
  },
  "work_statement_id": "123e4567-e89b-12d3-a456-426614174000",
  "employment_details": {
    "type": "full_time",
    "days_per_week": 5,
    "hours_per_day": 8,
    "probation_period": 30,
    "paid_vacation_days": 20
  },
  "compensation_details": {
    "scale": "hourly",
    "amount": "100",
    "cycle_end": 31,
    "frequency": "monthly",
    "currency_code": "GBP",
    "first_payment": "500",
    "cycle_end_type": "DAY_OF_MONTH",
    "first_payment_date": "2024-08-30T20:59:59.999+00:00",
    "gross_annual_salary": "50000",
    "gross_signing_bonus": "5000",
    "gross_variable_bonus": "5000"
  }
}

Add an external Id to a Deel contract. You can use this to add a Deel contract’s refernece Id in your platform. External Id can be passed as a query parameter in List contract endpoint to find this contract later. Token scopes: contracts:write

Authentication

AuthorizationBearer

Authentication

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

contract_idstringRequired

Deel contract id.

Request

Contract object that needs to be created

dataobjectRequired

Response

Successful operation.

idstring>=1 character

Unique identifier for the contract.

typeenum

Type of a contract.

titlestring>=1 character

Title of the contract.

clientobject or null

statusenum

Status of a contract in Deel workflow.

workerobject or null

created_atstringformat: "date-time"

Date and time when the contract was created.

signaturesobject

start_datestringformat: "date-time"

Date and time when the contract starts.

updated_atstringformat: "date-time"

Date and time when the contract was updated.

invitationsobject

is_archivedboolean or null

Flag to indicate if the contract is archived.

special_clausestring or null

Special clause of the contract.

termination_datestring or null

Date and time when the contract ends.

quoteobject or null

EOR quote approved by Deel.

job_titlestring or null

Job title associated with the contract.

seniorityobject or null

Seniority describes level of expertise at a job e.g. junior.

external_idstring or null

External identifier of the contract.

who_reportsstring or null

Who reports the hours.

cost_centerslist of objects or null

List of cost centers associated with the contract.

custom_fieldslist of objects or null

notice_perioddouble or null

Notice period in days.

scope_of_workstring or null

Scope of work of the contract.

work_scheduleobject or null

Defines a work schedule including working days, hours, and employment details

employment_typeenum or null

Type of employment.

Allowed values:

contract_templateobject or null

Contract template details.

work_statement_idstring or null

The unique identifier of the associated work statement.

employment_detailsobject or null

compensation_detailsobject or null

Authentication

Authentication

Path parameters

Request

Response

Errors

Authentication