Do you want to connect to a sandbox instance?

Organization Token

Deel

Customized attributes on contracts (Employee ID, Project code, etc).

A unique identifier for the object provided by an external system.

Days before to notice the termination of contract for eather party.

Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.

Total recurring allowance in local currency

Total severance accrual in local currency

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

Name of seniority level e.g. Mid (Individual Contributor Level 2)

normally name of client is used as signature

Flag to indicate who is supposed to provide regular reports

Worker's country (location not nationality)

Contracts

Identifies if Deel support EoR in this country.

Identifies the type of sub-territory within a country where local laws may apply. Some countries may have states, provinces, prefectures or regions.

It may be called states, provinces, prefectures or regions, or none at all

Identifies if Deel provides visa support for employees being hired in this country.

Countries

Currencies

Job Titles

Legal Entities

Managers

The completion date of the task or project.

The creation timestamp of the employee record.

The count of direct reports to the employee.

An array of the employee's email addresses.

An array of the employee's employment details.

The current hiring status of the employee.

People

This object is used for linking file attachments to your records.

Original filename you used to upload using attachments end-point.

You can call attachments end-point, get key and URL to upload your file.

Tasks

Users

Retrieve a list of paid invoices for your workforce.

Retrieve invoices

Retrieve a list of invoices related to Deel fees.

Retrieve Deel invoices

Download invoice PDF

List of managers

Create a manager

Create a new Hris direct employee

Retrieve the hiring guide data for a country. This data can be used to create Employee of Record (EOR) contract quotes.

Retrieve country guide

Retrieve employee payslips

Download payslip PDF

Determine EOR employee costs across the globe.

Employee Cost Calculator

Get EOR contract benefits

Create an Employee of Record (EOR) contract quote. The endpoints creates a contract quote request. Deel will process the information and get back with a quote for this contract.

Create an EOR contract

Create a contract

Create a new contract (time-based)

Update the address of a Global Payroll employee.

Update address

Retrieve all bank accounts for an employee.

Retrieve bank accounts

Add bank account

Modify bank account

Retrieve the bank form guide for employee.

Retrieve bank guide

Update the compensation of a Global Payroll employee. Returns the full compensation history including the update.

Update compensation

Update the PTO policy of a Global Payroll employee.

Update PTO policy

Update Global Payroll employee information.

Update employee information

Get list of global payroll events by legal entities.

List payroll events by legal entity

Get list of global payroll reports detailing gross-to-net calculations.

List gross-to-net report

Download global payroll reports detailing gross-to-net calculations.

Download gross-to-net report

Request a termination for a global payroll employee. A successful call starts the termination process and does not confirm termination.

Request termination

Create a new adjustment

Retrieve an adjustment

Update an adjustment

Delete an adjustment

Get all categories for your organization.

Retrieve categories

Add Candidate

Update Candidate

Add additional information for an EOR employee.

Add additional information

Sign a contract

Request employment verification letters, visa support, bank verification and more.

Request custom verification letter

List all HR verification letters and documents available.

List HR verification letters and documents

Retrieve URL to download HR verification letters and documents.

Download HR verification letters and documents

Retrieve an EOR job offer letter in HTML. This endpoint does not support IC and Global Payroll contract types.

Preview job offer letter

Retrieve an EOR Employee Agreement content in HTML.

Preview employee agreement

Get link to download the employee agreement PDF.

Download employee agreement PDF

Retrieve bank account form guide for an EOR employee. This data can be used to add a new bank account for an employee.

Bank account form

Modify bank account for an EOR employee

Get list of payslips for an EOR employee.

Get list of payslips for an EOR employee

Get a list of employee compliance documents.

List of employee compliance documents

Upload employee compliance document

Get the download link for an employee compliance document template, if it exists.

Download employee compliance document template

Get list of tax documents for an employee.

List of tax documents for an employee

Create a new contract (task-based)

Create a new contract (milestone-based)

Create a new contract (fixed-rate)

List of contracts

Create a new contract

Retrieve a single contract

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 conract later.

External Id

Attach a file to contract

