---
canonical_url: "https://docs.composio.dev/toolkits/deel"
markdown_url: "https://docs.composio.dev/toolkits/deel.md"
product: "platform"
version: null
last_updated: null
---

# Deel

Deel provides a global payroll and compliance platform for hiring international contractors and employees. This toolkit supports Deel Organization OAuth connections only.

- **Category:** hr talent & recruitment
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 436
- **Triggers:** 0
- **Slug:** `DEEL`
- **Version:** 20261026_00

## Tools

### Accept amendment

**Slug:** `DEEL_ACCEPT_CONTRACT_AMENDMENT`

Accept amendment. Calls Deel's documented POST /eor/contracts/{contract_id}/amendments/{amendment_id}/accept Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of EOR worker contract. |
| `amendment_id` | string | Yes | A unique identifier for the employee contract amendment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Accept EOR project assignment as client

**Slug:** `DEEL_ACCEPT_PROJECT_ASSIGNMENT`

Accept EOR project assignment as client. Calls Deel's documented POST /eor/contracts/{contract_id}/project-assignment/accept Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique identifier of the employee contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Candidate

**Slug:** `DEEL_ADD_CANDIDATE`

Add a candidate from an external ATS after an offer status change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Candidate details to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add admins to child organizations

**Slug:** `DEEL_ADD_CHILD_ORGANIZATION_ADMINS`

Add admins to child organizations. Calls Deel's documented POST /organizations/children/admins Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | The request payload. |
| `x__beta` | string | Yes | Opts in to the beta version of this endpoint. Must be `true`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add bank account

**Slug:** `DEEL_ADD_GP_CONTRACT_BANK_ACCOUNT`

Add bank account. Calls Deel's documented POST /gp/contracts/{contract_id}/banks Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | Unique identifier for a contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Files To Legal Entity Registration Document

**Slug:** `DEEL_ADD_LEGAL_ENTITY_REGISTRATION_DOCUMENT_FILES`

