GuidesAPI ReferenceChangelog
Changelog

Introducing Deel Webhooks. You can now subscribe to events taking place in Deel.

The complete list of changes in this version is:

Create a webhook
Create a webhook subscription to receive events from Deel. Link.

The following events are supported at the moment:

EventDescription
contract.createdTriggered when a contract is created.
contract.status.updatedTriggered when a contract status is updated.
contract.archivedTriggered when a contract is archived.
contract.terminatedTriggered when a contract is terminated.

Other webhook operations
In addition to creating new webhooks you can also:

  1. Retrieve a list of webhooks.
  2. Retrieve a single webhook.
  3. Edit a webhook.
  4. Delete a webhook.

Alternate email
We have added an alternate email field to the worker object in the contract response. You will now be able to see all the alternate email addresses a contract has.

Introducing Employee of Record (EOR) contract quote creation. You can create EOR contracts using the API.

The complete list of changes in this version is:

EOR Country employment guide
Retrieve employment guide per country to determine local compliance laws and rules to hire full-time or part-time employees. Link.

Create an EOR contract
Create an EOR contract quote to hire full-time or part-time employees. Link.

Custom fields
Retrieve a contract response includes custom fields (if present).

Introducing Employee of Record (EOR) Time off API. Using the EOR Time off API, you can manage employee time off requests.

The complete list of changes in this version is:

1. List time off by contract. link
Retrieve the list of time off requests by an employee.

2. List time off entitlements link
Retrieve a list of time off entitlements for a full-time employee.

3. List of time offs link
List of time offs for all employees in your organization.

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

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

6. Cancel a time off request link
Cancel a time off request for an employee.

7. Review a time off request link
Approve or decline an employee's time off request.

This release introduces the fix to the invoice adjustment file attachment functionality.

Introducing contract termination. You can terminate an active contract with the API.

The complete list of changes in this version is:

1. Terminate the contract. link

curl --location --request POST 'https://api.letsdeel.com/rest/v1/contracts/{id}/terminations' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "terminate_now": false,
        "message": "The project is coming to an end.",
        "completion_date": "2022-12-31"
    }
}'

2. Archive a contract. link

curl --location --request PATCH 'https://api.letsdeel.com/rest/v1/contracts/{id}/archive' \
--header 'Authorization: Bearer {token}'

2. Sign an amendment. link

curl --location --request POST 'https://api.letsdeel.com/rest/v1/contracts/{id}/signatures' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "data": {
    "client_signature": "Jane Doe"
  }
}'

Introducing contract templates. You can retrieve all contract templates in your organization.

The complete list of changes in this version is:

1. Retrieve contract templates. link

curl --location --request GET 'https://api.letsdeel.com/rest/v1/contract-templates' \
--header 'Authorization: Bearer {token}'

2. Sign a contract using a template. link

curl --location --request POST 'https://api.letsdeel.com/rest/v1/contracts/m9zxe29/signatures' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "data": {
    "client_signature": "Jane Doe",
    "contract_template_id": 12345
  }
}'

3. New fields in contract creation payload.
We have added two new (optional) fields in the contract creation payload:

  1. who_reports: You can select who is allowed to add work. Choose between client, contractor or both.
  2. notice_period: You can add the notice period when creating contracts.

Introducing file attachments for invoice adjustments and milestones.

The full list of changes in this version is:

  1. Attach files to invoice adjustments.
  2. Attach files to milestones.

Introducing Deel Premium. You can now add Deel Premium coverage to your contracts using Deel API.

The full list of changes in this version is:

  1. Upgrade a Deel contract to add premium coverage.
  2. Downgrade a contract from premium.

Introducing off-cycle payments and tasks. You can now create off-cycle payments for contractors. We also added the endpoints to create, review and delete tasks for pay-as-you-go task-based contracts.

The full list of changes in this version is:

  1. Create off-cycle payments.
  2. List off-cycle payments.
  3. List tasks.
  4. Create a task.
  5. Review task(s).
  6. Delete a task.

Introducing contract Amendments. You can now amend the payment details of the contracts.

The full list of changes in this version is:

  1. Amend a contract.
  2. Remove invite to uninvite a worker signing a contract.
  3. File attachments.
  4. Create a fixed-rate contract.