Overwrite the file currently attached to contract document.

Edit the file attached to contract document.

Retrieve an IC and EOR contract agreement content in HTML. If no template is specified, the default or currently assigned template will be used. This endpoint does not support Global Payroll contract type.

Preview a contract agreement

Retrieve a list of tasks for a given contract.

List of tasks

Create new task

Returns an array of alternate email objects

Find contract emails by ID

Review multiple tasks to approve or decline the submitted work.

Review multiple tasks

Review a single task to approve or decline the submitted work.

Review a single task

Delete task

Amend the details of a contract. Please note that if the contract is already signed or active, then the update will have to be approved and re-signed for to take effect.

Amend contract

Terminate contract

Archive a terminated, cancelled or completed contract.

Archive a contract

Invite a worker to sign the contract. Worker will be notified via email.

Send contract to worker

Remove invite in order to re-invite a worker to sign the contract.

Remove invite

Retrieve a list of timesheets found for a contract.

List of timesheets by contract

Retrieve a list of milestones found for a contract.

List of milestones by contract

Create a milestone

Retrieve a single milestone

Delete a single milestone from a contract.

Delete a milestone

Review a milestone to approve or decline submitted work.

Review a single milestone

Review a batch of milestones to approve or reject submitted work.

Review multiple milestones

Retrieve a list of off-cycle payments for the given contract id.

List of off-cycle payments

Add a new invoice line-item for the purpose of off-cycle payment for a given contract.

Add off-cycle payment

Retrieve a single off-cycle payment

Add additional protection against misclassification by upgrading to Deel Premium.

Upgrade to Premium

Remove Deel Premium from an existing contract.

Downgrade from Premium

Calculate the final payment due to the contractor when ending the contract.

Calculate final payment

First payment is calculated from the number of working/calendar days between their start date and the start of the payment cycle.

Calculate first payment amount

Retrieve the list of time off requests by an employee.

List time off by contract (obsolete)

Add a time off request for a full-time employee.

Add a time off request (obsolete)

Edit a time off request for a full-time employee.

Edit a time off request (obsolete)

Cancel a time off request for an employee.

Cancel a time off request (obsolete)

Retrieve a list of timesheets in your Deel account. You can filter the list by providing additional paramters e.g. contract_id, contract_type etc.

List of timesheets

Create a timesheet entry

Retrieve a single timesheet entry

Update a timesheet entry

Delete a timesheet entry

Review a timesheet to approve or decline submitted work.

Review a single timesheet

Review a batch of timesheets to approve or reject submitted work.

Review multiple timesheets

Retrieve invoice line items for a given contract id.

Invoice line items by contract

Retrieve invoice adjustments. You can filter the list by providing additional parameters e.g. contract_id, contract_type etc.

List invoice adjustments

Microsoft Sharepoint

Salesforce

HubSpot

Microsoft Dynamics 365

Zoho CRM

Pipedrive

Monday

Freshsales

Slack

Keap

# Continuous Import of Users to Your App

This scenario enables your application to continuously sync Users from any external application to your app's API. It handles the initial import of Users and keeps them synchronized when a User is created, updated, or deleted in the external application.

When receiving Users data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Users to my App

Import Users and receive created/updated or deleted events

	Users automatically maps to	Tasks automatically maps to	Employees automatically maps to
HiBob	—	Tasks	Employees
Google Workspace	Users	—	Users
BambooHR	Users	—	Employees
Capsule CRM	Users	Tasks	—
Microsoft Dynamics 365	Systemusers	Tasks	—
HubSpot	Owners	Tasks	—
Zoho Books	Users	Tasks	—
Freshsales	Owners	Tasks	—
Salesloft	Users	Tasks	—
Asana	Users	Tasks	—

Deel API Integration Profile

Data Collections

Operations

Integration Scenarios

Continuously Import Users to my App

Continuously Import Tasks to my App

Delete Employee

Continuously Import Employees to my App

Create Employee

Two-way realtime sync of Employees

Use the same code to integrate with Deel and 100+ other applications

Users

Tasks

Employees

Build every single integration your customers need with AI