Create an EOR contract

POST

/eor

POST

/rest/v2/eor

1 import requests
2 
3 url = "https://api.letsdeel.com/rest/v2/eor"
4 
5 payload = { "data": {
6         "client": { "team": { "id": "team-12345" } },
7         "employee": {
8             "last_name": "Doe",
9             "first_name": "John",
10             "nationality": "US",
11             "email": "john.doe@example.com",
12             "address": {
13                 "zip": "80202",
14                 "city": "Denver",
15                 "state": "CO",
16                 "street": "1234 Elm Street",
17                 "country": "US"
18             },
19             "external_id": "ext-employee-001"
20         },
21         "job_title": "Software Engineer",
22         "seniority": { "id": "seniority-123" },
23         "employment": {
24             "country": "US",
25             "start_date": "2024-01-15",
26             "scope_of_work": "Develop and maintain backend services for the company’s main product, ensuring scalability and reliability.",
27             "work_visa_required": False,
28             "type": "Full-time",
29             "state": "CO",
30             "end_date": "2025-01-14",
31             "holidays": 15,
32             "is_hourly": False,
33             "time_off_type": "STANDARD",
34             "seniority_date": "2020-01-15",
35             "sick_leave_days": 10,
36             "probation_period": 90,
37             "notice_period_type": "STANDARD",
38             "work_hours_per_week": 40,
39             "probation_period_time_unit": "DAY",
40             "notice_period_after_probation": 30,
41             "notice_period_during_probation": 14,
42             "employee_completed_past_probation": False,
43             "probation_period_type_for_definite": "STANDARD",
44             "notice_period_after_probation_time_unit": "DAY",
45             "notice_period_during_probation_time_unit": "DAY"
46         },
47         "compensation_details": {
48             "currency": "USD",
49             "salary": 120000,
50             "signing_bonus": 5000,
51             "fixed_adjustments": [
52                 {
53                     "name": "Internet Allowance",
54                     "value": 100,
55                     "opt_out": False,
56                     "optional": True,
57                     "description": "Monthly internet reimbursement",
58                     "is_recurring": True,
59                     "rule_cost_id": "rule-cost-123",
60                     "is_country_specific": True,
61                     "skipping_confirmation_text": "Confirm skipping internet allowance"
62                 }
63             ],
64             "variable_compensation": 10,
65             "signing_bonus_payout_type": "AFTER_PROBATION",
66             "variable_compensation_type": "PERCENTAGE",
67             "variable_compensation_title": "Annual Bonus",
68             "variable_compensation_timeline": "ANNUALLY",
69             "variable_compensation_effective_date": "2024-01-01"
70         }
71     } }
72 headers = {
73     "Authorization": "Bearer <token>",
74     "Content-Type": "application/json"
75 }
76 
77 response = requests.post(url, json=payload, headers=headers)
78 
79 print(response.json())

Try it

200Successful

1 {
2   "data": {
3     "id": "eor-98765",
4     "type": "eor",
5     "costs": {
6       "summary": {
7         "salary": "120,000.00",
8         "currency": "USD",
9         "exchange_rate": "1.00",
10         "totals_formatted": [
11           {
12             "title": "Monthly total",
13             "total": "10,500.00",
14             "frequency": "monthly",
15             "total_supporting": "10,500.00"
16           }
17         ],
18         "supporting_currency": "USD"
19       },
20       "sections": [
21         {
22           "name": "MONTHLY_EMPLOYMENT_BREAKDOWN",
23           "label": "Monthly employment breakdown",
24           "groups": [
25             {
26               "name": "GROSS_MONTHLY_SALARY",
27               "costs": [
28                 {
29                   "label": "Salary",
30                   "totals": [
31                     {
32                       "total": "10,000.00",
33                       "frequency": "monthly",
34                       "total_supporting": "10,000.00"
35                     }
36                   ]
37                 }
38               ],
39               "label": "Gross salary",
40               "totals": [
41                 {
42                   "total": "10,000.00",
43                   "frequency": "monthly",
44                   "total_supporting": "10,000.00"
45                 }
46               ],
47               "has_breakdown": true
48             }
49           ],
50           "totals": [
51             {
52               "total": "10,500.00",
53               "frequency": "monthly",
54               "total_supporting": "10,500.00"
55             }
56           ],
57           "is_summarized": true,
58           "standalone_items": [
59             {
60               "name": "One off payment",
61               "label": "Printed Agreement handling fee",
62               "totals": [
63                 {
64                   "total": "80.00",
65                   "frequency": "one-time",
66                   "total_supporting": "80.00"
67                 }
68               ]
69             }
70           ]
71         }
72       ],
73       "additional_data": {
74         "annual_notes": [
75           "Annual salary includes base pay and expected bonuses."
76         ],
77         "monthly_notes": [
78           "Monthly totals include base salary and fixed adjustments."
79         ],
80         "once_off_notes": [
81           "One-time fees apply for onboarding and agreement processing."
82         ],
83         "additional_notes": [
84           "Kindly note that the onboarding process for employees in this country requires the completion of a QES (Qualified Electronic Signature) process, which carries a fee of $80 USD. This fee is designed to cover the additional administrative expenses associated with the QES process. In the event that the QES option is not available, an alternative would be to proceed with a printed agreement signature process, incurring costs of $80 USD. These costs include expenses for printing, shipping, and handling related to the signing of the printed agreement.",
85           "Deel can countersign the employment agreement once you provide a Qualifying Electronic Signature (QES). After the employee registers on the Deel platform, we will notify and invite you to sign the Scope of Work, through the QES process. Please note that we are unable to proceed with your employee full onboarding until you complete this QES signing step."
86         ]
87       }
88     },
89     "client": {
90       "legal_entity": {
91         "name": "Acme Corporation"
92       }
93     },
94     "status": "new",
95     "employee": {
96       "email": "john.doe@example.com",
97       "last_name": "Doe",
98       "first_name": "John",
99       "legal_name": "Johnathan Doe"
100     },
101     "job_title": "Software Engineer",
102     "seniority": {
103       "id": 3,
104       "name": "Mid-level"
105     },
106     "created_at": "2024-01-15T09:30:00Z",
107     "employment": {
108       "state": "CO",
109       "country": "US",
110       "end_date": "2025-01-14T00:00:00Z",
111       "start_date": "2024-01-15T00:00:00Z",
112       "scope_of_work": "Develop and maintain backend services for the company’s main product, ensuring scalability and reliability.",
113       "time_off_type": "STANDARD",
114       "probation_period": 90,
115       "work_visa_required": false,
116       "calculated_holidays": 15
117     },
118     "health_plan": {
119       "id": "hp-45678",
120       "name": "Standard Health Coverage"
121     },
122     "compensation_details": {
123       "salary": "120000",
124       "currency": "USD",
125       "variable_compensation": "10",
126       "variable_compensation_type": "PERCENTAGE"
127     }
128   }
129 }

Creates an Employee of Record (EOR) contract quote. This endpoint allows to submit details for an EOR contract. Deel will process the information and return a quote for the requested contract. 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/

Request

The details of the Employee (EOR) contract to be created.

dataobjectRequired

Response

Successfully created the EOR contract quote.

dataobject or null

Authentication

Authentication

Request

Response

Errors

Authentication