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

# Gusto HRIS Integration

> Gusto connector for Kombo's HRIS API

<Note>This connector requires a partnership with Gusto. Please contact us to get access.</Note>

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

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
      | 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            |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | work\_location\_id    |       |
      | legal\_entity\_id     |       |
      | manager\_id           |       |
      | home\_address         |       |
      | date\_of\_birth       |       |
      | start\_date           |       |
      | termination\_date     |       |
      | custom\_fields        |       |
      | integration\_fields   |       |
      | 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    |       |
      | effective\_date     |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | 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>
        Gusto requires a personal email address to create an employee. This personal email address needs to be submitted through the `work_email` field. Gusto requires an input for which company to add an employee to. Most instances we see have just one company. We will default to the first company we find if `legal_entity_id` is not provided in 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.zip\_code |       |
      | home\_address.country   |       |
      | date\_of\_birth         |       |
      | start\_date             |       |
      | legal\_entity\_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 |
    | --------------- | ----- |
    | OAuth           |       |
    | API Passthrough |       |
    | Group Types     |       |
    | DEPARTMENT      |       |
  </Tab>

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

      * Legal Entities

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

    <ResponseField name="first_name" type="text" required>**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="middle_initial" type="text">**Middle Initial**</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="email" type="text" required>**Private Email**<br />
    The private email address of the employee<br />
    Unified field: `private_email`</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="self_onboarding" type="checkbox">**Self Onboarding**<br />
    If true, employee is expected to self-onboard. If false, payroll admin will enter onboarding information.</ResponseField>
    <ResponseField name="ssn" type="text">**SSN**</ResponseField>
    <ResponseField name="date_of_birth" type="date">**Date of Birth**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="company_id" type="single_select" required>**Legal Entity ID**<br />
    The Kombo ID of the legal entity the employee should be in<br />
    Unified field: `legal_entity_id`<br />
    References `/v1/hris/legal-entities?remote_model=legal_entity`</ResponseField>
  </Tab>
</Tabs>
