Added

• Reports → Detailed payments report: Retrieve the detailed payment report in JSON format

Added

• Organization → Clone a Group: Clone an existing group with all its configuration under a new name
• Deel IT → Get IT order: Get information about a specified IT order
• Deel IT → List IT orders: List IT orders in your organization
• Deel IT → List IT assets: List IT assets in your organization
• Deel IT → Get IT Asset: Get information about a specified IT asset
• Deel IT → List IT policies: List all IT policies in your organization

Added

• People API → Create a direct employee: document_template_id is now included in the request body, allowing users to use a contract template when creating an employee

Added

• Contract API → Sign worker contract: created_at is now included in the success response, allowing users to track the time when a contract is created
• Contract API → Sign worker contract: updated_at is now included in the success response, allowing users to track the time when a contract is signed
• Deel Engage → Retrieve worker's actionable journeys: actionable_path is now included in the success response, containing the URL that a user can navigate to in order to start or resume a course

Added

• Screenings → Data retrieval: entity_type now accepts hris_profile as a value, allowing users to retrieve screenings for an entity based on their HRIS profile

Added

• EOR → Update employee information: New endpoint added, allowing users to update employee information for an EOR contract

Fixed

• Webhooks API → Create a webhook: Documentation updated to reflect the removal of nesting the request payload inside a data object
• Webhooks API → Edit a webhook: Documentation updated to reflect the removal of nesting the request payload inside a data object

Added

• Contract → List contract amendments: New endpoint is added, allowing users to list the amendments made to a specific contract throughout its lifecycle
• Screenings → Get worker's KYC details: New endpoint is added, allowing organizations to retrieve detailed KYC verification data for workers

Changed

• Job scopes → Request job scope validation: client_name is now supported in the request payload, allowing users to specify the client name for job scope validation
• Contract → Sign worker contract: created_at is now included in the success response, allowing to track the time when a contract is signed
• Contract → Sign worker contract: updated_at is now included in the success response, allowing to track the last update time of the contract

New Payout endpoints

Get the auto-withdrawal setting

See a contractor's auto-withdrawal setting. It can be on or off and have a withdrawal method selected.

Endpoint: GET /rest/v2/payouts/auto-withdrawal-setting

Token scopes: worker:read

API Reference: Get the auto-withdrawal setting

Request Example:

curl --request GET --url https://api.letsdeel.com/rest/v2/payouts/auto-withdrawal-setting --header 'accept: application/json' --header 'authorization: Bearer {API_TOKEN}' --header 'content-type: application/json'

Change the auto-withdrawal setting

See a contractor's auto-withdrawal setting. It can be on or off and have a withdrawal method selected.

Endpoint: PATCH /rest/v2/payouts/auto-withdrawal-setting

Token scopes: worker:write

API Reference: Change the auto-withdrawal setting

Request Example:

curl --request PATCH --url https://api.letsdeel.com/rest/v2/payouts/auto-withdrawal-setting --header 'accept: application/json' --header 'authorization: Bearer {API_TOKEN}' --header 'content-type: application/json' --data ' { "enabled": true, "threshold": 1000 } '

Request to withdraw funds

See a contractor's auto-withdrawal setting. It can be on or off and have a withdrawal method selected.

Endpoint: POST /rest/v2/payouts/withdrawals

Token scopes: worker:write

API Reference: Request to withdraw funds

Request Example:

curl --request POST --url https://api.letsdeel.com/rest/v2/payouts/withdrawals --header 'accept: application/json' --header 'authorization: Bearer {API_TOKEN}' --header 'content-type: application/json' --data ' { "amount": 1000, "currency": "USD", "beneficiary_id": "123456789" } '

List Contractor Balances

See a contractor's auto-withdrawal setting. It can be on or off and have a withdrawal method selected.

Endpoint: GET /rest/v2/payouts/balances

Token scopes: worker:read

API Reference: List Contractor Balances

Request Example:

curl --request GET --url https://api.letsdeel.com/rest/v2/payouts/balances --header 'accept: application/json' --header 'authorization: Bearer {API_TOKEN}' --header 'content-type: application/json'

List of all industry subcategories

Provides a list of industry subcategories for Legal Entity classification
Returns a paginated list of industry subcategories that can be associated with a Legal Entity.
Each item includes subcategory details, associated industry category name, and timestamps (created_at, updated_at). Results can be sorted by category_name or subcategory_name, and support cursor-based pagination for efficient data retrieval.
This endpoint is particularly useful when configuring or updating Legal Entities, enabling users to input valid industry options.

Endpoint: GET /rest/v2/industries

Token scopes: legal-entity:read

API Reference: List of all industry subcategories

Request Example:

curl --request GET \
     --url https://api.letsdeel.com/rest/v2/industries?limit=20&order=ASC&sort_by=subcategoryName \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {{token}}'