GuidesAPI ReferenceChangelog
Changelog
added

v2.1.70

EOR: Job Scope Templates, Job Scope Validation, EOR Additional Costs, Get and Update Organization structure

New: List of job scope templates for EOR contracts

Description: Endpoint used to fetch all pre-populated job scopes from the Deel collection. Using those job scopes will automatically approve the job scope without the need for AI or human interaction.

Endpoint: GET /v2/eor/job-scopes

API Reference List of Job Scope Templates

Example:

curl --request GET \
     --url https://api.letsdeel.com/v2/eor/job-scopes \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {YOUR_ORG_TOKEN}'

You can filter templates by team by adding the optional team query parameter:

curl --request GET \
     --url https://api.letsdeel.com/v2/eor/job-scopes?team={TEAM_ID} \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {YOUR_ORG_TOKEN}'

New: Request job scope validation

Description: The endpoint is in charge of validating that a job scope is valid given a job title and employee name. After the job scope passes validation, the contract should be able to be processed and return the employment costs results automatically. If job scope validation passes, it goes to manual approval. If the client uses a provided job scope template using the Fetch job scope templates endpoint, there is no need to run job scope validation.

Endpoint: POST /v2/eor/job-scopes/validate

Required fields:

  • employment_country
  • team_id
  • job_scope
  • job_title
  • employee_name
  • client_legal_entity_id

API Reference Request Job Scope Validation

Example:

curl --request POST \
     --url https://api.letsdeel.com/v2/eor/job-scopes/validate \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {YOUR_ORG_TOKEN}' \
     --header 'content-type: application/json' \
     --data '{
       "data": {
         "employment_country": "US",
         "team_id": "123e4567-e89b-12d3-a456-426614174000",
         "job_scope": "Software development and maintenance.",
         "job_title": "Software Engineer",
         "employee_name": "John Doe",
         "client_legal_entity_id": "123e4567-e89b-12d3-a456-426614174002"
       }
     }'

New: Get EOR Additional Costs

Description: Used to gather information from the created contract together with the employment costs of the employee. This employment costs is used to display to the end-customer in order to get an accurate calculation of the amount to be paid per month;

Endpoint: GET /v2/eor/additional-costs/{country}

Parameters:

  • country: The two-letter ISO code of the country for which to retrieve the EOR additional costs (required)

API Reference: Get EOR Additional Costs

Example:

curl --request GET \
     --url https://api.letsdeel.com/v2/eor/additional-costs/US \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {YOUR_ORG_TOKEN}'

The response includes information about allowances and non-statutory costs associated with the specified country.

New: Get Organization Structure

Description: Retrieves detailed information about the organization's hierarchical structure, including departments and teams.

Endpoint GET /v2/hris/organization_structures

API Reference: Get Organization Structure

Example:

curl --request GET \
     --url https://api.letsdeel.com/v2/hris/organization_structures \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {YOUR_ORG_TOKEN}'

Rename: Update department to Update organization structure

Endpoint: PUT /rest/v2/people/{id}/department

API Reference: Update organization structure

Notes:

  • As part of last releases, we have conducted various underlying bug fixes on Deel API.
  • Rename Update department endpoint to Update organization structure