> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Deel HRIS Integration

> Deel connector for Kombo's HRIS API

The Deel HRIS integration allows you to sync HRIS data between Deel and your application through Kombo's unified API. The tool slug for this connector is `deel`.

## Guides and Resources

<CardGroup cols={2}>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/18401663397521">
    Step-by-step instructions to connect your Deel account to Kombo.
  </Card>

  <Card title="Partnership Guide" icon="handshake" href="https://help.kombo.dev/hc/en-us/articles/18977903676433-Deel-How-to-get-your-Partner-Credentials">
    Learn how to become a partner with Deel to enable this integration.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employees">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | first\_name         |       |
      | last\_name          |       |
      | display\_full\_name |       |
      | job\_title          |       |
      | work\_email         |       |
      | personal\_email     |       |
      | gender              |       |
      | employment\_status  |       |
      | employment\_type    |       |
      | work\_location\_id  |       |
      | legal\_entity\_id   |       |
      | manager\_id         |       |
      | home\_address       |       |
      | date\_of\_birth     |       |
      | start\_date         |       |
      | termination\_date   |       |
      | remote\_created\_at |       |
      | custom\_fields      |       |
      | integration\_fields |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Absence Types">
      | Field                   | Notes |
      | ----------------------- | ----- |
      | id                      |       |
      | remote\_id              |       |
      | changed\_at             |       |
      | remote\_deleted\_at     |       |
      | name                    |       |
      | unit                    |       |
      | half\_days\_supported   |       |
      | exact\_times\_supported |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | status              |       |
      | employee\_note      |       |
      | type\_id            |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | job\_title          |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | pay\_frequency      |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Time Off Balances">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | type\_id            |       |
      | balance             |       |
      | balance\_unit       |       |
      | used                |       |
      | used\_unit          |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      | Field               | Notes |
      | ------------------- | ----- |
      | employee\_id        |       |
      | team\_id            |       |
      | id                  |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
    </Accordion>
  </Tab>

  <Tab title="Actions">
    <Accordion title="Create absence">
      <Note>
        Everything in Deel works through contracts, creating an absence requires that the employee has an active contract. We use the employee's latest active contract to register the absence.
      </Note>

      | Input Field       | Notes |
      | ----------------- | ----- |
      | employee\_id      |       |
      | absence\_type\_id |       |
      | start\_date       |       |
      | end\_date         |       |
      | start\_half\_day  |       |
      | end\_half\_day    |       |
      | employee\_note    |       |
    </Accordion>

    <Accordion title="Delete absence">
      | Input Field | Notes |
      | ----------- | ----- |
      | absence\_id |       |
    </Accordion>

    <Accordion title="Create employee (v2)">
      <Info>For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.</Info>

      | Input Field          | Notes |
      | -------------------- | ----- |
      | staffing\_entity\_id |       |
      | properties           |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | Connection Guide |       |
    | Prerequisites    |       |
    | Locate Admin     |       |
    | OAuth            |       |
    | API Passthrough  |       |
    | Group Types      |       |
    | TEAM             |       |
    | DEPARTMENT       |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Info>
      Some **required** form fields are referencing the following data models:

      * Groups
      * Legal Entities

      Additionally, there are some **optional** form fields that reference:

      * Employees
      * Groups

      Consider enabling these in your [scope configuration](/hris/features/scopes).
    </Info>

    <ResponseField name="client" type="object" required>
      **Organization**<br />
      Where the new employee sits in your Deel organization.

      <Expandable title="properties">
        <ResponseField name="legalEntity" type="single_select" required>**Legal Entity**<br />
        Unified field: `legal_entity_id`<br />
        References `/v1/hris/legal-entities?remote_model=legal_entity`</ResponseField>
        <ResponseField name="team" type="single_select" required>**Team**<br />
        References `/v1/hris/groups?types=TEAM`</ResponseField>
        <ResponseField name="department" type="single_select">**Department**<br />
        References `/v1/hris/groups?types=DEPARTMENT`</ResponseField>
        <ResponseField name="directManager" type="single_select">**Direct Manager**<br />
        References `/v1/hris/employees?remote_model=employee`</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="employee" type="object" required>
      **Employee**<br />
      Personal details for the new employee.

      <Expandable title="properties">
        <ResponseField name="email" type="text" required>**Private Email**<br />
        The personal email of the employee.<br />
        Unified field: `private_email`</ResponseField>
        <ResponseField name="first_name" type="text" required>**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="last_name" type="text" required>**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="nationality" type="text" required>**Nationality**<br />
        The uppercase two-letter ISO country (e.g., DE)<br />
        Unified field: `nationality`</ResponseField>
        <ResponseField name="country" type="text" required>**Country**<br />
        The country where the employee works, as an uppercase two-letter ISO code (e.g., DE).</ResponseField>
        <ResponseField name="work_email" type="text">**Work Email**<br />
        The email address of the employee<br />
        Unified field: `work_email`</ResponseField>
        <ResponseField name="preferred_first_name" type="text">**Preferred First Name**</ResponseField>
        <ResponseField name="preferred_last_name" type="text">**Preferred Last Name**</ResponseField>
        <ResponseField name="external_id" type="text">**External ID**<br />
        An external identifier to store on the employee.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="employment" type="object" required>
      **Employment**<br />
      Job, seniority, and contract dates. Deel requires all of these to issue a direct-employee contract.

      <Expandable title="properties">
        <ResponseField name="start_date" type="date" required>**Start Date**<br />
        Start date of the employee. Also considered to be the hire date<br />
        Unified field: `start_date`</ResponseField>
        <ResponseField name="job_title" type="text" required>**Job Title**<br />
        The title of the position this person is working in<br />
        Unified field: `job_title`</ResponseField>
        <ResponseField name="seniority" type="single_select" required>**Seniority**</ResponseField>
        <ResponseField name="type" type="single_select" required>**Employment Type**</ResponseField>
        <ResponseField name="part_time_percentage" type="number">**Part-time Percentage**<br />
        Required when Employment Type is Part-time.</ResponseField>
        <ResponseField name="end_date" type="date">**End Date**<br />
        The end date of the employment, for fixed-term hires.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="compensation_details" type="object" required>
      **Compensation**<br />
      Annual gross salary and pay currency.

      <Expandable title="properties">
        <ResponseField name="salary" type="number" required>**Yearly Salary**<br />
        The gross annual salary, in the chosen currency.<br />
        Unified field: `yearly_salary`</ResponseField>
        <ResponseField name="currency" type="single_select" required>**Currency**<br />
        The ISO-4217 currency code. Must match one of the legal entity's allowed currencies.</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>