> ## 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.

# Humaans HRIS Integration

> Humaans connector for Kombo's HRIS API

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

## Guides and Resources

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

  <Card title="Sandbox Environment" icon="flask" href="https://docs.google.com/forms/d/e/1FAIpQLSfvsENhiZgum1DTEsqM3-LSJaBM6Ee2e3zfW71YtW112iAGyw/viewform">
    Access the Humaans sandbox environment for testing and development.
  </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   |       |
      | employee\_number      |       |
      | first\_name           |       |
      | last\_name            |       |
      | nationality           |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | tax\_id               |       |
      | gender                |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | 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 |       |
      | remote\_data          |       |
    </Accordion>

    <Accordion title="Absences">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | employee\_id        |       |
      | approver\_id        |       |
      | start\_date         |       |
      | end\_date           |       |
      | start\_half\_day    |       |
      | end\_half\_day      |       |
      | amount              |       |
      | unit                |       |
      | 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         |       |
      | employment\_type    |       |
      | pay\_currency       |       |
      | effective\_date     |       |
      | remote\_data        |       |
    </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 employee">
      <Note>
        Humaans requires a location to be set for the employee. We set it to to the first location in the system by default. You can change it by setting the `location_id` the request body.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | nationality             |       |
      | start\_date             |       |
      | location\_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      |                                                                                                                                                                                                                                                                                                                                                                         |
    | Create credentials |                                                                                                                                                                                                                                                                                                                                                                         |
    | API Passthrough    |                                                                                                                                                                                                                                                                                                                                                                         |
    | Scope Testing      |                                                                                                                                                                                                                                                                                                                                                                         |
    | Per Model Tests    |                                                                                                                                                                                                                                                                                                                                                                         |
    | Per Field Tests    | The Humaans API returns null values both if the API does not have permissions to access the field, and if the field simply does not have a value. The permission test therefore only checks for the presence of very common fields (e.g. birthday) where it is safe to assume that a null value is due to lack of permissions rather than due to a value not being set. |
    | Group Types        |                                                                                                                                                                                                                                                                                                                                                                         |
    | TEAM               |                                                                                                                                                                                                                                                                                                                                                                         |
    | DEPARTMENT         |                                                                                                                                                                                                                                                                                                                                                                         |
  </Tab>

  <Tab title="Create Employee with Form">
    <Note>
      Employment end date requires a leaving reason.
    </Note>

    <Info>
      Some **required** form fields are referencing the following data models:

      * Locations

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

      * Employees

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

    <ResponseField name="email" type="text" required>**Work Email**<br />
    Work email address for the employee. Must be unique in Humaans.<br />
    Unified field: `work_email`</ResponseField>
    <ResponseField name="firstName" type="text" required>**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="lastName" type="text" required>**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="locationId" type="single_select" required>**Location**<br />
    The Kombo ID of the location the employee should be in<br />
    Unified field: `location_id`<br />
    References `/v1/hris/locations?remote_model=location`</ResponseField>
    <ResponseField name="employmentStartDate" 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="jobRole" type="object" required>
      **Job Role**

      <Expandable title="properties">
        <ResponseField name="jobTitle" type="text" required>**Job Title**<br />
        The title of the position this person is working in<br />
        Unified field: `job_title`</ResponseField>
        <ResponseField name="department" type="text">**Department**</ResponseField>
        <ResponseField name="reportingTo" type="single_select">**Manager**<br />
        References `/v1/hris/employees?remote_model=employee`</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="middleName" type="text">**Middle Name**</ResponseField>
    <ResponseField name="preferredName" type="text">**Preferred Name**</ResponseField>
    <ResponseField name="pronouns" type="text">**Pronouns**</ResponseField>
    <ResponseField name="gender" type="single_select">**Gender**<br />
    The gender of the employee<br />
    Unified field: `gender`</ResponseField>
    <ResponseField name="birthday" type="date">**Date of Birth**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="isBirthdayHidden" type="checkbox">**Hide Birthday**<br />
    If enabled, the birthday will be hidden from others.</ResponseField>
    <ResponseField name="personalEmail" type="text">**Private Email**<br />
    The private email address of the employee<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="phoneNumber" type="text">**Mobile Phone Number**<br />
    The mobile phone number of the employee<br />
    Unified field: `mobile_phone_number`</ResponseField>
    <ResponseField name="personalPhoneNumber" type="text">**Home Phone Number**<br />
    The home phone number of the employee<br />
    Unified field: `home_phone_number`</ResponseField>
    <ResponseField name="isWorkEmailHidden" type="checkbox">**Hide Work Email**<br />
    If enabled, hides the work email inside Humaans.</ResponseField>
    <ResponseField name="address" type="text">**Street 1**<br />
    The street address of the employee<br />
    Unified field: `home_address.street_1`</ResponseField>
    <ResponseField name="city" type="text">**City**<br />
    The city of the employee<br />
    Unified field: `home_address.city`</ResponseField>
    <ResponseField name="state" type="text">**State**<br />
    The state of the employee<br />
    Unified field: `home_address.state`</ResponseField>
    <ResponseField name="postcode" type="text">**ZIP Code**<br />
    The ZIP code of the employee<br />
    Unified field: `home_address.zip_code`</ResponseField>
    <ResponseField name="countryCode" type="text">**Country**<br />
    ISO country code (e.g. US, GB).<br />
    Unified field: `home_address.country`</ResponseField>
    <ResponseField name="remoteCity" type="text">**Remote City**</ResponseField>
    <ResponseField name="remoteCountryCode" type="text">**Remote Country Code**<br />
    ISO country code for the remote location (e.g. US). Not required for on-site employees.</ResponseField>
    <ResponseField name="nationality" type="text">**Nationality**</ResponseField>

    <ResponseField name="spokenLanguages" type="array">
      **Spoken Languages**

      <Expandable title="items">
        <ResponseField name="Item" type="text" />
      </Expandable>
    </ResponseField>

    <ResponseField name="foodAllergies" type="array">
      **Food Allergies**

      <Expandable title="items">
        <ResponseField name="Item" type="text" />
      </Expandable>
    </ResponseField>

    <ResponseField name="bio" type="text">**Bio**</ResponseField>
    <ResponseField name="linkedIn" type="text">**LinkedIn**</ResponseField>
    <ResponseField name="twitter" type="text">**Twitter**</ResponseField>
    <ResponseField name="github" type="text">**GitHub**</ResponseField>
    <ResponseField name="firstWorkingDay" type="date">**First Working Day**<br />
    First day at work. Defaults to the employment start date if omitted.</ResponseField>
    <ResponseField name="probationEndDate" type="date">**Probation End Date**<br />
    Must be after the start date.</ResponseField>
    <ResponseField name="employeeId" type="text">**Employee ID**</ResponseField>
    <ResponseField name="contractType" type="single_select">**Contract Type**</ResponseField>
    <ResponseField name="employmentEndDate" type="date">**Employment End Date**<br />
    Must be after the first working day. Requires a leaving reason.</ResponseField>
    <ResponseField name="leavingReason" type="single_select">**Leaving Reason**</ResponseField>
    <ResponseField name="leavingNote" type="text">**Leaving Note**</ResponseField>
    <ResponseField name="taxId" type="text">**Tax ID**</ResponseField>
    <ResponseField name="taxCode" type="text">**Tax Code**</ResponseField>
    <ResponseField name="payrollProvider" type="text">**Payroll Provider**</ResponseField>

    <ResponseField name="workingDays" type="array">
      **Working Days**<br />
      List of days the employee is scheduled to work. Defaults to Monday–Friday when omitted.

      <Expandable title="items">
        <ResponseField name="day" type="single_select" required>**Day**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="teams" type="array">
      **Teams**

      <Expandable title="items">
        <ResponseField name="name" type="text" required>**Team Name**</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>