Add files to a legal entity registration document. Each upload claim token must come from Deel's POST /files response for the matching file_id; it claims only that initialized file. Calls Deel's documented PATCH /legal-entities/{legal_entity_id}/registration-documents/{document_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `document_id` | string | Yes | Public UUID of the document submission. |
| `legal_entity_id` | string | Yes | Public UUID of the legal entity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Note to an Application

**Slug:** `DEEL_ADD_NOTE_APPLICATION`

Add a rich-text note to an ATS application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Application note details. |
| `application_id` | string | Yes | Application to which the note will be added. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add note to a candidate

**Slug:** `DEEL_ADD_NOTE_CANDIDATE`

Add note to a candidate. Calls Deel's documented POST /ats/candidates/{candidate_id}/notes Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `candidate_id` | string | Yes | Id of the candidate which the note will be added |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create child worker relation

**Slug:** `DEEL_ADD_WORKER_RELATION_CHILD`

Create child worker relation. Calls Deel's documented PUT /hris/worker_relations/profile/{hris_profile_oid}/child Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `hris_profile_oid` | string | Yes | HrisProfile ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create child worker relation with external Id

**Slug:** `DEEL_ADD_WORKER_RELATION_CHILD_EXTERNAL_ID`

Create child worker relation with external Id. Calls Deel's documented PUT /hris/worker_relations/profile/external/{profileId}/child Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `profile_id` | string | Yes | HrisProfile external ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a parent worker relation

**Slug:** `DEEL_ADD_WORKER_RELATION_PARENT`

Create a parent worker relation. Calls Deel's documented PUT /hris/worker_relations/profile/{hrisProfileOid}/parent Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `hris_profile_oid` | string | Yes | HrisProfile ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a parent worker relation with external id

**Slug:** `DEEL_ADD_WORKER_RELATION_PARENT_EXTERNAL_ID`

Create a parent worker relation with external id. Calls Deel's documented PUT /hris/worker_relations/profile/external/{profile_id}/parent Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | The request payload containing parent relationship details. |
| `profile_id` | string | Yes | HrisProfile external ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit EDD request answers for a legal entity

**Slug:** `DEEL_ANSWER_LEGAL_ENTITY_KYB_EDD`

Submit EDD request answers for a legal entity. Calls Deel's documented POST /legal-entities/{legal_entity_id}/kyb/edd Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `legal_entity_id` | string | Yes | Public id of the legal entity. The entity must belong to the authenticated organization; any other id answers 404. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Apply changes to positions.

**Slug:** `DEEL_APPLY_POSITION_CHANGES`

Apply changes to positions.. Calls Deel's documented POST /hris/positions/apply_changes Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | The request payload containing the position changes to apply. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Approve an equity exercise

**Slug:** `DEEL_APPROVE_EQUITY_EXERCISE`

Approve an equity exercise. Calls Deel's documented PATCH /equity/exercise/{public_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `public_id` | string | Yes | Equity exercise public ID. |
| `employer_approval` | string | Yes | Documented employer_approval request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Approve an IT order

**Slug:** `DEEL_APPROVE_IT_ORDER`

Approve an IT order. Calls Deel's documented POST /it/orders/{order_id}/approve Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Unique identifier of the IT order |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Approve a visa application quote

**Slug:** `DEEL_APPROVE_VISA_APPLICATION_QUOTE`

Approve a visa application quote. Calls Deel's documented POST /immigration/visa-application-quotes/{visa_application_quote_id}/approve Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `visa_application_quote_id` | string | Yes | The unique identifier of the visa application quote to approve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive an IT asset

**Slug:** `DEEL_ARCHIVE_ASSET`

Archive an IT asset. Calls Deel's documented POST /it/assets/{asset_id}/archive Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `asset_id` | string | Yes | Unique identifier of the IT asset |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign cost centers to an employment contract

**Slug:** `DEEL_ASSIGN_COST_CENTERS_EMPLOYMENT_CONTRACT`

Assign cost centers to an employment contract. Calls Deel's documented POST /contracts/{contract_id}/cost-centers Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | Employment's contract ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign workers to an IT hardware policy

**Slug:** `DEEL_ASSIGN_WORKERS_IT_HARDWARE_POLICY`

Assign workers to an IT hardware policy. Calls Deel's documented POST /it/policies/{it_policy_id}/assign Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Workers to assign to the IT policy. |
| `it_policy_id` | string | Yes | Unique identifier of the IT policy |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign workers to IT seats

**Slug:** `DEEL_ASSIGN_WORKERS_IT_SEATS`

Assign workers to IT seats. Calls Deel's documented POST /it/seats/assign Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Workers to give an IT seat. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign Application to Interview Plan Stage

**Slug:** `DEEL_ASSOCIATE_APPLICATION_WITH_INTERVIEW_PLAN_STAGE`

Associate an ATS application with an interview plan stage and optionally trigger its activities.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Interview plan stage association details. |
| `application_id` | string | Yes | Application to associate with the interview plan stage. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Attach entries to On-Demand Payroll

**Slug:** `DEEL_ATTACH_ON_DEMAND_PAYROLL_ENTRIES`

Attach entries to On-Demand Payroll. Calls Deel's documented PATCH /on-demand-payroll/{odp_id}/entries/attach Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `odp_id` | string | Yes | Public ID of the On-Demand Payroll. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set tags in bulk

**Slug:** `DEEL_BULK_TAG_UPSERTIONS`

Set tags in bulk. Calls Deel's documented POST /ats/upsertions/bulk-tags Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | At least one tag group must be provided. Include tag_id to update an existing tag label, or omit it to create or match case-insensitively. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel a clearance request

**Slug:** `DEEL_CANCEL_CLEARANCE_REQUEST`

Cancel a clearance request. Calls Deel's documented POST /it/clearance-requests/{clearance_request_id}/cancel Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `clearance_request_id` | string | Yes | Unique identifier of the clearance request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel EOR Contract

**Slug:** `DEEL_CANCEL_CONTRACT`

Cancel EOR Contract. Calls Deel's documented POST /eor/contract/{oid}/cancel Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `oid` | string | Yes | Contract oid |
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel an IT order

**Slug:** `DEEL_CANCEL_IT_ORDER`

Cancel an IT order. Calls Deel's documented POST /it/orders/{order_id}/cancel Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `order_id` | string | Yes | Unique identifier of the IT order |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel On-Demand Payroll

**Slug:** `DEEL_CANCEL_ON_DEMAND_PAYROLL`

Cancel On-Demand Payroll. Calls Deel's documented POST /on-demand-payroll/{odp_id}/cancel Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |
| `odp_id` | string | Yes | Public ID of the On-Demand Payroll. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit Project Assignment Checkin Questionnaire Data

**Slug:** `DEEL_CHECKIN_PROJECT_ASSIGNMENT`

Submit Project Assignment Checkin Questionnaire Data. Calls Deel's documented POST /eor/contracts/{contract_id}/project-assignment/checkin Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Form submission payload containing respondent type, question answers, and optional version. |
| `contract_id` | string | Yes | The unique identifier of the contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a clearance request for an asset

**Slug:** `DEEL_CLEAR_IT_ASSET`

Create a clearance request for an asset. Calls Deel's documented POST /it/assets/{asset_id}/clear Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `asset_id` | string | Yes | Unique identifier of the IT asset |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clone a Group

**Slug:** `DEEL_CLONE_GROUP`

Clone a Group. Calls Deel's documented POST /groups/{id}/clone Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the group to be cloned. |
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a collection for an IT asset

**Slug:** `DEEL_COLLECT_IT_ASSET`

Create a collection for an IT asset. Calls Deel's documented POST /it/assets/{asset_id}/collect Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `asset_id` | string | Yes | Unique identifier of the IT asset |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Complete a multipart upload

**Slug:** `DEEL_COMPLETE_FILE_UPLOAD`

Complete a multipart Deel file upload. The upload claim token must come from Deel's POST /files response for the same fileid and is scoped to that initialized file. Calls Deel's documented POST /files/{fileid}/complete Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `fileid` | string | Yes | File UUID from the register response. |
| `upload_claim_token` | string | Yes | Single-use, resource-scoped claim token returned by Deel's POST /files response for the matching file_id. Pass it only to the matching upload status, completion, or file-claim action; do not pass any other token. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Confirm amendment

**Slug:** `DEEL_CONFIRM_CONTRACT_AMENDMENT`

Confirm amendment. Calls Deel's documented POST /eor/contracts/{contract_id}/amendments/{amendment_id}/confirm Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of EOR worker contract. |
| `amendment_id` | string | Yes | A unique identifier for the employee contract amendment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an IT asset

**Slug:** `DEEL_CREATE_ASSET`

Create an IT asset. Calls Deel's documented POST /it/assets Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create ATS Application

**Slug:** `DEEL_CREATE_ATS_APPLICATION`

Create an ATS application for an existing candidate and job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Application details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload an ATS attachment file

**Slug:** `DEEL_CREATE_ATS_ATTACHMENT_FILE`

Upload an ATS attachment file. Calls Deel's documented POST /ats/attachments/{attachable_type_slug}/{attachable_id}/{attachment_type_slug} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | The file to attach, in binary format |
| `attachable_id` | string | Yes | Unique identifier of the entity the file is attached to |
| `attachable_type_slug` | string ("CANDIDATE" | "OFFER" | "JOB_ACTIVITY") | Yes | Type of the entity the file is attached to |
| `attachment_type_slug` | string ("CV" | "LOGO" | "OFFER_LETTER" | "OTHER") | Yes | Type of the attachment being created |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create ATS Candidate

**Slug:** `DEEL_CREATE_ATS_CANDIDATE`

Create a candidate in Deel ATS.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Candidate details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload ATS Candidate CV

**Slug:** `DEEL_CREATE_ATS_CANDIDATE_ATTACHMENT`

Upload ATS Candidate CV. Calls Deel's documented POST /ats/candidates/{candidate_id}/attachments Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cv` | object | Yes | CV of the candidate in binary format |
| `candidate_id` | string | Yes | Unique identifier of the candidate to attach the file to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create ATS Job

**Slug:** `DEEL_CREATE_ATS_JOB`

Create ATS Job. Calls Deel's documented POST /ats/jobs Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Candidate Tags

**Slug:** `DEEL_CREATE_CANDIDATE_TAGS`

Replace all tags on an ATS candidate. Existing tags omitted from tag_ids are removed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_ids` | array | Yes | Tag identifiers to associate with the candidate. |
| `candidate_id` | string | Yes | Candidate to tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an immigration case

**Slug:** `DEEL_CREATE_CLIENT_CASE`

Create an immigration case. Calls Deel's documented POST /immigration/client/cases Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | No | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new adjustment

**Slug:** `DEEL_CREATE_CONTRACT_ADJUSTMENT`

Create a new adjustment. Calls Deel's documented POST /adjustments Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Details of adjustment to create |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Attach a file to contract

**Slug:** `DEEL_CREATE_CONTRACT_DOCUMENT`

Attach a file to contract. Calls Deel's documented POST /contracts/{contract_id}/documents Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | No | Documented file request body. |
| `contract_id` | string | Yes | Deel contract id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send contract to worker

**Slug:** `DEEL_CREATE_CONTRACT_INVITATION`

Send contract to worker. Calls Deel's documented POST /contracts/{contract_id}/invitations Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |
| `contract_id` | string | Yes | Deel contract id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a Milestone

**Slug:** `DEEL_CREATE_CONTRACT_MILESTONE`

Create a Milestone. Calls Deel's documented POST /contracts/{contract_id}/milestones Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique identifier of the Deel contract where the milestone will be added. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add off-cycle payment

**Slug:** `DEEL_CREATE_CONTRACT_OFF_CYCLE_PAYMENT`

Add off-cycle payment. Calls Deel's documented POST /contracts/{contract_id}/off-cycle-payments Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | The off-cycle payment data to submit. |
| `contract_id` | string | Yes | The unique identifier (ID) of the Deel contract for which the off-cycle payment is being created. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update contract

**Slug:** `DEEL_CREATE_CONTRACTOR_CONTRACT_AMENDMENT`

Update contract. Calls Deel's documented POST /contracts/{contract_id}/amendments Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique identifier of the employee contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sign a contract

**Slug:** `DEEL_CREATE_CONTRACT_SIGNATURE`

Sign a contract. Calls Deel's documented POST /contracts/{contract_id}/signatures Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |
| `contract_id` | string | Yes | Deel contract id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new task

**Slug:** `DEEL_CREATE_CONTRACT_TASK`

Create a new task. Calls Deel's documented POST /contracts/{contract_id}/tasks Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique Deel contract ID associated with the task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Review a single task

**Slug:** `DEEL_CREATE_CONTRACT_TASK_REVIEW`

Review a single task. Calls Deel's documented POST /contracts/{contract_id}/tasks/{task_id}/reviews Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `task_id` | string | Yes | The unique ID of the task to be reviewed. |
| `contract_id` | string | Yes | The unique Deel contract ID associated with the task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Terminate contract

**Slug:** `DEEL_CREATE_CONTRACT_TERMINATION`

Terminate contract. Calls Deel's documented POST /contracts/{contract_id}/terminations Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Termination data. At minimum, you must provide either terminate_now: true (for immediate termination) OR completion_date (for scheduled termination). |
| `contract_id` | string | Yes | The unique identifier of the contractor contract |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a deal registration

**Slug:** `DEEL_CREATE_DEAL_REGISTRATION`

Create a deal registration. Calls Deel's documented POST /organizations/deal-registrations Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | The request payload. |
| `x__beta` | string | Yes | Opts in to the beta version of this endpoint. Must be `true`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a direct employee

**Slug:** `DEEL_CREATE_DIRECT_EMPLOYEE`

Create a direct employee. Calls Deel's documented POST /people Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Request contract resignation

**Slug:** `DEEL_CREATE_EMPLOYEE_RESIGNATION`

Request contract resignation. Calls Deel's documented POST /eor/contracts/{contract_id}/offboarding/resignation Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique identifier of the employee contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an EOR contract

**Slug:** `DEEL_CREATE_EOR_CONTRACT`

Submit an Employer of Record contract for a quote on behalf of the authenticated user. The Organization OAuth connection must have contracts:write and access to the referenced organization resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create amendment

**Slug:** `DEEL_CREATE_EOR_CONTRACT_AMENDMENT`

Create amendment. Calls Deel's documented POST /eor/contracts/{contract_id}/amendments Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique identifier of the EOR worker contract |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create client sign off

**Slug:** `DEEL_CREATE_EOR_OFFBOARDING_CLIENT_SIGN_OFF`

Create client sign off. Calls Deel's documented POST /eor/contracts/{contract_id}/offboarding/review-client-sign-offs Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique identifier of the employee contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create EOR Worker

**Slug:** `DEEL_CREATE_EOR_WORKER`

Create an EOR worker account for an existing contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create equity or token tax event

**Slug:** `DEEL_CREATE_EQUITY_OR_TOKEN_TAX_EVENT`

Create equity or token tax event. Calls Deel's documented POST /equities-tokens/tax-events Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a Global Payroll (GP) contract

**Slug:** `DEEL_CREATE_GP_CONTRACT`

Create a Global Payroll contract on behalf of the authenticated user. The Organization OAuth connection must have contracts:write and access to the referenced team and legal entity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a Global Payroll worker

**Slug:** `DEEL_CREATE_GP_WORKER`

Create a Global Payroll worker. Calls Deel's documented POST /gp/workers Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add GP Workers Additional Information

**Slug:** `DEEL_CREATE_GP_WORKER_ADDITIONAL_INFORMATION`

Add GP Workers Additional Information. Calls Deel's documented POST /gp/workers/contracts/{contract_id}/additional-information Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Additional-information values keyed by public API field key. |
| `contract_id` | string | Yes | The unique public identifier of the contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add bank account

**Slug:** `DEEL_CREATE_GP_WORKER_BANK`

Add bank account. Calls Deel's documented POST /gp/workers/{worker_id}/banks Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `worker_id` | string | Yes | Unique identifier for a worker in UUID format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Request termination

**Slug:** `DEEL_CREATE_GP_WORKER_TERMINATION`

Request termination. Calls Deel's documented POST /gp/workers/{worker_id}/terminations Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `worker_id` | string | Yes | Unique identifier for a worker in UUID format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a group

**Slug:** `DEEL_CREATE_GROUP`

Create a group. Calls Deel's documented POST /groups Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new contract

**Slug:** `DEEL_CREATE_IC_CONTRACT`

Create an independent-contractor contract on behalf of the authenticated user. The Organization OAuth connection must have contracts:write and permission to the referenced team and legal entity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create IC invoicing tax

**Slug:** `DEEL_CREATE_IC_INVOICING_TAX`

Create IC invoicing tax. Calls Deel's documented POST /contracts/{contract_id}/ic-invoicing-taxes Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | Deel Contract ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an invoice adjustment

**Slug:** `DEEL_CREATE_INVOICE_ADJUSTMENT`

Create an invoice adjustment. Calls Deel's documented POST /invoice-adjustments Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Payload attributes required to create one invoice adjustment with optional approval, preset, and grouping metadata. |
| `recurring` | string | No | Add this invoice adjustment as recurring |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Review a single invoice adjustment

**Slug:** `DEEL_CREATE_INVOICE_ADJUSTMENT_REVIEW`

Review a single invoice adjustment. Calls Deel's documented POST /invoice-adjustments/{id}/reviews Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of an existing invoice adjustment. |
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an IT order

**Slug:** `DEEL_CREATE_IT_ORDER`

Create an IT order. Calls Deel's documented POST /it/orders Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new legal entity

**Slug:** `DEEL_CREATE_LEGAL_ENTITY`

Create a new legal entity. Calls Deel's documented POST /legal-entities Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a Manager

**Slug:** `DEEL_CREATE_MANAGER`

Create a Manager. Calls Deel's documented POST /managers Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Initiate EOR contract termination request

**Slug:** `DEEL_CREATE_OFFBOARDING_TERMINATION`

Initiate EOR contract termination request. Calls Deel's documented POST /eor/contracts/{contract_id}/offboarding/termination Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique identifier of the employee contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create On-Demand Payroll

**Slug:** `DEEL_CREATE_ON_DEMAND_PAYROLL`

Create On-Demand Payroll. Calls Deel's documented POST /on-demand-payroll/contract/{contract_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | Public ID (oid) of the contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create organization custom role.

**Slug:** `DEEL_CREATE_ORGANIZATION_ROLE`

Create organization custom role.. Calls Deel's documented POST /roles Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Organization Secure Vault Folder

**Slug:** `DEEL_CREATE_ORGANIZATION_SECURE_VAULT_FOLDER`

Create Organization Secure Vault Folder. Calls Deel's documented POST /organizations/secure-vault/folders Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | The folder to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new HRIS Organization Structure.

**Slug:** `DEEL_CREATE_ORGANIZATION_STRUCTURE`

Create a new HRIS Organization Structure.. Calls Deel's documented POST /hris/organization_structures Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Organization structure and initial teams. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create and Pay a Payment Statement

**Slug:** `DEEL_CREATE_PAYMENT_STATEMENT`

Create a Deel payment statement for up to 100 invoices and initiate payment. This is an irreversible financial operation; use a unique idempotency key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Invoices and settlement options. |
| `idempotency_key` | string | Yes | Unique idempotency key. Reuse only for an identical request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a person without a contract

**Slug:** `DEEL_CREATE_PERSON_WITHOUT_CONTRACT`

Create a person without a contract. Calls Deel's documented POST /pwac Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Termination Request

**Slug:** `DEEL_CREATE_REGULAR_TERMINATION`

Termination Request. Calls Deel's documented POST /eor/{oid}/terminations/regular Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `oid` | string | Yes | Public contract id |
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a request to exercise equity.

**Slug:** `DEEL_CREATE_REQUEST_EXERCISE_EQUITY`

Create a request to exercise equity.. Calls Deel's documented POST /equity/exercise Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fmv` | string | Yes | Documented fmv request body. |
| `quantity` | number | Yes | Documented quantity request body. |
| `issuer_id` | string | Yes | Documented issuer_id request body. |
| `worker_id` | string | Yes | Documented worker_id request body. |
| `address_zip` | string | Yes | Documented address_zip request body. |
| `exercise_id` | string | Yes | Documented exercise_id request body. |
| `address_city` | string | Yes | Documented address_city request body. |
| `address_state` | string | Yes | Documented address_state request body. |
| `address_street` | string | Yes | Documented address_street request body. |
| `stakeholder_id` | string | Yes | Documented stakeholder_id request body. |
| `address_country` | string | Yes | Documented address_country request body. |
| `option_grant_id` | string | Yes | Documented option_grant_id request body. |
| `fmv_currency_code` | string | Yes | Documented fmv_currency_code request body. |
| `stakeholder_email` | string | Yes | Documented stakeholder_email request body. |
| `option_grant_issue` | string | Yes | Documented option_grant_issue request body. |
| `option_grant_label` | string | Yes | Documented option_grant_label request body. |
| `option_grant_currency` | string | Yes | Documented option_grant_currency request body. |
| `option_grant_issue_date` | string | Yes | Documented option_grant_issue_date request body. |
| `option_grant_expiry_date` | string | Yes | Documented option_grant_expiry_date request body. |
| `stakeholder_relationship` | string | Yes | Documented stakeholder_relationship request body. |
| `option_grant_strike_price` | string | Yes | Documented option_grant_strike_price request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Request EOR Contract Resignation

**Slug:** `DEEL_CREATE_RESIGNATION`

Request EOR Contract Resignation. Calls Deel's documented POST /eor/{oid}/terminations/resignation Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `oid` | string | Yes | Public contract oid |
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Hourly Report Root Preset

**Slug:** `DEEL_CREATE_ROOT_TIMESHEETS_PRESET`

Create Hourly Report Root Preset. Calls Deel's documented POST /timesheets/root-presets Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | string | No | Documented file request body. |
| `type` | string ("RATE" | "TRACKING") | No | The type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate |
| `title` | string | Yes | Documented title request body. |
| `description` | string | No | Documented description request body. |
| `hourly_report_presets` | array | No | Documented hourly_report_presets request body. |
| `hourly_report_presets_processing_type` | string ("ASYNC" | "SYNC") | No | Determines whether presets should be processed synchronously or asynchronously |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create time-off request

**Slug:** `DEEL_CREATE_TIME_OFF_REQUEST`

Create time-off request. Calls Deel's documented POST /time_offs Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | The time off request data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a timesheet entry

**Slug:** `DEEL_CREATE_TIMESHEET`

Create a timesheet entry. Calls Deel's documented POST /timesheets Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Payload attributes required to create one timesheet entry with optional approval, preset, and grouping metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Review a single timesheet

**Slug:** `DEEL_CREATE_TIMESHEET_REVIEW`

Review a single timesheet. Calls Deel's documented POST /timesheets/{timesheet_id}/reviews Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Review decision payload to apply to the timesheet entry. |
| `timesheet_id` | string | Yes | ID of an existing timesheet |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Hourly Report Preset

**Slug:** `DEEL_CREATE_TIMESHEETS_PRESET`

Create Hourly Report Preset. Calls Deel's documented POST /timesheets/presets Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a New Shift Rate

**Slug:** `DEEL_CREATE_TIME_TRACKING_SHIFT_RATE`

Create a New Shift Rate. Calls Deel's documented POST /v2/time_tracking/shift_rates Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create shifts

**Slug:** `DEEL_CREATE_TIME_TRACKING_SHIFTS`

Create shifts. Calls Deel's documented POST /v2/time_tracking/shifts Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create raw time tracking shifts

**Slug:** `DEEL_CREATE_TIME_TRACKING_SHIFTS_RAW`

Create raw time tracking shifts. Calls Deel's documented POST /v2/time_tracking/shifts/raw Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Vendor Bill

**Slug:** `DEEL_CREATE_VENDOR_BILL`

Create a vendor bill from external invoice-provider data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Vendor bill data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Veriff session

**Slug:** `DEEL_CREATE_VERIFF_SESSION`

Create Veriff session. Calls Deel's documented POST /veriff/session Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a webhook

**Slug:** `DEEL_CREATE_WEBHOOK`

Create a webhook. Calls Deel's documented POST /webhooks Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Documented url request body. |
| `name` | string | Yes | Documented name request body. |
| `events` | array | Yes | Documented events request body. |
| `status` | string ("enabled" | "disabled") | Yes | Status of webhook. |
| `api_version` | string | Yes | Documented api_version request body. |
| `description` | string | Yes | Documented description request body. |
| `signing_key` | string | No | Documented signing_key request body. |
| `include_child_orgs` | boolean | No | Documented include_child_orgs request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a worker relation

**Slug:** `DEEL_CREATE_WORKER_RELATION_PROFILE`

Create a worker relation. Calls Deel's documented POST /hris/worker_relations/profile Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | The request payload containing the relationship details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create worker relation with external Ids

**Slug:** `DEEL_CREATE_WORKER_RELATION_PROFILE_EXTERNAL_ID`

Create worker relation with external Ids. Calls Deel's documented POST /hris/worker_relations/profile/external Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create worker relation type

**Slug:** `DEEL_CREATE_WORKER_RELATION_TYPE`

Create worker relation type. Calls Deel's documented POST /hris/worker_relations/types Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a work statement payment policy

**Slug:** `DEEL_CREATE_WORK_STATEMENT_PAYMENT_POLICY`

Create a work statement payment policy. Calls Deel's documented POST /work-statement-payment-policies Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Approve or reject quotes on a clearance request

**Slug:** `DEEL_DECIDE_CLEARANCE_REQUEST`

Approve or reject quotes on a clearance request. Calls Deel's documented POST /it/clearance-requests/{clearance_request_id}/decide Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `clearance_request_id` | string | Yes | Unique identifier of the clearance request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reject an IT order

**Slug:** `DEEL_DECLINE_IT_ORDER`

Reject an IT order. Calls Deel's documented POST /it/orders/{order_id}/decline Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Unique identifier of the IT order |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delay EOR employee onboarding

**Slug:** `DEEL_DELAY_ONBOARDING`

Delay EOR employee onboarding. Calls Deel's documented PATCH /eor/contract/{oid}/delay-onboarding Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `oid` | string | Yes | Contract oid |
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an adjustment

**Slug:** `DEEL_DELETE_CONTRACT_ADJUSTMENT`

Delete an adjustment. Calls Deel's documented DELETE /adjustments/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Deel adjustment id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel amendment

**Slug:** `DEEL_DELETE_CONTRACT_AMENDMENT`

Cancel amendment. Calls Deel's documented DELETE /eor/contracts/{contract_id}/amendments/{amendment_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of EOR worker contract. |
| `amendment_id` | string | Yes | A unique identifier for the employee contract amendment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contract custom field by Id

**Slug:** `DEEL_DELETE_CONTRACT_CUSTOM_FIELD`

Delete Contract custom field by Id. Calls Deel's documented DELETE /contracts/{contract_id}/custom_fields/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Custom field id. |
| `contract_id` | string | Yes | Contract id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove invite

**Slug:** `DEEL_DELETE_CONTRACT_INVITATIONS`

Remove invite. Calls Deel's documented DELETE /contracts/{contract_id}/invitations Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | Deel contract id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a Milestone

**Slug:** `DEEL_DELETE_CONTRACT_MILESTONE`

Delete a Milestone. Calls Deel's documented DELETE /contracts/{contract_id}/milestones/{milestone_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of the Deel contract from which the milestone will be deleted. |
| `milestone_id` | string | Yes | The unique identifier of the milestone that is to be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete task

**Slug:** `DEEL_DELETE_CONTRACT_TASK`

Delete task. Calls Deel's documented DELETE /contracts/{contract_id}/tasks/{task_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reason` | string | No | The reason for deleting the task. This can be used for auditing purposes. |
| `task_id` | string | Yes | The unique identifier of the task to be deleted. |
| `contract_id` | string | Yes | The unique identifier of the Deel contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contract Termination Request

**Slug:** `DEEL_DELETE_CONTRACT_TERMINATION`

Delete Contract Termination Request. Calls Deel's documented DELETE /contracts/{contract_id}/terminations Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | Unique identifier for the contract |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a group

**Slug:** `DEEL_DELETE_GROUP`

Delete a group. Calls Deel's documented DELETE /groups/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the group to be archived. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete IC invoicing tax

**Slug:** `DEEL_DELETE_IC_INVOICING_TAX`

Delete IC invoicing tax. Calls Deel's documented DELETE /contracts/{contract_id}/ic-invoicing-taxes/{tax_type} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tax_type` | string ("WITHHOLDING_TAX" | "VAT") | Yes | IC tax type |
| `contract_id` | string | Yes | Deel Contract ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete adjustment

**Slug:** `DEEL_DELETE_INVOICE_ADJUSTMENT`

Delete adjustment. Calls Deel's documented DELETE /invoice-adjustments/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Invoice adjustment id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a legal entity

**Slug:** `DEEL_DELETE_LEGAL_ENTITY`

Delete a legal entity. Calls Deel's documented DELETE /legal-entities/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the legal entity to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Legal Entity Registration Document

**Slug:** `DEEL_DELETE_LEGAL_ENTITY_REGISTRATION_DOCUMENT`

Delete Legal Entity Registration Document. Calls Deel's documented DELETE /legal-entities/{legal_entity_id}/registration-documents/{document_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | Public UUID of the document submission. |
| `legal_entity_id` | string | Yes | Public UUID of the legal entity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Legal Entity Registration Document Files

**Slug:** `DEEL_DELETE_LEGAL_ENTITY_REGISTRATION_DOCUMENT_FILES`

Delete Legal Entity Registration Document Files. Calls Deel's documented DELETE /legal-entities/{legal_entity_id}/registration-documents/{document_id}/files Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `document_id` | string | Yes | Public UUID of the document submission. |
| `legal_entity_id` | string | Yes | Public UUID of the legal entity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete multiple shifts by External ID

**Slug:** `DEEL_DELETE_MULTIPLE_SHIFTS_EXTERNAL_ID`

Delete multiple shifts by External ID. Calls Deel's documented POST /v2/time_tracking/shifts/bulk-delete Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Organization Secure Vault File

**Slug:** `DEEL_DELETE_ORGANIZATION_SECURE_VAULT_FILE`

Delete Organization Secure Vault File. Calls Deel's documented DELETE /organizations/secure-vault/files/{file_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | string | Yes | Public UUID of the Organization Secure Vault file. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Organization Secure Vault Folder

**Slug:** `DEEL_DELETE_ORGANIZATION_SECURE_VAULT_FOLDER`

Delete Organization Secure Vault Folder. Calls Deel's documented DELETE /organizations/secure-vault/folders/{folder_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | Public UUID of the folder. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an Org Structure from the Organization

**Slug:** `DEEL_DELETE_ORGANIZATION_STRUCTURE`

Delete an Org Structure from the Organization. Calls Deel's documented DELETE /hris/organization_structures/{hris_org_structure_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hris_org_structure_id` | string | Yes | Org Structure |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an Org Structure from the Organization by external ID

**Slug:** `DEEL_DELETE_ORGANIZATION_STRUCTURE_EXTERNAL_ID`

Delete an Org Structure from the Organization by external ID. Calls Deel's documented DELETE /hris/organization_structures/external/{external_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `external_id` | string | Yes | External ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete the custom field value from Worker by Id

**Slug:** `DEEL_DELETE_PERSON_CUSTOM_FIELD`

Delete the custom field value from Worker by Id. Calls Deel's documented DELETE /people/{worker_id}/custom_fields/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Custom field id. |
| `worker_id` | string | Yes | Worker id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a Shift Rate by external ID

**Slug:** `DEEL_DELETE_SHIFT_RATE_BY_EXTERNAL_ID`

Permanently delete a shift rate by the custom external ID assigned when it was created; deletion fails while the rate is associated with an active shift.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `external_id` | string | Yes | Custom shift-rate identifier assigned when the shift rate was created. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel time-off request

**Slug:** `DEEL_DELETE_TIME_OFF_REQUEST`

Cancel time-off request. Calls Deel's documented DELETE /time_offs/{time_off_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `time_off_id` | string | Yes | Time off request id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a timesheet entry

**Slug:** `DEEL_DELETE_TIMESHEET_ID`

Delete a timesheet entry. Calls Deel's documented DELETE /timesheets/{timesheet_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reason` | string | No | Reason for deleting an existing task |
| `timesheet_id` | string | Yes | ID of an existing timesheet |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Hourly Report Preset

**Slug:** `DEEL_DELETE_TIMESHEETS_PRESET`

Delete Hourly Report Preset. Calls Deel's documented DELETE /timesheets/presets/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the hourly report preset to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a Shift by External ID

**Slug:** `DEEL_DELETE_TIME_TRACKING_SHIFT_EXTERNAL_ID`

Delete a Shift by External ID. Calls Deel's documented DELETE /time_tracking/shifts/{external_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `external_id` | string | Yes | The unique external identifier of the shift to be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a webhook

**Slug:** `DEEL_DELETE_WEBHOOK`

Delete a webhook. Calls Deel's documented DELETE /webhooks/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the webhook subscription. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a worker relation

**Slug:** `DEEL_DELETE_WORKER_RELATION_PROFILE`

Delete a worker relation. Calls Deel's documented DELETE /hris/worker_relations/profile/{hrisProfileOid} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hris_profile_oid` | string | Yes | Public worker relation ID to delete, despite the provider path parameter name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a worker relation by external id

**Slug:** `DEEL_DELETE_WORKER_RELATION_PROFILE_EXTERNAL_ID`

Delete a worker relation by external id. Calls Deel's documented DELETE /hris/worker_relations/profile/external/{profileId} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile_id` | string | Yes | External worker relation ID to delete, despite the provider path parameter name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a worker relation type

**Slug:** `DEEL_DELETE_WORKER_RELATION_TYPE`

Delete a worker relation type. Calls Deel's documented DELETE /hris/worker_relations/types/{type_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type_id` | string | Yes | Worker Relation Type ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a worker relation type by external id

**Slug:** `DEEL_DELETE_WORKER_RELATION_TYPE_EXTERNAL_ID`

Delete a worker relation type by external id. Calls Deel's documented DELETE /hris/worker_relations/types/external/{externalId} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `external_id` | string | Yes | Worker Relation Type external ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a delivery request for an IT asset

**Slug:** `DEEL_DELIVER_IT_ASSET`

Create a delivery request for an IT asset. Calls Deel's documented POST /it/assets/{asset_id}/deliver Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `asset_id` | string | Yes | Unique identifier of the IT asset |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Detach entries from On-Demand Payroll

**Slug:** `DEEL_DETACH_ON_DEMAND_PAYROLL_ENTRIES`

Detach entries from On-Demand Payroll. Calls Deel's documented PATCH /on-demand-payroll/{odp_id}/entries/detach Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `odp_id` | string | Yes | Public ID of the On-Demand Payroll. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download a GP worker payslip

**Slug:** `DEEL_DOWNLOAD_GP_WORKER_PAYSLIP`

Download a GP worker payslip. Calls Deel's documented GET /gp/workers/{id}/payslips/{payslip_id}/download Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier for the worker. |
| `payslip_id` | string | Yes | Public identifier for the payslip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download HRX documents

**Slug:** `DEEL_DOWNLOAD_HRX_DOCUMENTS`

Download HRX documents. Calls Deel's documented GET /eor/contracts/{contract_id}/hrx-documents/{document_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of the employee contract. |
| `document_id` | string | Yes | The unique identifier of the document to download. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Legal Entity Registration Document File

**Slug:** `DEEL_DOWNLOAD_LEGAL_ENTITY_REGISTRATION_DOCUMENT_FILE`

Download Legal Entity Registration Document File. Calls Deel's documented GET /legal-entities/{legal_entity_id}/registration-documents/{document_id}/files/{file_id}/download Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | string | Yes | Public UUID of a file attached to the submission. |
| `document_id` | string | Yes | Public UUID of the document submission. |
| `legal_entity_id` | string | Yes | Public UUID of the legal entity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Legal Entity Registration Document Requirement Template

**Slug:** `DEEL_DOWNLOAD_REGISTRATION_REQUIREMENT_TEMPLATE`

Get a time-limited download URL for a legal-entity registration document requirement template; fetch the URL promptly because it expires.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `requirement_id` | string | Yes | Public UUID of the document requirement. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign an addon to an IT asset

**Slug:** `DEEL_ENROL_ASSET_INTO_ADDON`

Assign an addon to an IT asset. Calls Deel's documented POST /it/assets/{asset_id}/addons/{addon_id}/assign Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `addon_id` | string | Yes | Unique identifier of the addon |
| `asset_id` | string | Yes | Unique identifier of the IT asset |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get EOR Additional Costs

**Slug:** `DEEL_GET_ADDITIONAL_COSTS`

Get EOR Additional Costs. Calls Deel's documented GET /eor/additional-costs/{country} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | Yes | The two-letter ISO code of the country for which to retrieve the EOR additional costs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get amendment data points configuration by country

**Slug:** `DEEL_GET_AMENDMENT_DATA_POINTS_CONFIGURATION_COUNTRY`

Get amendment data points configuration by country. Calls Deel's documented GET /eor/contracts/amendments/data-points/configuration Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return per page. |
| `cursor` | string | No | Cursor from a previous response to fetch the next page of results. |
| `enabled` | boolean | No | When true, returns only enabled data points. A data point is enabled if at least one of its items is not DISABLED_AMENDMENTS. |
| `countries` | array | No | Optional list of ISO 3166-1 alpha-2 country codes to filter results. Returns all countries if omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get entity screening details

**Slug:** `DEEL_GET_AML_DETAILS`

Get entity screening details. Calls Deel's documented GET /screenings/aml/{entity_type}/{entity_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | string | Yes | UUID v4 of the entity |
| `entity_type` | string ("profile" | "hris_profile" | "legal_entity") | Yes | The type of entity to screen. Only 'profile', 'hris_profile', 'legal_entity' are accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get ATS Application

**Slug:** `DEEL_GET_ATS_APPLICATION`

Retrieve complete details for one ATS application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `application_id` | string | Yes | Application to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve ATS Application form

**Slug:** `DEEL_GET_ATS_APPLICATION_FORM`

Retrieve ATS Application form. Calls Deel's documented GET /ats/application-forms/{application_form_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `application_form_id` | string | Yes | Id of the application form |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve an ATS candidate

**Slug:** `DEEL_GET_ATS_CANDIDATE`

Retrieve an ATS candidate. Calls Deel's documented GET /ats/candidates/{candidate_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `candidate_id` | string | Yes | Unique identifier of the candidate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve ATS job posting

**Slug:** `DEEL_GET_ATS_JOB_POSTING`

Retrieve ATS job posting. Calls Deel's documented GET /ats/job-postings/{job_posting_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_posting_id` | string | Yes | Unique identifier of the job posting to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Billing Invoice Download Link

**Slug:** `DEEL_GET_BILLING_INVOICE_DOWNLOAD_LINK`

Get a temporary download URL for a Deel billing invoice PDF.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Invoice ID whose PDF download link to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get business visa eligibility and requirements

**Slug:** `DEEL_GET_BUSINESS_VISA_REQUIREMENT`

Get business visa eligibility and requirements. Calls Deel's documented GET /immigration/visa-requirement/business Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `nationality` | string | Yes | The nationality country code of the person in ISO 3166-1 alpha-2 format |
| `trip_reason` | string ("INTERNAL_BUSINESS_WITH_WORK_FOR_CLIENT" | "INTERNAL_BUSINESS_WITHOUT_WORK_FOR_CLIENT" | "MEETINGS_WITH_OR_FOR_A_CLIENT" | "MEETINGS_WITH_POTENTIAL_CLIENTS" | "NEGOTIATING_CONTRACTS_OR_SIGNING_AGREEMENTS" | "OTHER_EXTERNAL_BUSINESS" | "CONFERENCE" | "TEAM_OFFSITE" | "SPEAKING_AT_CONFERENCE_UNPAID" | "SPEAKING_AT_CONFERENCE_PAID" | "ATTENDING_INTERNAL_TRAINING" | "ATTENDING_EXTERNAL_TRAINING" | "DELIVERING_TRAINING_TO_INTERNAL_PARTICIPANTS" | "DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_UNPAID" | "DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_PAID" | "PARTICIPATION_IN_RESEARCH_PROJECTS_AND_STUDIES" | "ASSEMBLY_MAINTENANCE_REPAIR_INSTALLATION" | "TECHNICAL_SUPPORT_OR_SUPERVISION" | "OTHER_HANDS_ON_LABOUR" | "MARKET_RESEARCH_AND_EXPLORING_INVESTMENT_OPPORTUNITIES" | "OTHER") | Yes | The reason for the trip |
| `trip_end_date` | string | Yes | The trip end date in ISO 8601 format (YYYY-MM-DD) |
| `trip_start_date` | string | Yes | The trip start date in ISO 8601 format (YYYY-MM-DD) |
| `residence_country` | string | Yes | The residence country code of the person in ISO 3166-1 alpha-2 format |
| `second_nationality` | string | No | The second nationality country code of the person in ISO 3166-1 alpha-2 format (optional) |
| `destination_country` | string | Yes | The destination country code of the trip in ISO 3166-1 alpha-2 format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get case timeline

**Slug:** `DEEL_GET_CASE_TIMELINE`

Get case timeline. Calls Deel's documented GET /immigration/cases/{case_id}/timeline Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `case_id` | string | Yes | The unique identifier of the case whose timeline should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a clearance request

**Slug:** `DEEL_GET_CLEARANCE_REQUEST`

Retrieve a clearance request. Calls Deel's documented GET /it/clearance-requests/{clearance_request_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `clearance_request_id` | string | Yes | Unique identifier of the clearance request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get immigration case details

**Slug:** `DEEL_GET_CLIENT_CASE`

Get immigration case details. Calls Deel's documented GET /immigration/client/cases/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Immigration case id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a single contract

**Slug:** `DEEL_GET_CONTRACT`

Retrieve a single contract. Calls Deel's documented GET /contracts/{contract_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Include additional fields in the response. Multiple values can be passed as comma-separated list. |
| `contract_id` | string | Yes | Unique identifier of the contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get additional info for a contract

**Slug:** `DEEL_GET_CONTRACT_ADDITIONAL_INFO`

Get additional info for a contract. Calls Deel's documented GET /contracts/{contract_id}/additional-info Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of the GP contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve an adjustment

**Slug:** `DEEL_GET_CONTRACT_ADJUSTMENT`

Retrieve an adjustment. Calls Deel's documented GET /adjustments/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Deel adjustment id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get amendment by ID

**Slug:** `DEEL_GET_CONTRACT_AMENDMENT_ID`

Get amendment by ID. Calls Deel's documented GET /eor/contracts/{contract_id}/amendments/{amendment_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of EOR worker contract. |
| `amendment_id` | string | Yes | A unique identifier for the employee contract amendment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Contract amendment PDF

**Slug:** `DEEL_GET_CONTRACT_AMENDMENT_PDF`

Contract amendment PDF. Calls Deel's documented GET /eor/contracts/{contract_id}/amendments/{amendment_id}/pdf Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of EOR worker contract. |
| `amendment_id` | string | Yes | A unique identifier for the employee contract amendment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get amendment validation settings

**Slug:** `DEEL_GET_CONTRACT_AMENDMENTS_VALIDATION_SETTINGS`

Get amendment validation settings. Calls Deel's documented GET /eor/contracts/{contract_id}/amendments/validation/settings Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of EOR worker contract. |
| `employment_state` | string | No | The employment state of the EOR worker contract |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get custom fields from contracts

**Slug:** `DEEL_GET_CONTRACT_CUSTOM_FIELD_DEFINITION`

Retrieve one contract custom-field definition by its ID, including its type, settings, placement, and access configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Custom field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get worker invite link

**Slug:** `DEEL_GET_CONTRACT_INVITE`

Get worker invite link. Calls Deel's documented GET /contracts/{contract_id}/invite Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `locale` | string | No | Locale to use for the invite link. |
| `contract_id` | string | Yes | Deel contract id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a single milestone

**Slug:** `DEEL_GET_CONTRACT_MILESTONE_ID`

Retrieve a single milestone. Calls Deel's documented GET /contracts/{contract_id}/milestones/{milestone_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | Deel contract id. |
| `milestone_id` | string | Yes | ID of milestone to return |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve offboarding attachment

**Slug:** `DEEL_GET_CONTRACT_OFFBOARDING_ATTACHMENT_ID`

Retrieve offboarding attachment. Calls Deel's documented GET /eor/contracts/{contract_id}/offboarding/attachments/{attachment_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of the employee contract. |
| `attachment_id` | string | Yes | The unique identifier of the attachment to download. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a single off-cycle payment

**Slug:** `DEEL_GET_CONTRACT_OFF_CYCLE_PAYMENT`

Retrieve a single off-cycle payment. Calls Deel's documented GET /contracts/{contract_id}/off-cycle-payments/{off_cycle_payment_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | Deel contract id. |
| `off_cycle_payment_id` | string | Yes | Deel off-cycle payment id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview a contract agreement

**Slug:** `DEEL_GET_CONTRACT_PREVIEW`

Preview a contract agreement. Calls Deel's documented GET /contracts/{contract_id}/preview Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | Deel contract id. |
| `template_id` | string | No | ID of an existing contract template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get registration/tax identifier fields for a country

**Slug:** `DEEL_GET_COUNTRY_FIELDS_LEGAL_ENTITY`

Get registration/tax identifier fields for a country. Calls Deel's documented GET /legal-entities/country-fields/{country_code} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country_code` | string | Yes | ISO 3166-1 alpha-2 country code. Case-insensitive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Knowledge Hub Country Guides by Country Code

**Slug:** `DEEL_GET_COUNTRY_GUIDE`

Get a country's Knowledge Hub guide, organized by audience and contract type with category fields and related knowledge or compliance articles.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country_code` | string | Yes | Country code for which we need to fetch the country guides |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch EOR Contract form

**Slug:** `DEEL_GET_CREATE_CONTRACT_FORM`

Fetch EOR Contract form. Calls Deel's documented GET /forms/eor/create-contract/{country_code} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `state` | string | No | The selected state code of the contract. This is only required for countries that specify it. |
| `start_date` | string | No | The selected start date of the contract in ISO 8601 formatted date string. |
| `country_code` | string | Yes | Two-letter country code in ISO 3166-1 alpha-2 format |
| `work_hours_per_week` | integer | No | The selected number of work hours per week. |
| `contract_duration_in_days` | integer | No | The contract duration in days for definite contracts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current Personal Profile

**Slug:** `DEEL_GET_CURRENT_PERSONAL_PROFILE`

Return the profile of the currently authenticated user, not an organization-wide person lookup. This Organization OAuth toolkit requires authenticated-user context plus people:read for this route.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve employee additional info template

**Slug:** `DEEL_GET_EMPLOYEE_ADDITIONAL_INFO_TEMPLATE`

List the country- and contract-type-specific additional information fields needed to build or validate an employee onboarding form.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("eor" | "gp") | Yes | The contract type. Must be 'eor' (Employer of Record) or 'gp' (Global Payroll). |
| `country` | string | Yes | ISO 3166-1 alpha-2 country code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get employee agreement draft preview

**Slug:** `DEEL_GET_EMPLOYEE_AGREEMENT_DRAFT_PREVIEW`

Get employee agreement draft preview. Calls Deel's documented GET /eor/contracts/{contract_id}/employee-agreement-draft-preview Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | No | Task ID from a previous response. Omit on first call. Provide on subsequent calls to poll for completion. |
| `contract_id` | string | Yes | The unique identifier of the EOR contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch EOR contract document

**Slug:** `DEEL_GET_EOR_CONTRACT_DOCUMENT_TYPE`

Fetch EOR contract document. Calls Deel's documented GET /eor/contracts/{contract_id}/documents/{type} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | Yes | The type of document. Currently only FRAMEWORK_AGREEMENT is supported. |
| `contract_id` | string | Yes | EOR contract ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get additional information required to request employee termination

**Slug:** `DEEL_GET_EOR_CONTRACT_OFFBOARDING_REQUIRED_INFORMATION`

Get additional information required to request employee termination. Calls Deel's documented GET /eor/contracts/{contract_id}/offboarding/required-information Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of the employee contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Start Date for EOR Contracts

**Slug:** `DEEL_GET_EOR_CONTRACT_START_DATE`

Calculate the earliest possible EOR employment start date and payroll timing for a team, employment country, and optional nationality, visa, legal-entity, state, or special-job inputs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | Team ID |
| `work_visa` | boolean | No | Whether a work visa is required |
| `special_job_id` | string | No | Special job ID (if applicable) |
| `legal_entity_id` | string | No | Legal entity ID |
| `employment_state` | string | No | State or province of employment |
| `employment_country` | string | Yes | Employment country in ISO 3166-1 alpha-2 format |
| `employee_nationality` | string | No | Employee nationality in ISO 3166-1 alpha-2 format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve detailed hiring guide for a country

**Slug:** `DEEL_GET_EOR_HIRING_GUIDE_COUNTRY`

Retrieve detailed hiring guide for a country. Calls Deel's documented GET /eor/validations/{country_code} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country_code` | string | Yes | The two-letter ISO code of the country for which to retrieve the hiring guide. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check file upload status

**Slug:** `DEEL_GET_FILE_UPLOAD_STATUS`

Check a Deel file upload's virus-scan status. The upload claim token must come from Deel's POST /files response for the same fileid and is scoped to that initialized file. Calls Deel's documented GET /files/{fileid}/status Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fileid` | string | Yes | File UUID from the register response. |
| `upload_claim_token` | string | Yes | Single-use, resource-scoped claim token returned by Deel's POST /files response for the matching file_id. Pass it only to the matching upload status, completion, or file-claim action; do not pass any other token. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download gross to net report

**Slug:** `DEEL_GET_GP_REPORT_GROSS_NET_CSV`

Download gross to net report. Calls Deel's documented GET /gp/reports/{id}/gross_to_net/csv Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id of the gp payroll report. |
| `currency` | string | No | Currency to be used in the report calculation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Hourly Report Root Preset by ID

**Slug:** `DEEL_GET_HOURLY_REPORT_ROOT_PRESET_ID`

Get Hourly Report Root Preset by ID. Calls Deel's documented GET /timesheets/root-presets/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the hourly report root preset to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Immigration document

**Slug:** `DEEL_GET_IMMIGRATION_DOCUMENT`

Retrieve one immigration document by ID, including its review status, document type, expiration date, and download links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Immigration case document id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Integration Consent

**Slug:** `DEEL_GET_INTEGRATION_CONSENT`

Retrieve the OAuth consent record for the authenticated user or organization.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get an interview transcript

**Slug:** `DEEL_GET_INTERVIEW_TRANSCRIPT`

Get an interview transcript. Calls Deel's documented GET /ats/interviews/{interview_id}/transcript Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of transcript segments to return per page. |
| `cursor` | string | No | Pagination cursor returned by a previous response. |
| `interview_id` | string | Yes | Unique identifier of the interview to retrieve the transcript for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Invoice line item by Id

**Slug:** `DEEL_GET_INVOICE_ADJUSTMENT_ID`

Invoice line item by Id. Calls Deel's documented GET /invoice-adjustments/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of an existing invoice |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Invoice by ID

**Slug:** `DEEL_GET_INVOICE_ID`

Retrieve one Deel invoice and its line items by invoice ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invoice_id` | string | Yes | Invoice ID to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve an agreement

**Slug:** `DEEL_GET_IT_AGREEMENT`

Retrieve an agreement. Calls Deel's documented GET /it/agreements/{agreement_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `agreement_id` | string | Yes | Unique identifier of the agreement |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve an IT asset

**Slug:** `DEEL_GET_IT_ASSET`

Retrieve an IT asset. Calls Deel's documented GET /it/assets/{asset_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `asset_id` | string | Yes | Unique identifier of the IT asset |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve an IT order

**Slug:** `DEEL_GET_IT_ORDER`

Retrieve an IT order. Calls Deel's documented GET /it/orders/{order_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Unique identifier of the IT order |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a product's catalog details

**Slug:** `DEEL_GET_IT_PRODUCT`

Retrieve a product's catalog details. Calls Deel's documented GET /it/products/{product_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | No | ISO 3166 alpha-2 country code. When set, restricts returned variants to those shipping to this country. |
| `product_id` | string | Yes | Unique identifier of the product |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a warehouse

**Slug:** `DEEL_GET_IT_WAREHOUSE`

Retrieve a warehouse. Calls Deel's documented GET /it/warehouses/{warehouse_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `warehouse_id` | string | Yes | Unique identifier of the warehouse |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get worker's KYC details

**Slug:** `DEEL_GET_KYC_DETAILS`

Get worker's KYC details. Calls Deel's documented GET /screenings/kyc/details Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile_id` | string | No | Worker's profile public ID client requests to fetch KYC details for, This parameter is mutually exclusive with worker_profile_id |
| `contract_id` | string | No | Worker's contract ID. This parameter is required in case there are multiple profiles associated to the target worker. For example, when worker used to work for the former company he had another profile ID. So we need contract ID to properly resolve profile's KYC details. In case this parameter is not provided and multiple associated profiles are found, exception with 409 status code will be thrown |
| `worker_profile_id` | string | No | Worker's HRIS profile public ID client requests to fetch KYC details for. This parameter is mutually exclusive with profile_id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get verification method

**Slug:** `DEEL_GET_KYC_VERIFICATION_METHOD`

Get the supported KYC verification method for an identity document type and its ISO issuing-country code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | Yes | The document's issuing country code (ISO 3166-1 alpha-2) |
| `document_type` | string ("passport" | "government_id" | "driving_license" | "other") | Yes | The document to be provided during KYC |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a legal entity

**Slug:** `DEEL_GET_LEGAL_ENTITY`

Retrieve a legal entity. Calls Deel's documented GET /legal-entities/{legal_entity_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `legal_entity_id` | string | Yes | The ID of the legal entity to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get cost centers by legal entity

**Slug:** `DEEL_GET_LEGAL_ENTITY_COST_CENTERS`

Get cost centers by legal entity. Calls Deel's documented GET /legal-entities/{legal_entity_id}/cost-centers Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `legal_entity_id` | string | Yes | Legal entity id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Legal Entity Registration Document

**Slug:** `DEEL_GET_LEGAL_ENTITY_REGISTRATION_DOCUMENT`

Get Legal Entity Registration Document. Calls Deel's documented GET /legal-entities/{legal_entity_id}/registration-documents/{document_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | Public UUID of the document submission. |
| `legal_entity_id` | string | Yes | Public UUID of the legal entity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch multiple EOR Contract forms

**Slug:** `DEEL_GET_MULTIPLE_EOR_CONTRACT_FORMS`

Fetch multiple EOR Contract forms. Calls Deel's documented POST /forms/eor/create-contract/definitions Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `limit` | integer | No | Maximum number of countries to return in a single response. Defaults to 10. |
| `cursor` | string | No | Pagination cursor for fetching subsequent pages of results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get onboarding details by employee HRIS profile ID

**Slug:** `DEEL_GET_ONBOARDING_BY_HRIS_PROFILE`

Get onboarding details by employee HRIS profile ID. Calls Deel's documented GET /onboarding/tracker/hris_profile/{hris_profile_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hris_profile_id` | string | Yes | The unique identifier of the employee HRIS profile. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get onboarding details by onboarding tracker ID

**Slug:** `DEEL_GET_ONBOARDING_DETAILS_ONBOARDING_TRACKER_ID`

Get onboarding details by onboarding tracker ID. Calls Deel's documented GET /onboarding/tracker/{tracker_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tracker_id` | string | Yes | The unique identifier of the onboarding tracker. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization Secure Vault Folder

**Slug:** `DEEL_GET_ORGANIZATION_SECURE_VAULT_FOLDER`

Get Organization Secure Vault Folder. Calls Deel's documented GET /organizations/secure-vault/folders/{folder_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | Public UUID of the folder. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization Structure

**Slug:** `DEEL_GET_ORGANIZATION_STRUCTURE`

Get Organization Structure. Calls Deel's documented GET /hris/organization_structures/{hris_org_structure_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hris_org_structure_id` | string | Yes | HRIS Organization Structure ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization Structure by External ID

**Slug:** `DEEL_GET_ORGANIZATION_STRUCTURE_EXTERNAL_ID`

Get Organization Structure by External ID. Calls Deel's documented GET /hris/organization_structures/external/{external_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `external_id` | string | Yes | External ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Payment Statement

**Slug:** `DEEL_GET_PAYMENT_STATEMENT`

Retrieve a Deel payment statement by its unique identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payment_statement_id` | string | Yes | Unique payment statement identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get payroll activation readiness for a legal entity

**Slug:** `DEEL_GET_PAYROLL_ACTIVATIONS`

Get payroll activation readiness for a legal entity. Calls Deel's documented GET /payroll-activations Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `legal_entity_id` | string | Yes | The unique identifier of the legal entity whose payroll readiness should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Gets G2N report data for a given payroll cycle by it's ID.

**Slug:** `DEEL_GET_PAYROLL_CYCLE_GROSS_TO_NET_REPORT`

Get a paginated gross-to-net report for a payroll cycle, with contract-level additions, deductions, benefits, contributions, totals, currencies, and payment details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of items to return. Defaults to 20. |
| `cursor` | string | No | Cursor for pagination of results. |
| `cycle_id` | string | Yes | The unique identifier for the payroll event. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a payroll migration import

**Slug:** `DEEL_GET_PAYROLL_MIGRATION_IMPORT`

Get a payroll migration import. Calls Deel's documented GET /gp/legal-entities/{legal_entity_id}/payroll-migration-imports/{import_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `import_id` | string | Yes | The unique identifier of the payroll migration import, as returned when it was submitted. |
| `legal_entity_id` | string | Yes | The unique identifier of the legal entity the payroll migration import belongs to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get custom field from people by id

**Slug:** `DEEL_GET_PERSON_CUSTOM_FIELD`

Get custom field from people by id. Calls Deel's documented GET /people/custom_fields/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Custom field id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a single person

**Slug:** `DEEL_GET_PERSON_ID`

Retrieve a single person. Calls Deel's documented GET /people/{hris_profile_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hris_profile_id` | string | Yes | Unique identifier for the person. |
| `include_custom_fields` | boolean | No | Include custom fields in the response. |
| `include_worker_relations` | boolean | No | Include worker relations in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get personal information by id

**Slug:** `DEEL_GET_PERSON_PERSONAL_INFO`

Get personal information by id. Calls Deel's documented GET /people/{worker_id}/personal Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `worker_id` | string | Yes | Unique identifier for a worker (External ID). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get worker profile by external ID

**Slug:** `DEEL_GET_PERSON_PERSONAL_INFO_EXTERNAL_ID`

Get worker profile by external ID. Calls Deel's documented GET /people/external/{worker_id}/personal Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `worker_id` | string | Yes | System-wide external identifier for a worker record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Positions by Profile

**Slug:** `DEEL_GET_POSITIONS_PROFILE`

Get Positions by Profile. Calls Deel's documented GET /hris/positions/profile/{hris_profile_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hris_profile_id` | string | Yes | HRIS Profile ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Profiles Assigned to Policy

**Slug:** `DEEL_GET_PROFILES_ASSIGNED_POLICY`

Get Profiles Assigned to Policy. Calls Deel's documented GET /time-offs/policy/{policy_id}/assignments Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Pagination cursor returned by Deel. |
| `page_size` | integer | No | Items per page (max 100) |
| `policy_id` | string | Yes | Policy UID, as returned by the Get Policies for Organization endpoint |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch EOR project assignment PDF

**Slug:** `DEEL_GET_PROJECT_ASSIGNMENT`

Fetch EOR project assignment PDF. Calls Deel's documented GET /eor/contracts/{contract_id}/project-assignment Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `version` | string | No | This field is to ensure that the latest version of the project assignment PDF matches the version received from the webhook. If it is not sent, the version validation is not performed and the endpoint returns the PDF. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the PDF is returned. |
| `contract_id` | string | Yes | The unique identifier of the employee contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Project Assignment Checkin Questionnaire Data

**Slug:** `DEEL_GET_PROJECT_ASSIGNMENT_CHECKIN`

Fetch Project Assignment Checkin Questionnaire Data. Calls Deel's documented GET /eor/contracts/{contract_id}/project-assignment/checkin Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("EMPLOYEE" | "CLIENT") | Yes | Whether to fetch the employee or client check-in questionnaire. |
| `version` | string | No | This field is to ensure that the latest version of the project assignment checkin matches the version received from the webhook. If it is not sent, the version validation is not performed. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the data is returned. |
| `contract_id` | string | Yes | The unique identifier of the contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the roles of the current organization.

**Slug:** `DEEL_GET_ROLES_CURRENT_ORGANIZATION`

Get the roles of the current organization.. Calls Deel's documented GET /roles Organization OAuth candidate operation.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a Shift Rate by External ID

**Slug:** `DEEL_GET_SHIFT_RATE_BY_EXTERNAL_ID`

Retrieve a Shift Rate by External ID. Calls Deel's documented GET /time_tracking/shift_rates/{external_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `external_id` | string | Yes | The unique external identifier of the shift rate to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get static employee bank transfer requirements

**Slug:** `DEEL_GET_STATIC_EMPLOYEE_BANK_TRANSFER_REQUIREMENTS`

Get static employee bank transfer requirements. Calls Deel's documented GET /payouts/employees/methods/bank-transfers/requirements Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | Yes | Bank country as an ISO 3166-1 alpha-2 code. |
| `currency` | string | Yes | Payout currency as an ISO 4217 code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get termination

**Slug:** `DEEL_GET_TERMINATION`

Get termination. Calls Deel's documented GET /eor/{oid}/terminations/{terminationId} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `oid` | string | Yes | Public contract oid |
| `termination_id` | string | Yes | Termination id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve termination details

**Slug:** `DEEL_GET_TERMINATION_DETAILS`

Retrieve termination details. Calls Deel's documented GET /offboarding/tracker/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Base64 offboarding tracker ID from the unique_id field returned by LIST_OFFBOARDING_LIST. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve termination details by HRIS profile identifier

**Slug:** `DEEL_GET_TERMINATION_DETAILS_HRIS_PROFILE_IDENTIFIER`

Retrieve termination details by HRIS profile identifier. Calls Deel's documented GET /offboarding/tracker/hris_profile/{oid} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `oid` | string | Yes | Unique hris profile oid |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get time-off attachment download URL

**Slug:** `DEEL_GET_TIME_OFF_ATTACHMENT_DOWNLOAD_URL`

Get time-off attachment download URL. Calls Deel's documented GET /time_offs/attachments/{attachment_id}/download Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachment_id` | string | Yes | Time-off attachment id (the id field from the attachments array in time-off responses) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Work Schedule and Holidays

**Slug:** `DEEL_GET_TIME_OFF_DAILIES`

Get Work Schedule and Holidays. Calls Deel's documented GET /time_offs/dailies Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | No | End date of non working days date range |
| `countries` | array | No | List of countries to be fetched |
| `start_date` | string | No | Start date of non working days date range |
| `hris_profile_ids` | array | No | HRIS profile ids |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Profile Entitlements

**Slug:** `DEEL_GET_TIME_OFF_ENTITLEMENTS`

Get Profile Entitlements. Calls Deel's documented GET /time_offs/profile/{hris_profile_id}/entitlements Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hris_profile_id` | string | Yes | HRIS profile ID |
| `policy_type_name` | string | No | Policy type name |
| `tracking_period_date` | string | No | Tracking period date |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Time Off Events for Profile

**Slug:** `DEEL_GET_TIME_OFF_EVENTS`

Get Time Off Events for Profile. Calls Deel's documented GET /time_offs/time-off-events Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `policy_id` | string | No | Policy id |
| `hris_profile_id` | string | Yes | Worker hris profile id |
| `time_off_type_id` | string | Yes | Time off type id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a single timesheet entry

**Slug:** `DEEL_GET_TIMESHEET_ID`

Retrieve a single timesheet entry. Calls Deel's documented GET /timesheets/{timesheet_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `timesheet_id` | string | Yes | ID of an existing timesheet |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Hourly Report Preset by ID

**Slug:** `DEEL_GET_TIMESHEETS_PRESET_ID`

Get Hourly Report Preset by ID. Calls Deel's documented GET /timesheets/presets/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the hourly report preset to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Shift details

**Slug:** `DEEL_GET_TIME_TRACKING_SHIFT_EXTERNAL_ID`

Get Shift details. Calls Deel's documented GET /time_tracking/shifts/{external_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `external_id` | string | Yes | Unique identifier of the shift to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a timesheet

**Slug:** `DEEL_GET_TIME_TRACKING_TIMESHEET_ID`

Retrieve a timesheet. Calls Deel's documented GET /time-tracking/timesheets/{timesheet_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `extend` | string | No | Optional list of fields to extend in the response. Currently only `file_data` is supported, which includes file details (file_id, file_name) and download URL. |
| `timesheet_id` | string | Yes | ID of the timesheet to fetch file for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate timesheet upload url

**Slug:** `DEEL_GET_TIME_TRACKING_TIMESHEETS_UPLOAD_URL`

Initialize a timesheet CSV upload and return its presigned URL and required form fields. This action does not transfer the CSV: POST it separately with every returned field, and do not send Deel Authorization or x-client-id headers to storage. Calls Deel's documented POST /time-tracking/timesheets/upload-url Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a Single User

**Slug:** `DEEL_GET_USER_ID`

Retrieve one user from Deel's SCIM HRIS directory by HRIS profile OID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hris_profile_id` | string | Yes | Unique OID of the HRIS profile to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Immigration visa types

**Slug:** `DEEL_GET_VISA_TYPES`

Immigration visa types. Calls Deel's documented GET /immigration/visa-types/{country_code} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country_code` | string | Yes | Alpha 2 country code |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a single webhook

**Slug:** `DEEL_GET_WEBHOOK`

Retrieve a single webhook. Calls Deel's documented GET /webhooks/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the webhook subscription. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get worker additional fields for (EOR)

**Slug:** `DEEL_GET_WORKER_ADDITIONAL_FIELDS_EOR`

Get worker additional fields for (EOR). Calls Deel's documented GET /forms/eor/worker-additional-fields/{country_code} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country_code` | string | Yes | Country code |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Worker Relations of a given HrisProfile by external id

**Slug:** `DEEL_GET_WORKER_RELATION_PROFILE_EXTERNAL_ID`

Fetch Worker Relations of a given HrisProfile by external id. Calls Deel's documented GET /hris/worker_relations/profile/external/{profile_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile_id` | string | Yes | HrisProfile external ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add payroll migration files to a legal entity

**Slug:** `DEEL_IMPORT_PAYROLL_MIGRATION_FILES`

Add payroll migration files to a legal entity. Each upload claim token must come from Deel's POST /files response for the matching file_id; it claims only that initialized file. Calls Deel's documented POST /gp/legal-entities/{legal_entity_id}/payroll-migration-imports Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | The payroll migration files to attach to the import. |
| `legal_entity_id` | string | Yes | The unique identifier of the legal entity the payroll migration files belong to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Adjustment Categories

**Slug:** `DEEL_LIST_ADJUSTMENT_CATEGORIES`

List payroll adjustment categories for selected contract types, defaulting to EOR when contract_types is omitted. Requires an Organization OAuth connection with adjustments:read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_types` | array | No | Contract types whose adjustment categories should be returned; defaults to EOR when omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List feedbacks for an application

**Slug:** `DEEL_LIST_APPLICATION_FEEDBACKS`

List feedbacks for an application. Calls Deel's documented GET /ats/applications/{application_id}/feedbacks Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of feedbacks to return per page. |
| `cursor` | string | No | Pagination cursor returned by a previous response. |
| `status` | string ("SUBMITTED" | "NOT_SUBMITTED" | "DISMISSED" | "REVOKED") | No | Filter feedbacks by submission status. |
| `application_id` | string | Yes | Unique identifier of the application to retrieve feedbacks for. |
| `should_hide_sensitive_fields` | boolean | No | When true, form responses marked as sensitive are omitted from the response. Defaults to true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List ATS Applications

**Slug:** `DEEL_LIST_ATS_APPLICATIONS`

List one page of ATS applications with candidate, job, stage, source, tag, criteria, and update filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum applications to return. |
| `cursor` | string | No | Continuation cursor from the previous page. |
| `job_id` | string | No | Job identifier to include. |
| `include` | array | No | Optional response expansions. |
| `sort_by` | string ("APPLICATION_CREATION_DATE" | "STAGE_CREATION_DATE") | No | Field by which to sort applications. |
| `sort_order` | string ("ASC" | "DESC") | No | Application sort order. |
| `search_text` | string | No | Search text for filtering applications. |
| `source_slugs` | array | No | Application source slugs to include. |
| `updated_after` | string | No | Return applications updated after this time. |
| `candidate_tag_ids` | array | No | Candidate tag identifiers to include. |
| `archivation_reason_ids` | array | No | Archivation reason identifiers to include. |
| `job_criterias_matchings` | array | No | Typed job criteria matching filters. Deel receives these as one JSON-encoded query value. |
| `interview_plan_stage_ids` | array | No | Current interview plan stage identifiers to include. |
| `candidate_tag_ids_operator` | string ("ANY" | "ALL") | No | Whether any or all candidate tags must match. |
| `moved_to_current_stage_before` | string | No | Return applications moved to their current stage before this time. |
| `current_stage_default_type_slugs` | array | No | Current default stage slugs to include. |
| `reached_interview_plan_stage_ids` | array | No | Interview plan stage identifiers ever reached. |
| `current_stage_category_type_slugs` | array | No | Current stage category slugs to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List ATS Application Sources

**Slug:** `DEEL_LIST_ATS_APPLICATION_SOURCES`

List one page of active ATS application sources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum application sources to return. |
| `cursor` | string | No | Continuation cursor from the previous page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List ATS Attachment Files

**Slug:** `DEEL_LIST_ATS_ATTACHMENT_FILES`

List one page of attachment metadata for an ATS entity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum attachments to return. |
| `cursor` | string | No | Continuation cursor from the previous page. |
| `attachable_id` | string | Yes | Entity that owns the attachment. |
| `attachable_type_slug` | string ("CANDIDATE" | "CAREER_PAGE_SETTING" | "JOB_POSTING" | "NOTE" | "OFFER" | "SENT_CANDIDATE_EMAIL" | "EMAIL_MESSAGE" | "TEMPORARY" | "EMAIL_TEMPLATE" | "JOB_ACTIVITY") | Yes | Type of entity that owns the attachment. |
| `attachment_type_slug` | string ("CV" | "LOGO" | "OFFER_LETTER" | "OTHER") | Yes | Attachment type to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List ATS Candidates

**Slug:** `DEEL_LIST_ATS_CANDIDATES`

List one page of ATS candidates with job, department, tag, stage, and update filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum candidates to return. |
| `cursor` | string | No | Continuation cursor from the previous page. |
| `search` | string | No | Search text for filtering candidates. |
| `job_ids` | array | No | Job identifiers to include. |
| `tag_ids` | array | No | Tag identifiers to include. |
| `updated_after` | string | No | Return candidates updated after this timestamp. |
| `department_ids` | array | No | Department identifiers to include. |
| `current_stage_default_type_slugs` | array | No | Current default stage slugs to include. |
| `current_stage_category_type_slugs` | array | No | Current stage category slugs to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a list of ATS departments

**Slug:** `DEEL_LIST_ATS_DEPARTMENTS`

Retrieve a list of ATS departments. Calls Deel's documented GET /ats/departments Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records returned in one response |
| `cursor` | string | No | Cursor for pagination to get the next set of results |
| `include_archived` | string | No | If true, archived departments are included in the response; they are excluded by default |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a list of ATS employment types

**Slug:** `DEEL_LIST_ATS_EMPLOYMENT_TYPES`

Retrieve a list of ATS employment types. Calls Deel's documented GET /ats/employment-types Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records returned in one response |
| `cursor` | string | No | The cursor for pagination |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a list of ATS hires

**Slug:** `DEEL_LIST_ATS_HIRES`

Retrieve a list of ATS hires. Calls Deel's documented GET /ats/hires Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records to return per page |
| `cursor` | string | No | Cursor for pagination. Use the next_cursor value from the previous response to get the next page of results. |
| `updated_after` | string | No | Return only records updated strictly after this timestamp (ISO 8601 format). Use it to poll for changes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve ATS hiring members

**Slug:** `DEEL_LIST_ATS_HIRING_MEMBERS`

Retrieve ATS hiring members. Calls Deel's documented GET /ats/hiring-members Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records returned in one response |
| `cursor` | string | No | The cursor for pagination |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a list of ATS job boards

**Slug:** `DEEL_LIST_ATS_JOB_BOARDS`

Retrieve a list of ATS job boards. Calls Deel's documented GET /ats/job-boards Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of items to return |
| `cursor` | string | No | Cursor for pagination |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve ATS job postings

**Slug:** `DEEL_LIST_ATS_JOB_POSTINGS`

Retrieve ATS job postings. Calls Deel's documented GET /ats/job-postings Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of job postings to return per page (min: 1, max: 100). |
| `cursor` | string | No | Opaque cursor for pagination. Use the value from next_cursor of the previous response to fetch the next page. |
| `job_id` | string | No | When set, only postings for this job are returned (UUID). |
| `job_board_id` | string | No | Job board to list postings from (UUID). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a list of ATS jobs

**Slug:** `DEEL_LIST_ATS_JOBS`

Retrieve a list of ATS jobs. Calls Deel's documented GET /ats/jobs Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records returned in one response |
| `cursor` | string | No | The cursor for pagination |
| `search` | string | No | Text to search for in job records (optional) |
| `status` | array | No | Array of job status values (optional) |
| `job_ids` | array | No | Array of job UUIDs (optional). Returns only these jobs, so a caller holding job ids from another endpoint can resolve them in one request instead of paging the whole list. Omitting it leaves the result set unchanged. |
| `team_ids` | array | No | Array of team UUIDs (optional) |
| `location_ids` | array | No | Array of location UUIDs (optional) |
| `updated_after` | string | No | Filter jobs updated after this timestamp (ISO 8601 format) |
| `department_ids` | array | No | Array of department UUIDs (optional) |
| `interview_plan_id` | string | No | Interview plan UUID (optional) |
| `work_arrangements` | array | No | Array of work arrangement values to filter by (optional) |
| `employment_type_ids` | array | No | Array of employment type UUIDs (optional) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a list of ATS locations

**Slug:** `DEEL_LIST_ATS_LOCATIONS`

Retrieve a list of ATS locations. Calls Deel's documented GET /ats/locations Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records returned in one response |
| `cursor` | string | No | The cursor for pagination |
| `include_archived` | string | No | If true, archived locations are included in the response; they are excluded by default |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List ATS Offers

**Slug:** `DEEL_LIST_ATS_OFFERS`

List ATS offers filtered by application, jobs, or offer statuses.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_ids` | array | No | Job identifiers to include. |
| `offer_status` | array | No | Offer statuses to include. |
| `application_id` | string | No | Application identifier to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve paginated list of ATS Rejection/Archivation reasons

**Slug:** `DEEL_LIST_ATS_REJECTION_ARCHIVATION_REASONS`

Retrieve paginated list of ATS Rejection/Archivation reasons. Calls Deel's documented GET /ats/reasons Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records returned in one response |
| `cursor` | string | No | The cursor for pagination |
| `search` | string | No | Search text for filtering reasons |
| `subgroup_slug` | string ("INTEREST" | "LOCATION" | "COMPENSATION" | "RESPONSIVENESS" | "QUALIFICATION" | "FIT" | "EXPERIENCE" | "STATUS" | "ROLE_CHANGE" | "WITHDREW" | "BENEFITS" | "COUNTER_OFFER" | "REMOTE_WORK" | "PERSONAL" | "TIMING" | "BUDGET" | "BUSINESS_NEEDS" | "EXTERNAL_CANDIDATE" | "INTERNAL_TRANSFER" | "HIRING_FREEZE") | No | Filter by reason subgroup |
| `include_counts` | string | No | If true, includes usage counts for each reason |
| `include_archived` | string | No | If true, archived reasons are included in the response; they are excluded by default |
| `reason_group_slug` | string ("CANDIDATE_ARCHIVATION" | "OFFER_REJECTION" | "JOB_CLOSURE" | "INTERVIEW_CANCELLATION") | Yes | Filter by reason group |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a list of ATS teams

**Slug:** `DEEL_LIST_ATS_TEAMS`

Retrieve a list of ATS teams. Calls Deel's documented GET /ats/teams Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records returned in one response |
| `cursor` | string | No | The cursor for pagination |
| `include_archived` | string | No | If true, archived teams are included in the response; they are excluded by default |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List case invoices

**Slug:** `DEEL_LIST_CASE_INVOICES`

List case invoices. Calls Deel's documented GET /immigration/invoices Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of invoices to return. Capped at 100. |
| `cursor` | string | No | Opaque pagination cursor returned as next_cursor from a previous response. Omit to fetch the first page. |
| `case_id` | string | Yes | The unique identifier of the case whose invoices should be listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List case notes

**Slug:** `DEEL_LIST_CASE_NOTES`

List case notes. Calls Deel's documented GET /immigration/notes Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of notes to return. Capped at 100. |
| `cursor` | string | No | Opaque pagination cursor returned as next_cursor from a previous response. Omit to fetch the first page. |
| `case_id` | string | Yes | The unique identifier of the case whose notes should be listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List case visa application quotes

**Slug:** `DEEL_LIST_CASE_VISA_APPLICATION_QUOTES`

List case visa application quotes. Calls Deel's documented GET /immigration/visa-application-quotes Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `case_id` | string | Yes | The unique identifier of the eligibility check case. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List clearance requests

**Slug:** `DEEL_LIST_CLEARANCE_REQUESTS`

List clearance requests. Calls Deel's documented GET /it/clearance-requests Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Return a page of results with given number of records |
| `cursor` | string | No | Indicates where the next page of results starts, as returned in a paginated list response |
| `status` | string ("CANCELLED" | "COMPLETED" | "DECIDED" | "PENDING_DECISION" | "PENDING_QUOTE" | "PENDING_RETURN") | No | Filter clearance requests by their status. Repeat the key to filter on multiple values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List of immigration cases

**Slug:** `DEEL_LIST_CLIENT_CASES`

List of immigration cases. Calls Deel's documented GET /immigration/client/cases Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results to return |
| `cursor` | string | No | Pagination cursor for fetching next set of results |
| `search` | string | No | Search by applicant name or code |
| `statuses` | array | No | Filter by case status |
| `countries` | array | No | Filter by country. Uses ISO 3166-1 alpha-2 codes (https://www.iban.com/country-codes). |
| `case_type_ids` | array | No | Filter by case type IDs |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve adjustments

**Slug:** `DEEL_LIST_CONTRACT_ADJUSTMENTS`

Retrieve adjustments. Calls Deel's documented GET /contracts/{contract_id}/adjustments Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | Filter adjustments by end date. |
| `field_from` | string | No | Filter adjustments by start date. |
| `contract_id` | string | Yes | Deel adjustment id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Effective Date Limitations

**Slug:** `DEEL_LIST_CONTRACT_AMENDMENT_EFFECTIVE_DATE_LIMITATIONS`

Retrieve Effective Date Limitations. Calls Deel's documented GET /eor/contracts/{contract_id}/amendments/{amendment_id}/effective-date-limitations Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of the EOR worker contract |
| `amendment_id` | string | Yes | A unique identifier for the employee contract amendment |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List all custom fields

**Slug:** `DEEL_LIST_CONTRACT_CUSTOM_FIELD_DEFINITIONS`

List all custom fields. Calls Deel's documented GET /contracts/custom_fields Organization OAuth candidate operation.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve custom fields for a contract

**Slug:** `DEEL_LIST_CONTRACT_CUSTOM_FIELD_VALUES`

Retrieve custom fields for a contract. Calls Deel's documented GET /contracts/{contract_id}/custom_fields Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | Contract Id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Invoice line items by contract

**Slug:** `DEEL_LIST_CONTRACT_INVOICE_ADJUSTMENTS`

List a contract's invoice adjustments, optionally filtered by contract type, adjustment type, status, invoice, reporter, or submission date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings |
| `types` | array | No | types of invoice adjustments to filter |
| `cursor` | string | No | Opaque cursor returned by a previous call. |
| `offset` | string | No | Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings |
| `date_to` | string | No | To get invoice adjustments submitted before given end date (excludes records submitted on this date). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. |
| `statuses` | array | No | statuses of invoice adjustment to filter |
| `date_from` | string | No | To get invoice adjustments submitted on or after given start date (inclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. |
| `invoice_id` | string | No | ID of an existing invoice |
| `contract_id` | string | Yes | Deel contract id. |
| `reporter_id` | string | No | ID of an existing profile |
| `contract_types` | array | No | types of contracts to filter |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Milestones by Contract

**Slug:** `DEEL_LIST_CONTRACT_MILESTONES`

Retrieve Milestones by Contract. Calls Deel's documented GET /contracts/{contract_id}/milestones Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of the Deel contract for which milestones are being retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Offboarding Request

**Slug:** `DEEL_LIST_CONTRACT_OFFBOARDING`

Retrieve Offboarding Request. Calls Deel's documented GET /eor/contracts/{contract_id}/offboarding Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of the employee contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve restricted offboarding dates

**Slug:** `DEEL_LIST_CONTRACT_OFFBOARDING_RESTRICTED_DATES`

Retrieve restricted offboarding dates. Calls Deel's documented GET /eor/contracts/{contract_id}/offboarding/restricted-dates Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of the employee contract. |
| `termination_type` | string ("TERMINATION" | "RESIGNATION") | Yes | Type of offboarding. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Employee Time Off Data for Offboarding

**Slug:** `DEEL_LIST_CONTRACT_OFFBOARDING_TIME_OFFS`

Retrieve Employee Time Off Data for Offboarding. Calls Deel's documented GET /eor/contracts/{contract_id}/offboarding/time-offs Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | No | Desired end date for offboarding |
| `contract_id` | string | Yes | The unique identifier of the employee contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List of off-cycle payments

**Slug:** `DEEL_LIST_CONTRACT_OFF_CYCLE_PAYMENTS`

List of off-cycle payments. Calls Deel's documented GET /contracts/{contract_id}/off-cycle-payments Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier (ID) of the Deel contract for which to retrieve off-cycle payments. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List contract amendments

**Slug:** `DEEL_LIST_CONTRACTOR_CONTRACT_AMENDMENTS`

List independent-contractor (IC) contract work-statement amendments, optionally filtered by amendment status or signing status; for EOR contract amendments use DEEL_LIST_EOR_CONTRACT_AMENDMENTS.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of work statements to return. |
| `cursor` | string | No | Cursor for pagination. |
| `statuses` | array | No | Filter by work statement status. |
| `contract_id` | string | Yes | Unique identifier of the contract |
| `sign_statuses` | array | No | Filter by work statement sign status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve contractor payment dates

**Slug:** `DEEL_LIST_CONTRACT_PAYMENT_CYCLES`

Retrieve contractor payment dates. Calls Deel's documented GET /contracts/{contract_id}/payment_cycles Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The Deel contract ID for which payment dates are being retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contracts

**Slug:** `DEEL_LIST_CONTRACTS`

List organization contract summaries with filters and a continuation cursor. Requires an Organization OAuth connection with contracts:read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum contracts to return in this page. |
| `types` | array | No | Contract types to include. |
| `expand` | array | No | Additional contract fields to include; sent as repeated query values. |
| `search` | string | No | Match a contract name or contractor name. |
| `sort_by` | string ("contract_title" | "worker_name") | No | Field used to sort contracts. |
| `team_id` | array | No | Return contracts assigned to any of these Deel team IDs. |
| `statuses` | array | No | Contract workflow statuses to include. |
| `countries` | array | No | Two-letter uppercase country codes to include. |
| `currencies` | array | No | Three-letter uppercase currency codes to include. |
| `external_id` | string | No | Return contracts with this external identifier. |
| `after_cursor` | string | No | Continuation cursor returned by the previous call. |
| `legal_entity_id` | array | No | Return contracts assigned to any of these legal entity IDs. |
| `order_direction` | string ("asc" | "desc") | No | Sort in ascending or descending order. |
| `external_id_absent` | string | No | Filter by external ID presence using the provider's string boolean value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List of tasks

**Slug:** `DEEL_LIST_CONTRACT_TASKS`

List of tasks. Calls Deel's documented GET /contracts/{contract_id}/tasks Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier for the Deel contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve contract templates

**Slug:** `DEEL_LIST_CONTRACT_TEMPLATES`

Retrieve contract templates. Calls Deel's documented GET /contract-templates Organization OAuth candidate operation.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List contract termination reasons

**Slug:** `DEEL_LIST_CONTRACT_TERMINATION_REASONS`

List contract termination reasons. Calls Deel's documented GET /contracts/termination-reasons Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of items to return per page (default: 20, max: 100) |
| `cursor` | string | No | Cursor for pagination. Use the value from `next_cursor` in the previous response to fetch the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Hourly Report Presets

**Slug:** `DEEL_LIST_CONTRACT_TIMESHEET_PRESETS`

List a contract's hourly timesheet presets, including each preset's rate, attached file, and root-preset definition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page |
| `cursor` | string | No | Pagination cursor for fetching next set of results |
| `order_by` | string ("title" | "created_at") | No | Field to order results by (title or created_at) |
| `contract_id` | string | Yes | ID of the Deel contract |
| `order_direction` | string ("ASC" | "DESC") | No | Direction of ordering (ASC or DESC) |
| `work_statement_id` | string | No | ID of the work statement (optional) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List of timesheets by contract

**Slug:** `DEEL_LIST_CONTRACT_TIMESHEETS`

List of timesheets by contract. Calls Deel's documented GET /contracts/{contract_id}/timesheets Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Maximum number of records to return per page. NOTE: query parameters are passed as strings. |
| `cursor` | string | No | Opaque cursor returned by a previous call. |
| `offset` | string | No | Number of records to skip before starting to return results. NOTE: query parameters are passed as strings. |
| `date_to` | string | No | Filter results to timesheets submitted before this date (exclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. |
| `statuses` | array | No | Filter results to timesheets with the specified statuses. |
| `date_from` | string | No | Filter results to timesheets submitted on or after this date (inclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. |
| `contract_id` | string | Yes | Deel contract id. |
| `reporter_id` | string | No | Filter results to timesheets submitted by this user ID. |
| `contract_types` | array | No | Filter results to timesheets associated with the specified contract types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Supported Countries

**Slug:** `DEEL_LIST_COUNTRIES`

List countries supported by Deel with EOR, visa, currency, and sub-territory details.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Supported Currencies

**Slug:** `DEEL_LIST_CURRENCIES`

List currencies supported by Deel, including ISO codes and available names.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve current On-Demand Payroll

**Slug:** `DEEL_LIST_CURRENT_ON_DEMAND_PAYROLL`

Retrieve current On-Demand Payroll. Calls Deel's documented GET /on-demand-payroll/contract/{contract_id}/current Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | Public ID (oid) of the contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deel Invoices

**Slug:** `DEEL_LIST_DEEL_INVOICES`

Retrieve one page of Deel fee invoices.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Number of invoices to return. |
| `cursor` | string | No | Opaque continuation cursor returned by the previous call. |
| `offset` | string | No | Number of invoices to skip before returning this page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Benefits by Country

**Slug:** `DEEL_LIST_EOR_BENEFITS_BY_COUNTRY`

List EOR benefit options for a country and hiring scenario, filtered by visa need, weekly hours, employment type, team, and legal entity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | The ID of the team the worker belongs to. |
| `work_visa` | boolean | Yes | Indicates if work visa is required. |
| `country_code` | string | Yes | Country code. |
| `employment_type` | string ("Full-time" | "Part-time") | Yes | Type of employment |
| `legal_entity_id` | string | Yes | The ID of the legal entity. |
| `work_hours_per_week` | number | Yes | Working hours per week |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Benefits for EOR Contract

**Slug:** `DEEL_LIST_EOR_BENEFITS_CONTRACT_ID`

Retrieve Benefits for EOR Contract. Calls Deel's documented GET /eor/{contract_id}/benefits Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | Deel contract ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get amendments by contract

**Slug:** `DEEL_LIST_EOR_CONTRACT_AMENDMENTS`

List an EOR contract's amendment history, including statuses, changed values, compensation changes, and legal or rejection context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier of EOR worker contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve EOR Contract Details

**Slug:** `DEEL_LIST_EOR_CONTRACT_DETAILS`

Retrieve EOR Contract Details. Calls Deel's documented GET /eor/contracts/{contract_id}/details Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | The unique identifier for the Deel contract |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch EOR contract documents

**Slug:** `DEEL_LIST_EOR_CONTRACT_DOCUMENTS`

List framework-agreement signature metadata for an EOR contract, including client and EOR signer names and signing timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | EOR contract ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Benefits for Employee

**Slug:** `DEEL_LIST_EOR_WORKER_BENEFITS`

Retrieve Benefits for Employee. Calls Deel's documented GET /eor/worker/benefits Organization OAuth candidate operation.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List EOR Worker Payslips

**Slug:** `DEEL_LIST_EOR_WORKER_PAYSLIPS`

List payslip records for a specified Employer of Record worker.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `worker_id` | string | Yes | Worker whose payslips to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List equity grant expense amortization records

**Slug:** `DEEL_LIST_EQUITY_AMORTIZATIONS`

List equity grant expense amortization records. Calls Deel's documented GET /equity-amortizations Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records to return in this page. |
| `cursor` | string | No | Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page. |
| `grant_date_to` | string | No | Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format. |
| `employee_number` | string | No | Only return records for this exact Shareworks employee number. |
| `grant_date_from` | string | No | Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format. |
| `employee_grant_number` | string | No | Only return records for this exact Shareworks grant number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List equity awards granted

**Slug:** `DEEL_LIST_EQUITY_AWARDS`

List equity awards granted. Calls Deel's documented GET /equity-awards Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records to return in this page. |
| `cursor` | string | No | Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page. |
| `grant_date_to` | string | No | Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format. |
| `employee_number` | string | No | Only return records for this exact Shareworks employee number. |
| `grant_date_from` | string | No | Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List equity grant total expense records

**Slug:** `DEEL_LIST_EQUITY_EXPENSES`

List equity grant total expense records. Calls Deel's documented GET /equity-expenses Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records to return in this page. |
| `cursor` | string | No | Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page. |
| `grant_date_to` | string | No | Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format. |
| `employee_number` | string | No | Only return records for this exact Shareworks employee number. |
| `grant_date_from` | string | No | Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format. |
| `employee_grant_number` | string | No | Only return records for this exact Shareworks grant number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List equity grants with tax events

**Slug:** `DEEL_LIST_EQUITY_GRANTS_WITH_TAX_EVENTS`

List equity grants with tax events. Calls Deel's documented GET /equity-grants Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of grants to return |
| `cursor` | string | No | Opaque continuation cursor returned by the previous page. |
| `offset` | integer | No | Number of grants to skip before starting to return results |
| `search` | string | No | Free-text search across grant/worker name and email |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List equity option ledger entries

**Slug:** `DEEL_LIST_EQUITY_OPTION_LEDGER_ENTRIES`

List equity option ledger entries. Calls Deel's documented GET /equity-option-ledger Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records to return in this page. |
| `cursor` | string | No | Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page. |
| `grant_date_to` | string | No | Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format. |
| `employee_number` | string | No | Only return records for this exact Shareworks employee number. |
| `grant_date_from` | string | No | Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format. |
| `employee_grant_number` | string | No | Only return records for this exact Shareworks grant number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List equity participants

**Slug:** `DEEL_LIST_EQUITY_PARTICIPANTS`

List equity participants. Calls Deel's documented GET /equity-participants Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records to return in this page. |
| `cursor` | string | No | Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page. |
| `employee_number` | string | No | Only return records for this exact Shareworks employee number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Shareworks equity exercises

**Slug:** `DEEL_LIST_EQUITY_SHAREWORKS_EXERCISES`

List Shareworks equity exercises. Calls Deel's documented GET /equity-exercises Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of exercise records to return in this page. |
| `cursor` | string | No | Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page. |
| `employee_number` | string | No | Only return exercises for this exact Shareworks employee number. |
| `exercise_date_to` | string | No | Only return exercises with an exercise_date on or before this date (inclusive), in YYYY-MM-DD format. |
| `exercise_date_from` | string | No | Only return exercises with an exercise_date on or after this date (inclusive), in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List equity grant valuations

**Slug:** `DEEL_LIST_EQUITY_VALUATIONS`

List equity grant valuations. Calls Deel's documented GET /equity-valuations Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records to return in this page. |
| `cursor` | string | No | Opaque pagination cursor returned as next_cursor by a previous response. Omit to fetch the first page. |
| `grant_date_to` | string | No | Only return records with a grant_date on or before this date (inclusive), in YYYY-MM-DD format. |
| `grant_date_from` | string | No | Only return records with a grant_date on or after this date (inclusive), in YYYY-MM-DD format. |
| `employee_grant_number` | string | No | Only return records for this exact Shareworks grant number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List interview and evaluation feedback across the organization

**Slug:** `DEEL_LIST_FEEDBACKS`

List interview and evaluation feedback across the organization. Calls Deel's documented GET /ats/feedbacks Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of feedback records per page (1-100; 1-50 with include=FORM_RESPONSES). |
| `cursor` | string | No | Pagination cursor returned by a previous response. |
| `status` | string ("SUBMITTED" | "NOT_SUBMITTED") | No | SUBMITTED returns completed scorecards; NOT_SUBMITTED returns feedback still owed by a reviewer. |
| `include` | array | No | Optional expansions. FORM_RESPONSES embeds the submitted scorecard answers (caps limit at 50). |
| `job_ids` | array | No | Filter feedback by job IDs. |
| `sort_order` | string ("NEWEST_FIRST" | "OLDEST_FIRST") | No | Order by feedback creation time. |
| `activity_type` | string ("INTERVIEW_SCHEDULING" | "APPLICATION_EVALUATION" | "EXERCISE" | "QUESTIONNAIRE") | No | Filter by the kind of activity the feedback belongs to. |
| `candidate_ids` | array | No | Filter feedback by candidate IDs. |
| `updated_after` | string | No | Return feedback updated strictly after this ISO 8601 datetime (incremental sync). |
| `application_ids` | array | No | Filter feedback by application IDs. |
| `submitted_after` | string | No | Return feedback submitted at or after this ISO 8601 datetime. |
| `submitted_before` | string | No | Return feedback submitted at or before this ISO 8601 datetime. |
| `scheduled_interview_ids` | array | No | Filter feedback by the scheduled interview it was collected for (ids from GET /rest/ats/interviews). |
| `interview_plan_stage_ids` | array | No | Filter feedback by the interview plan stage of the activity it belongs to (stage ids from GET /rest/ats/jobs/{job_id}/interview-plan-stages). |
| `should_hide_sensitive_fields` | boolean | No | When true (default), form responses marked as sensitive are omitted. |
| `reviewer_hris_organization_user_ids` | array | No | Filter feedback by the HRIS organization user IDs of the reviewers (interviewers) who owe or submitted it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve bank accounts

**Slug:** `DEEL_LIST_GP_CONTRACT_BANK_ACCOUNTS`

Retrieve bank accounts. Calls Deel's documented GET /gp/contracts/{contract_id}/banks Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | Unique identifier for a contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve bank guide

**Slug:** `DEEL_LIST_GP_CONTRACT_BANK_GUIDE`

Retrieve bank guide. Calls Deel's documented GET /gp/contracts/{contract_id}/banks/guide Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | Unique identifier for a contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List payroll events by legal entity

**Slug:** `DEEL_LIST_GP_LEGAL_ENTITY_REPORTS`

List payroll events by legal entity. Calls Deel's documented GET /gp/legal-entities/{legal_entity_id}/reports Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `legal_entity_id` | string | Yes | Unique identifier for the legal entity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List gross-to-net report.

**Slug:** `DEEL_LIST_GP_REPORT_GROSS_NET`

List gross-to-net report.. Calls Deel's documented GET /gp/reports/{id}/gross_to_net Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id of the gp payroll report. |
| `limit` | integer | No | Maximum number of records to return. |
| `cursor` | string | No | Opaque continuation cursor returned by the previous call. Omit it for the first page. |
| `offset` | integer | No | Offset/index of record for the next page of records to return. |
| `currency` | string | No | Currency to be used in the report calculation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve additional information fields for GP workers by country

**Slug:** `DEEL_LIST_GP_WORKER_ADDITIONAL_INFO_FIELDS_BY_COUNTRY`

List country-specific additional-information fields that a Global Payroll worker must provide, including requiredness, validation, dependencies, and UI guidance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country_code` | string | Yes | ISO 3166-1 alpha-2 country code for which to retrieve GP worker additional fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve bank guide

**Slug:** `DEEL_LIST_GP_WORKER_BANK_GUIDE`

Retrieve bank guide. Calls Deel's documented GET /gp/workers/{worker_id}/banks/guide Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `worker_id` | string | Yes | Unique identifier for a worker in UUID format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve bank accounts

**Slug:** `DEEL_LIST_GP_WORKER_BANKS`

Retrieve bank accounts. Calls Deel's documented GET /gp/workers/{worker_id}/banks Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `worker_id` | string | Yes | Unique identifier for a worker. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve the Global Payroll worker creation schema

**Slug:** `DEEL_LIST_GP_WORKER_CREATION_SCHEMA`

Retrieve the Global Payroll worker creation schema. Calls Deel's documented GET /gp/workers/creation-schema Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | No | ISO 3166-1 alpha-2 country of the legal entity. Adds the country rules. Must match the legal entity when legal_entity_id is also given. |
| `legal_entity_id` | string | No | Legal entity of your organization. Its country is used and the currencies it may pay in are returned. |
| `payroll_group_id` | string | No | Payroll group of the legal entity. When it is a Payroll Connect (Soft GP) group, employee_number is reported as required. Requires legal_entity_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve employee payslips

**Slug:** `DEEL_LIST_GP_WORKER_PAYSLIPS`

Retrieve employee payslips. Calls Deel's documented GET /gp/workers/{id}/payslips Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier for the worker. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Return list of groups

**Slug:** `DEEL_LIST_GROUPS`

Return list of groups. Calls Deel's documented GET /groups Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | The maximum number of groups to return (between 1 and 100) |
| `cursor` | string | No | The encoded cursor for paginated results. This is an opaque string that allows fetching the next set of results. |
| `sort_order` | string ("ASC" | "DESC") | No | Sort the results in ascending (ASC) or descending (DESC) order based on the group name. |
| `external_metadata` | string | No | Extra information about the group. |
| `include_archived_groups` | boolean | No | Include archived groups (soft deleted records). Defaults to `true`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Hourly Report Root Presets

**Slug:** `DEEL_LIST_HOURLY_REPORT_ROOT_PRESETS`

List hourly-report root templates, including rate or tracking type, attached files, and contract and derived-preset usage counts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of items to return per page (max: 100) |
| `cursor` | string | No | Pagination cursor for fetching the next page of results |
| `order_direction` | string ("ASC" | "DESC") | No | Direction to order the results (ascending or descending) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve HRIS worker bank accounts

**Slug:** `DEEL_LIST_HRIS_BANK_ACCOUNTS`

Retrieve HRIS worker bank accounts. Calls Deel's documented GET /hris/workers/{worker_id}/banks Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `worker_id` | string | Yes | Unique identifier for an HRIS worker. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve HRX documents

**Slug:** `DEEL_LIST_HRX_DOCUMENTS`

Retrieve HRX documents. Calls Deel's documented GET /eor/contracts/{contract_id}/hrx-documents Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of items to return per page. Maximum is 100, default is 20. |
| `cursor` | string | No | Cursor for pagination. Use the cursor from the previous response to get the next page of results. |
| `contract_id` | string | Yes | The unique identifier of the employee contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get IC invoicing taxes

**Slug:** `DEEL_LIST_IC_INVOICING_TAXES`

Get the VAT and withholding-tax percentages applicable to an independent-contractor contract's invoices.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | Deel Contract ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Industry Subcategories

**Slug:** `DEEL_LIST_INDUSTRIES`

List one page of industry subcategories. Calls Deel's documented GET /industries Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of items to return per page. |
| `order` | string ("ASC" | "DESC") | No | Sorting order of the results. |
| `cursor` | string | No | Cursor used for paginating to the next page of results. |
| `sort_by` | string ("subcategoryName" | "categoryName") | No | Field used to sort the results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List interviews

**Slug:** `DEEL_LIST_INTERVIEWS`

List interviews. Calls Deel's documented GET /ats/interviews Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of interviews to return per page. |
| `cursor` | string | No | Pagination cursor returned by a previous response. |
| `status` | array | No | Filter interviews by status. |
| `job_ids` | array | No | Filter interviews by job IDs. |
| `sort_order` | string ("SCHEDULED_FIRST" | "NEWEST_FIRST" | "OLDEST_FIRST" | "LATEST_MEETING_FIRST") | No | Order interviews by upcoming-first, newest-first (by creation), oldest-first, or latest-meeting-first (most recent meeting time, for past-interview views). |
| `candidate_ids` | array | No | Filter interviews by candidate IDs. |
| `updated_after` | string | No | Return interviews updated strictly after this ISO 8601 datetime (incremental sync). |
| `date_range_end` | string | No | Upper bound of interview start time (ISO 8601). |
| `application_ids` | array | No | Filter interviews by application IDs. When set, every interview of those applications is returned — past, cancelled and on stages the candidate has already moved past — and results default to latest meeting first. |
| `date_range_start` | string | No | Lower bound of interview start time (ISO 8601). |
| `interviewer_hou_ids` | array | No | Filter interviews by interviewer HRIS organization user IDs. |
| `interview_plan_stage_ids` | array | No | Filter interviews by the interview plan stage the interview belongs to (from GET /rest/ats/jobs interview_plan_stages). When set, every interview on those stages is returned regardless of the candidate's current stage, and results default to latest meeting first. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List invoice adjustments

**Slug:** `DEEL_LIST_INVOICE_ADJUSTMENTS`

List invoice adjustments. Calls Deel's documented GET /invoice-adjustments Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of records to return per page. |
| `types` | array | No | types of invoice adjustments to filter |
| `cursor` | string | No | Opaque cursor returned by a previous call. |
| `offset` | integer | No | Zero-based index of the first record to return. |
| `date_to` | string | No | To get invoice adjustments submitted before given end date (excludes records submitted on this date). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. |
| `statuses` | array | No | statuses of invoice adjustment to filter |
| `date_from` | string | No | To get invoice adjustments submitted on or after given start date (inclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31. |
| `invoice_id` | string | No | ID of an existing invoice |
| `contract_id` | string | No | Id of an Deel contract. |
| `reporter_id` | string | No | ID of an existing profile |
| `contract_types` | array | No | types of contracts to filter |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Invoices

**Slug:** `DEEL_LIST_INVOICES`

List one page of organization invoices with status and issue-date filters. Requires an Organization OAuth connection with accounting:read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum invoices to return in this page (1-50). |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `offset` | integer | No | Index of the first invoice to return. |
| `status` | string | No | Pass all to include invoices in every status. |
| `include` | string | No | Pass cor to include invoices from COR workers. |
| `include_cor` | boolean | No | When true, include invoices from COR workers. |
| `issued_to_date` | string | No | Include invoices issued before this date. |
| `issued_from_date` | string | No | Include invoices issued on or after this date. |
| `include_all_statuses` | boolean | No | When true, include invoices in all statuses. When false, Deel returns only paid invoices. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List agreements

**Slug:** `DEEL_LIST_IT_AGREEMENTS`

List agreements. Calls Deel's documented GET /it/agreements Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("MANAGEMENT" | "PURCHASE" | "RENTAL") | No | Filter agreements by type. Repeat the key to filter on multiple values. |
| `limit` | integer | No | Return a page of results with given number of records |
| `cursor` | string | No | Indicates where the next page of results starts, as returned in a paginated list response |
| `status` | string ("ACTIVE" | "CANCELED" | "ENDED" | "PENDING") | No | Filter agreements by status. Repeat the key to filter on multiple values. |
| `hris_profile_id` | string | No | Filter by the HRIS profile id currently holding the agreement. |
| `store_and_reuse_status` | string ("COMPLETED" | "IN_PROGRESS" | "READY") | No | Filter rentals by store-and-reuse status. Repeat the key to filter on multiple values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List IT assets

**Slug:** `DEEL_LIST_IT_ASSETS`

List IT assets. Calls Deel's documented GET /it/assets Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Return a page of results with given number of records |
| `cursor` | string | No | Indicates where the next page of results starts, as returned in a paginated list response |
| `status` | string ("ACTIVE" | "ARCHIVED") | No | Filter assets by their status |
| `category` | string ("ADAPTER" | "CABLE" | "CHAIR" | "CHARGER" | "COMPACT_DESKTOP" | "DESK" | "DESKTOP" | "DESK_RISER" | "DESK_TIDY" | "DOCKING_STATION" | "DONGLE" | "FOOTREST" | "HEADSET" | "KEYBOARD" | "LAPTOP" | "LAPTOP_STAND" | "MICE_TRACKPAD" | "MOBILE_DEVICE" | "MONITOR" | "MONITOR_ARM" | "OTHER" | "PRINTER" | "SHREDDER" | "STANDING_MAT" | "TABLET" | "TASK_LIGHT" | "WEBCAM" | "WELCOME_PACK" | "WIFI_RANGE_EXTENDER") | No | Filter assets by their product category |
| `location` | string ("AT_WAREHOUSE" | "CLEARANCE_WAREHOUSE" | "DEEL_WAREHOUSE" | "ORGANIZATION_WAREHOUSE" | "SUPPLIER" | "WITH_COURIER" | "WITH_USER" | "WRITE_OFF") | No | Filter assets by their location |
| `hris_profile_id` | string | No | Filter assets by assigned worker with given HRIS Profile ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List IT hardware policies

**Slug:** `DEEL_LIST_IT_HARDWARE_POLICIES`

List IT hardware policies. Calls Deel's documented GET /it/policies Organization OAuth candidate operation.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List IT orders

**Slug:** `DEEL_LIST_IT_ORDERS`

List IT orders. Calls Deel's documented GET /it/orders Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Return a page of results with given number of records |
| `cursor` | string | No | Indicates where the next page of results starts, as returned in a paginated list response |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List users assigned to an IT policy

**Slug:** `DEEL_LIST_IT_POLICY_USERS`

List users assigned to an IT policy. Calls Deel's documented GET /it/policies/{policy_id}/users Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Return a page of results with given number of records |
| `cursor` | string | No | Indicates where the next page of results starts, as returned in a paginated list response |
| `policy_id` | string | Yes | IT policy identifier |
| `hris_profile_id` | string | No | Filter by the worker's HRIS Profile ID, to find which policy a specific worker is attached to. Repeat the key to filter on multiple values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List products in the catalog

**Slug:** `DEEL_LIST_IT_PRODUCTS`

List products in the catalog. Calls Deel's documented GET /it/products Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Return a page of results with given number of records |
| `brands` | array | No | Filter by manufacturer — exact and case-insensitive, repeat for OR semantics. Unlike search it does not substring-match. |
| `cursor` | string | No | Indicates where the next page of results starts, as returned in a paginated list response |
| `search` | string | No | Return products whose name or brand contains this text. Case-insensitive, and partial words match, so 'book' finds 'MacBook Pro'. Only the name and brand are searched — not the description or hardware specification. Use brands for an exact manufacturer match. |
| `country` | string | No | ISO 3166 alpha-2 country code. Restricts results to products whose variants ship to this country. |
| `category` | string ("ADAPTER" | "CABLE" | "CHAIR" | "CHARGER" | "COMPACT_DESKTOP" | "DESK" | "DESKTOP" | "DESK_RISER" | "DESK_TIDY" | "DOCKING_STATION" | "DONGLE" | "FOOTREST" | "HEADSET" | "KEYBOARD" | "LAPTOP" | "LAPTOP_STAND" | "MICE_TRACKPAD" | "MOBILE_DEVICE" | "MONITOR" | "MONITOR_ARM" | "OTHER" | "PRINTER" | "SHREDDER" | "STANDING_MAT" | "TABLET" | "TASK_LIGHT" | "WEBCAM" | "WELCOME_PACK" | "WIFI_RANGE_EXTENDER") | No | Filter by product category |
| `it_policy_ids` | array | No | Restrict results to products approved by any of these IT policies, to see what workers on those policies can order. Repeat for OR semantics. A policy id your organization does not own matches nothing. |
| `is_marketplace` | boolean | No | Filter by marketplace sourcing. Organizations without marketplace access never see marketplace products, and the filter is ignored for them rather than emptying the catalog. |
| `stock_condition` | string ("NEW" | "REFURBISHED") | No | Filter by stock condition. Omit to include products of any stock condition. |
| `keyboard_layouts` | array | No | Filter by keyboard layout — repeat for OR semantics |
| `acquisition_types` | array | No | Restrict results to products offering at least one of these acquisition types (RENTAL, PURCHASE, REUSE). REUSE represents BYOD (customer-owned) stock. Omit to include all acquisition types the organization is entitled to. |
| `operating_systems` | array | No | Filter by operating system — repeat for OR semantics |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve the IT seat subscription

**Slug:** `DEEL_LIST_IT_SEAT_CONTRACT`

Retrieve the IT seat subscription. Calls Deel's documented GET /it/seats/status Organization OAuth candidate operation.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List IT seats

**Slug:** `DEEL_LIST_IT_SEATS`

List IT seats. Calls Deel's documented GET /it/seats Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Return a page of results with given number of records |
| `cursor` | string | No | Indicates where the next page of results starts, as returned in a paginated list response |
| `status` | array | No | Filter seats by their status — repeat the key for OR semantics. Omit to include seats of any status. |
| `hris_profile_id` | array | No | Filter seats by the HRIS profile holding them — repeat the key for OR semantics. Ids not found in your organization match nothing. Omit to include seats of any worker. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List warehouses

**Slug:** `DEEL_LIST_IT_WAREHOUSES`

List warehouses. Calls Deel's documented GET /it/warehouses Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("OFFICE" | "RESIDENCE" | "WAREHOUSE") | No | Filter by organization warehouse type. Repeat the key to filter on multiple values. |
| `limit` | integer | No | Return a page of results with given number of records |
| `cursor` | string | No | Indicates where the next page of results starts, as returned in a paginated list response |
| `search` | string | No | Free-text search on warehouse name |
| `country` | string | No | Filter by warehouse country (ISO 3166 alpha-2). Repeat the key to filter on multiple values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a list of ATS job postings

**Slug:** `DEEL_LIST_JOB_BOARD_POSTINGS`

Retrieve a list of ATS job postings. Calls Deel's documented GET /ats/job-boards/{job_board_id}/job-postings Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records returned in one response (optional) |
| `cursor` | string | No | The cursor for pagination (optional) |
| `job_board_id` | string | Yes | Job Board ID must be a valid UUID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List interview plan stages of a job with pipeline counts

**Slug:** `DEEL_LIST_JOB_INTERVIEW_PLAN_STAGES`

List interview plan stages of a job with pipeline counts. Calls Deel's documented GET /ats/jobs/{job_id}/interview-plan-stages Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Job whose interview plan stages to list. |
| `include` | array | No | Optional expansions. CURRENT_APPLICATIONS embeds the most recently moved applications currently sitting in each stage. |
| `applications_per_stage_limit` | integer | No | Maximum number of current applications embedded per stage when include=CURRENT_APPLICATIONS (1-25). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List of job scope templates for EOR contracts

**Slug:** `DEEL_LIST_JOB_SCOPES`

List of job scope templates for EOR contracts. Calls Deel's documented GET /eor/job-scopes Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team` | string | No | Team public id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Job Titles

**Slug:** `DEEL_LIST_JOB_TITLES`

List Deel's predefined job titles one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after_cursor` | string | No | Cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List of legal entities

**Slug:** `DEEL_LIST_LEGAL_ENTITIES`

List of legal entities. Calls Deel's documented GET /legal-entities Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | No | Filter by entity type. |
| `limit` | integer | No | The number of results to return per page. |
| `cursor` | string | No | Cursor for pagination. |
| `country` | string | No | Filter by country. |
| `sort_order` | string ("ASC" | "DESC") | No | Sorting order of the results. |
| `global_payroll` | boolean | No | Filter by global payroll flag. |
| `legal_entity_id` | string | No | Filter by specific legal entity ID. |
| `include_archived` | boolean | No | Whether to include archived legal entities in the results. |
| `include_payroll_settings` | boolean | No | Whether to include payroll settings in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve the KYB state of a legal entity

**Slug:** `DEEL_LIST_LEGAL_ENTITY_KYB_STATE`

Retrieve the KYB state of a legal entity. Calls Deel's documented GET /legal-entities/{legal_entity_id}/kyb Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `legal_entity_id` | string | Yes | Public id of the legal entity. The entity must belong to the authenticated organization; any other id answers 404. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Legal Entity Registration Documents

**Slug:** `DEEL_LIST_LEGAL_ENTITY_REGISTRATION_DOCUMENTS`

List Legal Entity Registration Documents. Calls Deel's documented GET /legal-entities/{legal_entity_id}/registration-documents Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return per page. |
| `cursor` | string | No | Pagination cursor returned as `next_cursor` by the previous response. Omit for the first page. |
| `search` | string | No | Free-text search on the requirement name. |
| `status` | array | No | Filter by submission status. Repeat the parameter to pass several values. |
| `product_type` | array | No | Filter by the product the requirement applies to. Repeat the parameter to pass several values. |
| `only_archived` | boolean | No | Return superseded submissions instead of the current ones. |
| `requirement_id` | array | No | Filter to specific requirements. Repeat the parameter to pass several values. |
| `legal_entity_id` | string | Yes | Public UUID of the legal entity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List SIC numbers, entity types, or countries

**Slug:** `DEEL_LIST_LOOKUPS`

Retrieve SIC numbers, entity types, or countries. For currency tasks, use DEEL_LIST_CURRENCIES. Calls Deel's documented GET /lookups Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lookup_type` | string ("sicNumbers" | "entityTypes" | "countries") | Yes | The lookup category to retrieve: `sicNumbers`, `entityTypes`, or `countries`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve List of Managers

**Slug:** `DEEL_LIST_MANAGERS`

Retrieve List of Managers. Calls Deel's documented GET /managers Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | The number of records to return in the response. |
| `cursor` | string | No | Opaque cursor returned by a previous call. |
| `offset` | integer | No | The offset or starting point for pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve offboarding list

**Slug:** `DEEL_LIST_OFFBOARDING_LIST`

Retrieve offboarding list. Calls Deel's documented GET /offboarding/tracker Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per page (maximum 100; values above this are silently clamped to 100) |
| `cursor` | string | No | Continuation cursor returned by the previous call; omit for the first page. |
| `search` | string | No | Search term to filter contracts by name or other attributes |
| `sort_by` | string | No | Field to sort by |
| `pagination` | string | No | Deprecated. Use `cursor` instead. |
| `sort_order` | string | No | Sorting order |
| `hiring_types` | array | No | Filter by hiring type. |
| `include_overview` | boolean | No | Include an overview of the contract |
| `ignore_date_range` | boolean | No | Ignore the default 45-day date range and retrieve all terminations |
| `progress_statuses` | array | No | Filter by offboarding progress status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List onboarding employees

**Slug:** `DEEL_LIST_ONBOARDING_EMPLOYEES`

List onboarding employees. Calls Deel's documented GET /onboarding/tracker Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `card` | string | No | Narrow the list to the workers one filter card counts. `STARTING_THIS_WEEK` also needs `weekFromDate` and `weekToDate`. |
| `limit` | integer | No | Number of results to return per page. Ignored when `cursor` is supplied — a cursor already carries the page size and filters of the request that produced it. |
| `teams` | array | No | Search attribute to filter onboarding list by team |
| `cursor` | string | No | Continuation cursor returned by the previous call; omit for the first page. |
| `search` | string | No | Search term to filter contracts by name or other attributes |
| `actions` | array | No | Filter by whether the onboarding is waiting on an action from the client |
| `sort_by` | string | No | Field to sort by |
| `to_date` | string | No | End date for filtering contracts |
| `countries` | array | No | Filter by contract country. Uses ISO 3166-1 alpha-2 codes. |
| `from_date` | string | No | Start date for filtering contracts |
| `sort_order` | string | No | Sorting order |
| `contract_oid` | array | No | Search attribute to filter onboarding list by contract id |
| `hiring_types` | array | No | Search attribute to filter onboarding list by hiring type |
| `week_to_date` | string | No | Last day of the week the `STARTING_THIS_WEEK` card counts, in the caller's timezone. On or after `weekFromDate` |
| `legal_entities` | array | No | Search attribute to filter onboarding list by legal entity |
| `week_from_date` | string | No | First day of the week the `STARTING_THIS_WEEK` card counts, in the caller's timezone |
| `include_overview` | boolean | No | Include an overview of the contract |
| `progress_statuses` | array | No | Search attribute to filter onboarding list by progress status |
| `lifecycle_statuses` | array | No | Filter by lifecycle status, the same value each item returns in `progress.lifecycle_status` |
| `waiting_on_parties` | array | No | Filter by the party the onboarding is waiting on, the same value each item returns in `progress.waiting_on` |
| `hris_direct_managers` | array | No | Search attribute to filter onboarding list by HRIS direct manager. Expects the manager's HRIS profile ID, as returned by `GET /people` in `employments[].team.direct_manager_id` — not a worker or contract ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List On-Demand Payroll entries

**Slug:** `DEEL_LIST_ON_DEMAND_PAYROLL_ENTRIES`

List On-Demand Payroll entries. Calls Deel's documented GET /on-demand-payroll/contract/{contract_id}/entries Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contract_id` | string | Yes | Public ID (oid) of the contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List job openings

**Slug:** `DEEL_LIST_OPENINGS`

List job openings. Calls Deel's documented GET /ats/openings Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of openings to return per page. |
| `cursor` | string | No | Pagination cursor returned by a previous response. |
| `status` | array | No | Filter openings by one or more statuses. |
| `job_ids` | array | No | Filter openings by linked job IDs. |
| `tag_ids` | array | No | Filter openings by tag IDs. |
| `team_ids` | array | No | Filter openings by team IDs. |
| `location_ids` | array | No | Filter openings by location IDs. |
| `tag_ids_operator` | string ("ANY" | "ALL") | No | Operator for tag_ids filter. 'ANY' returns openings with at least one matching tag; 'ALL' returns openings with all specified tags. Defaults to 'ANY'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Organization Registration Documents

**Slug:** `DEEL_LIST_ORGANIZATION_REGISTRATION_DOCUMENTS`

List Organization Registration Documents. Calls Deel's documented GET /legal-entities/registration-documents Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return per page. |
| `cursor` | string | No | Pagination cursor returned as `next_cursor` by the previous response. Omit for the first page. |
| `search` | string | No | Free-text search on the requirement name. |
| `status` | array | No | Filter by submission status. Repeat the parameter to pass several values. |
| `product_type` | array | No | Filter by the product the requirement applies to. Repeat the parameter to pass several values. |
| `only_archived` | boolean | No | Return superseded submissions instead of the current ones. |
| `requirement_id` | array | No | Filter to specific requirements. Repeat the parameter to pass several values. |
| `legal_entity_id` | array | No | Narrow to specific legal entities. Repeat the parameter to pass several values. Omit for every entity you can access. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Organization Resources

**Slug:** `DEEL_LIST_ORGANIZATION_RESOURCES`

Return the current Deel organization, teams, departments, or working-location labels. Requires an Organization OAuth connection with organizations:read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resource_type` | string ("organization" | "teams" | "departments" | "working_locations") | Yes | Organization reference resource to return: the current organization, teams, departments, or working-location labels. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Organization Secure Vault Folder Items

**Slug:** `DEEL_LIST_ORGANIZATION_SECURE_VAULT_FOLDER_ITEMS`

List Organization Secure Vault Folder Items. Calls Deel's documented GET /organizations/secure-vault/folders/{folder_id}/items Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return per page. |
| `cursor` | string | No | Pagination cursor returned by a previous response. |
| `search` | string | No | Free-text search on folder and file names. |
| `folder_id` | string | Yes | Public UUID of the folder. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization Structures

**Slug:** `DEEL_LIST_ORGANIZATION_STRUCTURES`

Get Organization Structures. Calls Deel's documented GET /hris/organization_structures Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Return a page of results with given number of records. |
| `cursor` | string | No | Continuation offset returned by the previous call; omit for the first page. |
| `offset` | integer | No | Return a page of results with given number of records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List organization tasks

**Slug:** `DEEL_LIST_ORGANIZATION_TASKS`

List organization tasks. Calls Deel's documented GET /organizations/tasks Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records to return (1-100). |
| `cursor` | string | No | Opaque cursor for cursor-based pagination. When provided, use with limit only (do not use offset). |
| `search` | string | No | Search string for task display name or description. |
| `category` | string ("SETUP" | "EXPENSE_REQUESTS" | "EXPENSES_TO_CLARIFY" | "DOCUMENT_ACTIONS" | "LEGAL_ENTITY_DOCUMENTS" | "OTHER_TASKS" | "DEEL_IT" | "COMPLIANCE" | "PAYMENT_METHODS" | "ACCOUNTING" | "APPROVE_CHILD_ORG_CONTRACT_EDIT") | No | Filter by task category. |
| `statuses` | array | No | Filter by task statuses. |
| `external_id` | string | No | Filter by external ID (for tasks created with an external reference). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Payment Breakdown

**Slug:** `DEEL_LIST_PAYMENT_BREAKDOWN`

Retrieve the accounting breakdown for a Deel payment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payment_id` | string | Yes | Payment ID whose breakdown to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Payments

**Slug:** `DEEL_LIST_PAYMENTS`

List one page of organization payment receipts with date, currency, payer entity, and status filters. This action pins Deel API version 2026-01-01, which remains callable but is deprecated and scheduled to sunset on 2027-07-06. Requires an Organization OAuth connection with accounting:read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by the previous call; omit for the first page. |
| `date_to` | string | No | Include payments created before this date. |
| `entities` | array | No | Payer entity types to include. |
| `statuses` | array | No | Payment statuses to include. |
| `date_from` | string | No | Include payments created on or after this date. |
| `currencies` | array | No | Three-letter uppercase currency codes to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List payroll cycles

**Slug:** `DEEL_LIST_PAYROLL_CYCLES`

List payroll cycles. Calls Deel's documented GET /legal-entities/{legal_entity_id}/payroll-events Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of items to return. |
| `cursor` | string | No | Pagination cursor, CUID or UUID format. |
| `date_end` | string | No | End date in the format 'YYYY-MM-DD'. Must not exceed 5 years in the future. |
| `date_start` | string | No | Start date in the format 'YYYY-MM-DD'. Must not be earlier than 5 years ago. |
| `legal_entity_id` | string | Yes | The unique identifier (public ID) for the legal entity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List payroll groups for a legal entity

**Slug:** `DEEL_LIST_PAYROLL_GROUPS`

List payroll groups for a legal entity. Calls Deel's documented GET /payroll-groups Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pagination` | object | No | Cursor-based pagination parameters. limit: max items per page (1-15, default 10). cursor: opaque string from the previous response's pagination.nextCursor field. |
| `calendarYear` | integer | No | Calendar year to filter payroll cycles by. Defaults to the current year. |
| `legalEntityId` | string | Yes | Public UUID of the legal entity whose payroll groups to retrieve. |
| `includePayrollCalendar` | boolean | No | Whether to include REGULAR payroll calendars for each group. Defaults to true. Set to false to skip calendar fetching for a faster response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List payroll migration imports for a legal entity

**Slug:** `DEEL_LIST_PAYROLL_MIGRATION_IMPORTS`

List payroll migration imports for a legal entity. Calls Deel's documented GET /gp/legal-entities/{legal_entity_id}/payroll-migration-imports Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | The maximum number of imports to return, between 1 and 50. Defaults to 20. |
| `cursor` | string | No | An opaque cursor from the previous page's pagination.next_cursor. Omit it for the first page. |
| `legal_entity_id` | string | Yes | The unique identifier of the legal entity whose payroll migration imports to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List People

**Slug:** `DEEL_LIST_PEOPLE`

Search and filter workforce profiles visible to an Organization OAuth connection with people:read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum people to return in this page (1-200). |
| `teams` | array | No | Return people associated with any of these Deel team IDs. |
| `cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `fields` | array | No | Response fields to include; supports the provider's documented field paths. |
| `offset` | integer | No | Index of the first person to return. |
| `search` | string | No | Match a person's name or associated contractor name. |
| `sort_by` | string ("id" | "first_name" | "last_name" | "full_name" | "email" | "country" | "birth_date" | "hiring_type" | "start_date" | "team" | "job_title" | "hiring_status" | "completion_date" | "direct_manager" | "direct_reports_count" | "band_placement" | "comparative_ratio") | No | Field used to sort people. |
| `sort_order` | string ("asc" | "desc") | No | Sort direction. |
| `hiring_types` | array | No | Worker hiring types to include. |
| `band_placements` | array | No | Band placements to include. |
| `hiring_statuses` | array | No | Hiring statuses to include. |
| `person_statuses` | array | No | Lifecycle statuses to include. |
| `comparative_ratios_to` | string | No | Maximum comparative ratio. |
| `comparative_ratios_from` | string | No | Minimum comparative ratio. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List all people custom fields

**Slug:** `DEEL_LIST_PEOPLE_CUSTOM_FIELD_DEFINITIONS`

List the organization's people custom-field definitions, including each field's type, placement, access, applicability, and required/enabled settings.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve custom fields for a worker

**Slug:** `DEEL_LIST_PERSON_CUSTOM_FIELDS`

Retrieve custom fields for a worker. Calls Deel's documented GET /people/{worker_id}/custom_fields Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `worker_id` | string | Yes | Worker id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List policies

**Slug:** `DEEL_LIST_PROFILE_TIME_OFF_POLICIES`

List policies. Calls Deel's documented GET /time_offs/profile/{hris_profile_id}/policies Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `policy_type_id` | string | No | policy type id |
| `hris_profile_id` | string | Yes | hrisProfileId id. |
| `policy_type_name` | string | No | Policy type name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a list of published ATS email templates

**Slug:** `DEEL_LIST_PUBLISHED_ATS_EMAIL_TEMPLATES`

Retrieve a list of published ATS email templates. Calls Deel's documented GET /ats/email-templates Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of email templates to return per page |
| `cursor` | string | No | Cursor for pagination. Use the nextCursor value from the previous response to get the next page of results. |
| `updated_after` | string | No | Return only email templates that were updated after this timestamp (ISO 8601 format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Refund Statement Credit-Note Breakdown

**Slug:** `DEEL_LIST_REFUND_STATEMENT_CREDIT_NOTE_BREAKDOWN`

Retrieve credit notes linked to a Deel refund statement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `refund_statement_id` | string | Yes | Public invoice ID of the refund statement root invoice. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Refund Statements

**Slug:** `DEEL_LIST_REFUND_STATEMENTS`

Retrieve one page of Deel refund statements with date, currency, and entity filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor returned by the previous call. |
| `date_to` | string | No | Include statements created before this date. |
| `entities` | array | No | Legal entity types to include. |
| `date_from` | string | No | Include statements created on or after this date. |
| `currencies` | array | No | Three-letter uppercase currency codes to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List job requests

**Slug:** `DEEL_LIST_REQUISITIONS`

List job requests. Calls Deel's documented GET /vms/requisitions Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records to return. |
| `cursor` | string | No | Opaque cursor returned by the previous page. Omit to retrieve the first page. |
| `search` | string | No | Free-text search over the job request title. |
| `status` | array | No | Filter by job request status. |
| `sort_by` | string ("n_candidates" | "n_positions" | "rate_min" | "rate_max" | "created_at" | "start_date" | "end_date" | "status") | No | Field to sort by. |
| `locations` | array | No | Filter by ISO 3166-1 alpha-2 country codes. |
| `work_mode` | string ("REMOTE" | "OFFICE" | "HYBRID") | No | Filter by work mode. |
| `rate_scale` | string ("HOURLY" | "MILESTONE" | "DAILY" | "WEEKLY" | "MONTHLY" | "ANNUAL") | No | Filter by the rate scale of the job request. |
| `sort_order` | string ("ASC" | "DESC") | No | Sort direction. |
| `vendor_ids` | array | No | Filter by talent partner identifiers. The reserved value `external_provider` matches job requests whose candidates were sourced from an external provider rather than a Deel talent partner. |
| `end_date_to` | string | No | Only return job requests whose end date is on or before this date. Must not be earlier than `end_date_from`. |
| `request_type` | string ("GENERAL" | "PENDING_TASKS") | No | Use `PENDING_TASKS` to return only the job requests awaiting an action from the token owner. |
| `contract_type` | array | No | Filter by contract type. |
| `created_at_to` | string | No | Only return job requests created on or before this date. Must not be earlier than `created_at_from`. |
| `end_date_from` | string | No | Only return job requests whose end date is on or after this date. |
| `start_date_to` | string | No | Only return job requests whose start date is on or before this date. Must not be earlier than `start_date_from`. |
| `approval_status` | array | No | Filter by approval status. |
| `created_at_from` | string | No | Only return job requests created on or after this date. |
| `start_date_from` | string | No | Only return job requests whose start date is on or after this date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Seniority Levels

**Slug:** `DEEL_LIST_SENIORITY_LEVELS`

List Deel's predefined seniority levels, optionally excluding C-level entries for EOR contracts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `is_eor_contract` | boolean | No | Set true to exclude C-level seniorities for EOR contracts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List tags

**Slug:** `DEEL_LIST_TAGS`

List tags. Calls Deel's documented GET /ats/tags Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of tags to return per page (default: 20, max: 100). |
| `cursor` | string | No | Opaque cursor for pagination. Use the value from next_cursor of the previous response to fetch the next page. |
| `search_text` | string | No | Filter tags by label (case-insensitive partial match) |
| `include_counts` | string ("true" | "false") | No | When true, each tag includes candidates_count (number of candidates with that tag) |
| `tag_group_slug` | string | No | Filter by tag group. Use CANDIDATE for candidate tags. |
| `include_archived` | string | No | If true, archived tags are included in the response; they are excluded by default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Time-Off Policies

**Slug:** `DEEL_LIST_TIME_OFF_POLICIES`

List organization time-off policies and resolve policy IDs for auditing or request interpretation. Requires an Organization OAuth connection with time-off:read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Continuation token returned by the previous call; omit for the first page. |
| `country` | array | No | Country codes to include. |
| `page_size` | integer | No | Maximum policies to return in this page (1-50). |
| `policy_name` | string | No | Case-insensitive policy name search. |
| `policy_type` | array | No | Policy type names to include. |
| `state_or_region` | array | No | State or region codes to include. |
| `has_workers_assigned` | boolean | No | Filter by whether a policy has assigned workers. |
| `worker_types_assigned` | array | No | Assigned worker types to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve policy validation templates

**Slug:** `DEEL_LIST_TIME_OFF_POLICY_VALIDATION_TEMPLATES`

Retrieve policy validation templates. Calls Deel's documented GET /time_offs/policy-validation-templates Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `countries` | array | Yes | List of countries (ISO 3166-1 alpha-2 codes) to fetch policy templates and types for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List time-off requests

**Slug:** `DEEL_LIST_TIME_OFF_PROFILE`

List time-off requests. Calls Deel's documented GET /time_offs/profile/{hris_profile_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Continuation token returned by Deel. |
| `status` | array | No | Time off status |
| `end_date` | string | No | End date of time off |
| `page_size` | integer | No | Page size |
| `start_date` | string | No | Start date of time off |
| `policy_types` | array | No | Policy types |
| `time_off_ids` | array | No | Time off ids |
| `hris_profile_id` | string | Yes | HRIS profile id |
| `updated_end_date` | string | No | Updated end date |
| `approval_end_date` | string | No | Approval end date |
| `policy_type_names` | array | No | Filter by policy type names. When omitted, Work Location time-offs are excluded by default. Pass policy_type_names=Work+Location to retrieve only Work Location entries. |
| `updated_start_date` | string | No | Updated start date |
| `approval_start_date` | string | No | Approval start date |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Time-Off Requests

**Slug:** `DEEL_LIST_TIME_OFF_REQUESTS`

List one page of time-off requests across the organization with status, date, policy, and deletion filters. Requires an Organization OAuth connection with time-off:read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next` | string | No | Continuation token returned by the previous call; omit for the first page. |
| `status` | array | No | Time-off statuses to include. |
| `end_date` | string | No | Include requests ending on or before this ISO 8601 timestamp. |
| `page_size` | integer | No | Requested page size (5-200); Deel may return a different effective size. |
| `start_date` | string | No | Include requests starting on or after this ISO 8601 timestamp. |
| `policy_types` | array | No | Policy type IDs to include. |
| `time_off_ids` | array | No | Specific time-off request IDs to return. |
| `updated_end_date` | string | No | Include requests updated on or before this ISO 8601 timestamp. |
| `approval_end_date` | string | No | Include requests approved on or before this ISO 8601 timestamp. |
| `policy_type_names` | array | No | Policy type names to include. Work Location requests are excluded by default unless this filter includes Work Location. |
| `updated_start_date` | string | No | Include requests updated on or after this ISO 8601 timestamp. |
| `approval_start_date` | string | No | Include requests approved on or after this ISO 8601 timestamp. |
| `include_deleted_time_offs` | boolean | No | Include soft-deleted time-off requests. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Time-Off Types

**Slug:** `DEEL_LIST_TIME_OFF_TYPES`

List the predefined time-off types available on Deel.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Timesheets

**Slug:** `DEEL_LIST_TIMESHEETS`

List one page of organization timesheets with contract, status, reporter, and submission-date filters. Requires an Organization OAuth connection with timesheets:read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum timesheets to return in this page. |
| `cursor` | string | No | Continuation cursor returned by a previous call; keep filters unchanged. |
| `offset` | integer | No | Number of timesheets to skip before returning this page. |
| `date_to` | string | No | Include timesheets submitted before this date. |
| `statuses` | array | No | Timesheet statuses to include. |
| `date_from` | string | No | Include timesheets submitted on or after this date. |
| `contract_id` | string | No | Return timesheets for this Deel contract ID. |
| `reporter_id` | string | No | Return timesheets submitted by this Deel reporter ID. |
| `contract_types` | array | No | Contract types to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve a Paginated List of Shift Rates

**Slug:** `DEEL_LIST_TIME_TRACKING_SHIFT_RATES`

Retrieve a Paginated List of Shift Rates. Calls Deel's documented GET /v2/time_tracking/shift_rates Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results |
| `cursor` | string | No | Opaque cursor returned by a previous call. |
| `offset` | integer | No | Offset for pagination |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List of shifts

**Slug:** `DEEL_LIST_TIME_TRACKING_SHIFTS`

List of shifts. Calls Deel's documented GET /v2/time_tracking/shifts Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of results |
| `cursor` | string | No | Opaque cursor returned by a previous call. |
| `offset` | integer | No | Offset for pagination |
| `to_date` | string | No | Filter shifts until this date (YYYY-MM-DD) |
| `from_date` | string | No | Filter shifts from this date (YYYY-MM-DD) |
| `contract_id` | array | No | Filter shifts by one or more contract IDs. |
| `contract_id_brackets` | array | No | Filter shifts by one or more contract IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `DEEL_LIST_USERS`

List users from Deel's SCIM HRIS directory. Supports Deel's documented email equality filter and SCIM startIndex/count pagination parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | string | No | Maximum results to return. Deel treats 0 as a special case that returns one result. |
| `filter` | string | No | SCIM filter. Deel currently supports the eq operator for email, for example: email eq "person@example.com". |
| `start_index` | string | No | One-based index of the first result; Deel defaults to 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List webhook event types

**Slug:** `DEEL_LIST_WEBHOOK_EVENTS`

List webhook event types. Calls Deel's documented GET /webhooks/events/types Organization OAuth candidate operation.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List webhooks

**Slug:** `DEEL_LIST_WEBHOOKS`

List webhooks. Calls Deel's documented GET /webhooks Organization OAuth candidate operation.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List of worker relations

**Slug:** `DEEL_LIST_WORKER_RELATION_PROFILE`

List of worker relations. Calls Deel's documented GET /hris/worker_relations/profile/{hrisProfileOid} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hris_profile_oid` | string | Yes | HrisProfile ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve all worker relation types

**Slug:** `DEEL_LIST_WORKER_RELATION_TYPES`

Retrieve all worker relation types. Calls Deel's documented GET /hris/worker_relations/types Organization OAuth candidate operation.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List work statement payment policies

**Slug:** `DEEL_LIST_WORK_STATEMENT_PAYMENT_POLICIES`

List work statement payment policies. Calls Deel's documented GET /work-statement-payment-policies Organization OAuth candidate operation.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign agreement to a new worker

**Slug:** `DEEL_REASSIGN_IT_AGREEMENT`

Assign agreement to a new worker. Calls Deel's documented POST /it/agreements/{agreement_id}/reassign Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Reassignment payload. |
| `agreement_id` | string | Yes | Unique identifier of the agreement |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a file upload

**Slug:** `DEEL_REGISTER_FILE_UPLOAD`

Initialize a Deel file upload and return upload targets, required form fields, the file id, and its single-use claim token. This action does not transfer file bytes: upload them separately to each returned presigned URL, include every returned form field unchanged, and do not send Deel Authorization or x-client-id headers to storage. Then pass the claim token only to a matching upload status, completion, or file-claim action. Calls Deel's documented POST /files Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `x_upload_method` | string | No | Declares the client is multipart-capable. The server returns a multipart response only when the declared size exceeds the configured multipart threshold (`MULTIPART_THRESHOLD`); otherwise the standard POST form. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reject an EOR quote

**Slug:** `DEEL_REJECT_EOR_QUOTE`

Reject an EOR quote. Calls Deel's documented PATCH /eor/contracts/{contract_id}/reject Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique identifier of the EOR contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Legal Entity Registration Document Files

**Slug:** `DEEL_RESUBMIT_LEGAL_ENTITY_REGISTRATION_DOCUMENT`

Replace legal entity registration document files. Each upload claim token must come from Deel's POST /files response for the matching file_id; it claims only that initialized file. Calls Deel's documented PUT /legal-entities/{legal_entity_id}/registration-documents/{document_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `document_id` | string | Yes | Public UUID of the document submission. |
| `legal_entity_id` | string | Yes | Public UUID of the legal entity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit employee resignation PTO review

**Slug:** `DEEL_REVIEW_EOR_OFFBOARDING_PTO`

Submit employee resignation PTO review. Calls Deel's documented POST /eor/contracts/{contract_id}/offboarding/resignations/review-pto Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique identifier of the employee contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Review multiple tasks

**Slug:** `DEEL_REVIEW_MULTIPLE_TASKS`

Review multiple tasks. Calls Deel's documented POST /contracts/{contract_id}/tasks/many/reviews Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique Deel contract ID associated with the tasks. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Review multiple timesheets

**Slug:** `DEEL_REVIEW_MULTIPLE_TIMESHEETS`

Review multiple timesheets. Calls Deel's documented POST /timesheets/many/reviews Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Approve or reject time-off requests

**Slug:** `DEEL_REVIEW_TIME_OFF_REQUEST`

Approve or reject time-off requests. Calls Deel's documented POST /time_offs/review Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | No | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Review a submitted timesheet

**Slug:** `DEEL_REVIEW_TIME_TRACKING_TIMESHEET`

Review a submitted timesheet. Calls Deel's documented POST /time-tracking/timesheets/{timesheet_id}/review Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `timesheet_id` | string | Yes | ID of the timesheet to review |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set salary split

**Slug:** `DEEL_SET_GP_CONTRACT_BANK_SETTINGS`

Set salary split. Calls Deel's documented PATCH /gp/contracts/{contract_id}/banks/settings Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | Unique identifier for a contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sign Amendment

**Slug:** `DEEL_SIGN_AMENDMENT`

Sign Amendment. Calls Deel's documented POST /workers/amendments/{amendment_id}/sign Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |
| `amendment_id` | string | Yes | The unique identifier of the amendment to sign |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sign EOR contract document

**Slug:** `DEEL_SIGN_CONTRACT_DOCUMENT`

Sign EOR contract document. Calls Deel's documented POST /eor/contracts/{contract_id}/documents/{type}/sign Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |
| `type` | string | Yes | The type of document. Currently only FRAMEWORK_AGREEMENT is supported. |
| `contract_id` | string | Yes | EOR contract ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit Global Payroll amendment signature

**Slug:** `DEEL_SIGN_GLOBAL_PAYROLL_AMENDMENT`

Submit Global Payroll amendment signature. Calls Deel's documented POST /contracts/{contract_id}/amendments/{amendment_id}/sign Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique identifier of the Global Payroll contract. |
| `amendment_id` | string | Yes | The unique identifier of the Global Payroll amendment to sign, as returned by POST /rest/contracts/{contract_id}/amendments. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit KYB information for a legal entity

**Slug:** `DEEL_SUBMIT_LEGAL_ENTITY_KYB`

Submit KYB information for a legal entity. Calls Deel's documented POST /legal-entities/{legal_entity_id}/kyb Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `legal_entity_id` | string | Yes | Public id of the legal entity. The entity must belong to the authenticated organization; any other id answers 404. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit Legal Entity Registration Documents

**Slug:** `DEEL_SUBMIT_LEGAL_ENTITY_REGISTRATION_DOCUMENTS`

Submit legal entity registration documents. Each upload claim token must come from Deel's POST /files response for the matching file_id; it claims only that initialized file. Calls Deel's documented POST /legal-entities/{legal_entity_id}/registration-documents Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `legal_entity_id` | string | Yes | Public UUID of the legal entity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit On-Demand Payroll

**Slug:** `DEEL_SUBMIT_ON_DEMAND_PAYROLL`

Submit On-Demand Payroll. Calls Deel's documented POST /on-demand-payroll/{odp_id}/submit Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `odp_id` | string | Yes | Public ID of the On-Demand Payroll. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit a payroll migration import for review

**Slug:** `DEEL_SUBMIT_PAYROLL_MIGRATION_IMPORT`

Submit a payroll migration import for review. Calls Deel's documented POST /gp/legal-entities/{legal_entity_id}/payroll-migration-imports/{import_id}/submit Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `import_id` | string | Yes | The unique identifier of the payroll migration import to submit, as returned when its files were attached. |
| `legal_entity_id` | string | Yes | The unique identifier of the legal entity the payroll migration import belongs to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sync cost centers for legal entity

**Slug:** `DEEL_SYNC_COST_CENTERS_LEGAL_ENTITY`

Sync cost centers for legal entity. Calls Deel's documented POST /legal-entities/{legal_entity_id}/cost-centers/synchronize Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Documented data request body. |
| `legal_entity_id` | string | Yes | Legal entity id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Process time-off requests from an external HRIS

**Slug:** `DEEL_SYNC_TIME_OFF_GLOBAL_PAYROLL`

Process time-off requests from an external HRIS. Calls Deel's documented POST /time_offs/global-payroll/sync Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign asset to new holder

**Slug:** `DEEL_TRANSFER_IT_ASSET`

Assign asset to new holder. Calls Deel's documented POST /it/assets/{asset_id}/transfer Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `asset_id` | string | Yes | Unique identifier of the IT asset |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restore an archived IT asset

**Slug:** `DEEL_UNARCHIVE_ASSET`

Restore an archived IT asset. Calls Deel's documented POST /it/assets/{asset_id}/unarchive Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `asset_id` | string | Yes | Unique identifier of the IT asset |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unassign workers from IT seats

**Slug:** `DEEL_UNASSIGN_WORKERS_FROM_IT_SEATS`

Unassign workers from IT seats. Calls Deel's documented POST /it/seats/unassign Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Workers whose IT seat to release. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update asset

**Slug:** `DEEL_UPDATE_ASSET`

Update asset. Calls Deel's documented PATCH /it/assets/{asset_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `asset_id` | string | Yes | Unique identifier of the IT asset |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update asset location

**Slug:** `DEEL_UPDATE_ASSET_LOCATION`

Update asset location. Calls Deel's documented POST /it/assets/{asset_id}/location Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `asset_id` | string | Yes | Unique identifier of the IT asset |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update ATS Application

**Slug:** `DEEL_UPDATE_ATS_APPLICATION`

Update ATS Application. Calls Deel's documented PATCH /ats/applications/{application_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `application_id` | string | Yes | Unique identifier of the application to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update ATS Candidate

**Slug:** `DEEL_UPDATE_ATS_CANDIDATE`

Update ATS Candidate. Calls Deel's documented PATCH /ats/candidates/{candidate_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `candidate_id` | string | Yes | Unique identifier of the candidate to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an adjustment

**Slug:** `DEEL_UPDATE_CONTRACT_ADJUSTMENT`

Partially update an existing Deel payroll or EOR adjustment, optionally replacing its receipt file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Deel adjustment identifier. |
| `data` | object | Yes | Adjustment fields to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update amendment

**Slug:** `DEEL_UPDATE_CONTRACT_AMENDMENT`

Update amendment. Calls Deel's documented PATCH /eor/contracts/{contract_id}/amendments/{amendment_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique identifier of EOR worker contract. |
| `amendment_id` | string | Yes | A unique identifier for the employee contract amendment. This string is either supplied by the client or generated by the system and is used to uniquely identify the amendment during upsert operations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update custom field value

**Slug:** `DEEL_UPDATE_CONTRACT_CUSTOM_FIELD`

Replace a contract's custom-field values; values omitted from the request are removed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Complete set of contract custom-field values. Each item identifies the custom-field definition and supplies the value shape for its field type. |
| `contract_id` | string | Yes | Contract id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee Information for EOR Contract

**Slug:** `DEEL_UPDATE_CONTRACT_EMPLOYEE_INFORMATION`

Update Employee Information for EOR Contract. Calls Deel's documented PATCH /eor/contracts/{contract_id}/employee-information Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique identifier of the employee contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update contract payment type

**Slug:** `DEEL_UPDATE_CONTRACT_PLATFORM_PAYMENT_TYPE`

Update contract payment type. Calls Deel's documented PATCH /contracts/{contract_id}/platform-payment Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | Unique identifier of the contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Current Personal Profile

**Slug:** `DEEL_UPDATE_CURRENT_PERSONAL_PROFILE`

Update the authenticated user's personal profile fields, including name, phone, preferred currency, and timezone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Profile fields to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update employment type for a contract

**Slug:** `DEEL_UPDATE_EMPLOYMENT_TYPE_CONTRACT`

Update employment type for a contract. Calls Deel's documented PATCH /gp/contracts/{contract_id}/employment-type Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Employment-type change details, including the effective date. |
| `contract_id` | string | Yes | The unique identifier of the GP contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update end date for a contract

**Slug:** `DEEL_UPDATE_END_DATE_CONTRACT`

Update end date for a contract. Calls Deel's documented PATCH /gp/contracts/{contract_id}/end-date Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | End date change details, including the effective date. |
| `contract_id` | string | Yes | The unique identifier of the GP contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update EOR Contract

**Slug:** `DEEL_UPDATE_EOR_CONTRACT`

Replace the editable details of an EOR contract. Include job_title, start_date, employee_first_name, employee_last_name, employee_email, employment_country, and employment_type even when changing only one field. Calls Deel's documented PATCH /eor/contract/{contract_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique identifier of the employee contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update bank account

**Slug:** `DEEL_UPDATE_GP_CONTRACT_BANK_ACCOUNT`

Partially update one bank account for a specific Global Payroll contract without affecting the worker's other contracts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `bank_id` | string | Yes | Unique identifier for the bank account in UUID format. |
| `contract_id` | string | Yes | Unique identifier for a contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update GP worker additional information

**Slug:** `DEEL_UPDATE_GP_WORKER_ADDITIONAL_INFORMATION`

Update GP worker additional information. Calls Deel's documented PATCH /gp/workers/contracts/{contract_id}/additional-information Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Additional-information values keyed by public API field key. |
| `contract_id` | string | Yes | The unique public identifier of the contract. |
| `effective_dates` | object | No | Documented effective_dates request body. |
| `include_completion_status` | boolean | No | Pass `true` to receive a 200 response with `is_additional_data_done` and `missing_keys` instead of the default 204 No Content. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update address

**Slug:** `DEEL_UPDATE_GP_WORKER_ADDRESS`

Update address. Calls Deel's documented PATCH /gp/workers/{worker_id}/address Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `worker_id` | string | Yes | Unique identifier for a worker in UUID format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Modify bank account

**Slug:** `DEEL_UPDATE_GP_WORKER_BANK`

Modify bank account. Calls Deel's documented PATCH /gp/workers/{worker_id}/banks/{bank_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | Documented city request body. |
| `iban` | string | No | Documented iban request body. |
| `email` | string | No | Documented email request body. |
| `phone` | string | No | Documented phone request body. |
| `postal` | string | No | Documented postal request body. |
| `tax_id` | string | No | Documented tax_id request body. |
| `bank_id` | string | Yes | Unique identifier for the bank account in UUID format. |
| `bank_code` | string | No | Documented bank_code request body. |
| `bank_name` | string | No | Documented bank_name request body. |
| `full_name` | string | No | Documented full_name request body. |
| `swift_bic` | string | No | Documented swift_bic request body. |
| `worker_id` | string | Yes | Unique identifier for a worker in UUID format. |
| `rib_number` | string | No | Documented rib_number request body. |
| `branch_code` | string | No | Documented branch_code request body. |
| `account_type` | string | No | Documented account_type request body. |
| `country_code` | string | No | Documented country_code request body. |
| `address_line1` | string | No | Documented address_line1 request body. |
| `address_line2` | string | No | Documented address_line2 request body. |
| `currency_code` | string | No | Documented currency_code request body. |
| `original_name` | string | No | Documented original_name request body. |
| `account_number` | string | No | Documented account_number request body. |
| `province_state` | string | No | Documented province_state request body. |
| `bank_branch_name` | string | No | Documented bank_branch_name request body. |
| `bank_country_code` | string | No | Documented bank_country_code request body. |
| `ach_routing_number` | string | No | Documented ach_routing_number request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update compensation

**Slug:** `DEEL_UPDATE_GP_WORKER_COMPENSATION`

Update compensation. Calls Deel's documented PATCH /gp/workers/{worker_id}/compensation Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `worker_id` | string | Yes | Unique identifier for a worker in UUID format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update employee information

**Slug:** `DEEL_UPDATE_GP_WORKER_EMPLOYEE_INFORMATION`

Update employee information. Calls Deel's documented PATCH /gp/workers/{worker_id}/employee-information Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `worker_id` | string | Yes | Unique identifier for a worker in UUID format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update PTO policy

**Slug:** `DEEL_UPDATE_GP_WORKER_PTO_POLICY`

Update PTO policy. Calls Deel's documented PATCH /gp/workers/{worker_id}/pto-policy Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `worker_id` | string | Yes | Unique identifier for a worker in UUID format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit a group

**Slug:** `DEEL_UPDATE_GROUP`

Edit a group. Calls Deel's documented PATCH /groups/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the group to be edited. |
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add external Id

**Slug:** `DEEL_UPDATE_IC_CONTRACT`

Add external Id. Calls Deel's documented PATCH /contracts/{contract_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | Deel contract id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update IC invoicing tax

**Slug:** `DEEL_UPDATE_IC_INVOICING_TAX`

Update IC invoicing tax. Calls Deel's documented PATCH /contracts/{contract_id}/ic-invoicing-taxes Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | IC invoicing tax fields to update on the contract. |
| `contract_id` | string | Yes | Deel Contract ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an invoice adjustment

**Slug:** `DEEL_UPDATE_INVOICE_ADJUSTMENT`

Update an invoice adjustment. Calls Deel's documented PATCH /invoice-adjustments/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Invoice adjustment id. |
| `data` | object | Yes | Details of adjustment to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit a legal entity

**Slug:** `DEEL_UPDATE_LEGAL_ENTITY`

Edit a legal entity. Calls Deel's documented PATCH /legal-entities/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the legal entity to update. |
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update GP employee app access for a legal entity

**Slug:** `DEEL_UPDATE_LEGAL_ENTITY_SETTING`

Update GP employee app access for a legal entity. Calls Deel's documented POST /legal-entities/{legal_entity_id}/settings Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `legal_entity_id` | string | Yes | The ID of the legal entity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update organization custom role

**Slug:** `DEEL_UPDATE_ORGANIZATION_ROLE`

Update organization custom role. Calls Deel's documented PATCH /roles/{roleId} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Documented data request body. |
| `role_id` | string | Yes | ID of the role |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Organization Secure Vault Folder

**Slug:** `DEEL_UPDATE_ORGANIZATION_SECURE_VAULT_FOLDER`

Update Organization Secure Vault Folder. Calls Deel's documented PATCH /organizations/secure-vault/folders/{folder_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Fields to update on the folder. |
| `folder_id` | string | Yes | Public UUID of the folder. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an existing HRIS Org Structure

**Slug:** `DEEL_UPDATE_ORGANIZATION_STRUCTURE`

Update an existing HRIS Org Structure. Calls Deel's documented PATCH /hris/organization_structures/{hris_org_structure_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `hris_org_structure_id` | string | Yes | Org Structure |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an existing HRIS Org Structure by external ID

**Slug:** `DEEL_UPDATE_ORGANIZATION_STRUCTURE_EXTERNAL_ID`

Update an existing HRIS Org Structure by external ID. Calls Deel's documented PATCH /hris/organization_structures/external/{external_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `external_id` | string | Yes | External ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update custom field value

**Slug:** `DEEL_UPDATE_PERSON_CUSTOM_FIELD`

Create or overwrite one custom-field value for a worker.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | One worker custom-field value, identifying the custom-field definition and supplying the value shape for its field type. |
| `worker_id` | string | Yes | Worker ID in UUID format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update organization structure

**Slug:** `DEEL_UPDATE_PERSON_DEPARTMENT`

Update organization structure. Calls Deel's documented PUT /people/{id}/department Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Hris profile ID |
| `data` | object | Yes | Documented data request body. |
| `replace_other_positions` | boolean | No | Indicates if this department position should replace all other positions or only append to the existing ones. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update personal information

**Slug:** `DEEL_UPDATE_PERSON_PERSONAL_INFO`

Update personal information. Calls Deel's documented PATCH /people/{worker_id}/personal Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `worker_id` | string | Yes | Unique identifier for a worker. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update personal information by external id

**Slug:** `DEEL_UPDATE_PERSON_PERSONAL_INFO_EXTERNAL_ID`

Update personal information by external id. Calls Deel's documented PATCH /people/external/{worker_id}/personal Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `worker_id` | string | Yes | Unique identifier for a worker (External ID). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update working location

**Slug:** `DEEL_UPDATE_PERSON_WORKING_LOCATION`

Update working location. Calls Deel's documented PUT /people/{id}/working-location Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Hris profile ID |
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a Shift Rate

**Slug:** `DEEL_UPDATE_SHIFT_RATE_BY_EXTERNAL_ID`

Update a shift rate's name, type, or value by external ID; Deel rejects updates while any shift references the rate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Shift-rate fields to update. |
| `external_id` | string | Yes | Unique identifier of the shift rate to be updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Task By ID

**Slug:** `DEEL_UPDATE_TASK_ID`

Update Task By ID. Calls Deel's documented PATCH /tasks/{task_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `task_id` | string | Yes | The id of an existing task |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update time-off request

**Slug:** `DEEL_UPDATE_TIME_OFF_REQUEST`

Update time-off request. Calls Deel's documented PATCH /time_offs/{time_off_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Time off update request data |
| `time_off_id` | string | Yes | Time off request id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a timesheet entry

**Slug:** `DEEL_UPDATE_TIMESHEET_ENTRY`

Update a timesheet entry. Calls Deel's documented PATCH /timesheets/{timesheet_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Fields to update on the existing timesheet entry. |
| `timesheet_id` | string | Yes | ID of an existing timesheet. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Hourly Report Preset

**Slug:** `DEEL_UPDATE_TIMESHEETS_PRESET`

Update Hourly Report Preset. Calls Deel's documented PATCH /timesheets/presets/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the hourly report preset to update |
| `data` | object | Yes | Documented data request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a shift

**Slug:** `DEEL_UPDATE_TIME_TRACKING_SHIFT_EXTERNAL_ID`

Update a shift. Calls Deel's documented PATCH /time_tracking/shifts/{external_id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `external_id` | string | Yes | Unique identifier of the shift to be updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a webhook

**Slug:** `DEEL_UPDATE_WEBHOOK`

Update a webhook. Calls Deel's documented PATCH /webhooks/{id} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the webhook subscription. |
| `url` | string | No | Documented url request body. |
| `name` | string | No | Documented name request body. |
| `events` | array | No | Documented events request body. |
| `status` | string ("enabled" | "disabled") | No | Status of webhook. |
| `description` | string | No | Documented description request body. |
| `include_child_orgs` | boolean | No | Documented include_child_orgs request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a worker relation type

**Slug:** `DEEL_UPDATE_WORKER_RELATION_TYPE`

Update a worker relation type. Calls Deel's documented PATCH /hris/worker_relations/types/{typeId} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `type_id` | string | Yes | Worker Relation Type id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a worker relation type by external id

**Slug:** `DEEL_UPDATE_WORKER_RELATION_TYPE_EXTERNAL_ID`

Update a worker relation type by external id. Calls Deel's documented PATCH /hris/worker_relations/types/external/{externalId} Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `external_id` | string | Yes | Worker Relation Type external ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload a KYB document for a legal entity

**Slug:** `DEEL_UPLOAD_LEGAL_ENTITY_KYB_DOCUMENT`

Upload one company or identity document and return the handle used in a legal-entity KYB submission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | KYB document and its type. |
| `legal_entity_id` | string | Yes | Public ID of a legal entity belonging to the authenticated organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload a document for an EDD request of a legal entity

**Slug:** `DEEL_UPLOAD_LEGAL_ENTITY_KYB_EDD_DOCUMENT`

Upload one document for a DOCUMENT_UPLOAD question in an open legal-entity EDD request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | EDD document and question binding. |
| `legal_entity_id` | string | Yes | Public ID of a legal entity belonging to the authenticated organization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Organization Secure Vault Files

**Slug:** `DEEL_UPLOAD_ORGANIZATION_SECURE_VAULT_FILES`

Upload files to the Organization Secure Vault root. Each upload claim token must come from Deel's POST /files response for the matching file_id; it claims only that initialized file. Calls Deel's documented POST /organizations/secure-vault/files Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | The files to attach to the Organization Secure Vault. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Organization Secure Vault Files To Folder

**Slug:** `DEEL_UPLOAD_ORGANIZATION_SECURE_VAULT_FILES_FOLDER`

Upload files to an Organization Secure Vault folder. Each upload claim token must come from Deel's POST /files response for the matching file_id; it claims only that initialized file. Calls Deel's documented POST /organizations/secure-vault/folders/{folder_id}/files Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | The files to attach to the Organization Secure Vault. |
| `folder_id` | string | Yes | Public UUID of the folder. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Vendor Bill Attachment

**Slug:** `DEEL_UPLOAD_VENDOR_BILL_ATTACHMENT`

Upload a PDF attachment of up to 8 MB to an existing Deel vendor bill.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | PDF attachment, with a maximum size of 8 MB. |
| `vendor_bill_id` | string | Yes | Vendor bill UUID to attach the PDF to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate amendment data points

**Slug:** `DEEL_VALIDATE_EOR_AMENDMENTS`

Validate amendment data points. Calls Deel's documented POST /eor/contracts/{contract_id}/amendments/validate Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Documented data request body. |
| `contract_id` | string | Yes | The unique identifier of the employee contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Request job scope validation

**Slug:** `DEEL_VALIDATE_JOB_SCOPE`

Request job scope validation. Calls Deel's documented POST /eor/job-scopes/validate Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | details of job scope |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate time-off request

**Slug:** `DEEL_VALIDATE_TIME_OFF`

Validate time-off request. Calls Deel's documented POST /time_offs/validate Organization OAuth candidate operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Time off request data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |