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

# Paychex HRIS Integration

> Paychex connector for Kombo's HRIS API

<Note>This connector is in open beta. You can freely enable it in your account.</Note>

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

## Guides and Resources

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

## 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            |       |
      | display\_full\_name   |       |
      | job\_title            |       |
      | work\_email           |       |
      | personal\_email       |       |
      | mobile\_phone\_number |       |
      | gender                |       |
      | 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        |       |
      | pay\_rate           |       |
      | pay\_period         |       |
      | 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                |       |
      | parent\_id          |       |
      | 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 (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   |       |
    | Create credentials |       |
    | API Passthrough    |       |
    | Scope Testing      |       |
    | Per Model Tests    |       |
  </Tab>

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

      * Employees
      * Groups
      * Locations

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

    <ResponseField name="companyId" type="single_select" required>**Company**</ResponseField>
    <ResponseField name="employmentType" type="single_select">**Employment Type**</ResponseField>
    <ResponseField name="hireDate" type="date">**Start Date**<br />
    Start date of the employee. Also considered to be the hire date<br />
    Unified field: `start_date`</ResponseField>
    <ResponseField name="birthDate" type="date">**Date of Birth**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="exemptionType" type="single_select">**Exemption Type**</ResponseField>
    <ResponseField name="workerType" type="single_select" required>**Worker Type**</ResponseField>
    <ResponseField name="sex" type="single_select">**Gender**<br />
    The gender of the employee<br />
    Unified field: `gender`</ResponseField>
    <ResponseField name="employeeId" type="text">**Employee ID**</ResponseField>
    <ResponseField name="ethnicityCode" type="single_select">**Ethnicity**</ResponseField>

    <ResponseField name="name" type="object" required>
      **Name**

      <Expandable title="properties">
        <ResponseField name="givenName" type="text" required>**First Name**<br />
        The first name of the employee<br />
        Unified field: `first_name`</ResponseField>
        <ResponseField name="familyName" type="text" required>**Last Name**<br />
        The last name of the employee<br />
        Unified field: `last_name`</ResponseField>
        <ResponseField name="middleName" type="text">**Middle Name**</ResponseField>
        <ResponseField name="preferredName" type="text">**Preferred Name**</ResponseField>
        <ResponseField name="qualificationAffixCode" type="text">**Qualification Affix (e.g., Sr., Jr.)**</ResponseField>
        <ResponseField name="titleAffixCode" type="text">**Title Affix (e.g., Dr., Mr.)**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="legalId" type="object">
      **Legal ID**

      <Expandable title="properties">
        <ResponseField name="legalIdType" type="single_select">**Legal ID Type**</ResponseField>
        <ResponseField name="legalIdValue" type="text">**Legal ID Value**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="job" type="object">
      **Job Details**

      <Expandable title="properties">
        <ResponseField name="jobTitleId" type="single_select" required>**Job Title ID**</ResponseField>
        <ResponseField name="startDate" type="date">**Start Date**</ResponseField>
        <ResponseField name="endDate" type="date">**End Date**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="communications" type="object">
      **Communications**

      <Expandable title="properties">
        <ResponseField name="privateEmail" type="text">**Private Email**<br />
        The private email address of the employee<br />
        Unified field: `private_email`</ResponseField>
        <ResponseField name="workEmail" type="text">**Work Email**<br />
        The email address of the employee<br />
        Unified field: `work_email`</ResponseField>

        <ResponseField name="streetAddress" type="object">
          **Street Address**

          <Expandable title="properties">
            <ResponseField name="usageType" type="single_select">**Usage Type**</ResponseField>
            <ResponseField name="streetLineOne" type="text" required>**Street 1**<br />
            The street address of the employee<br />
            Unified field: `home_address.street_1`</ResponseField>
            <ResponseField name="streetLineTwo" type="text" required>**Street 2**<br />
            The street address of the employee<br />
            Unified field: `home_address.street_2`</ResponseField>
            <ResponseField name="city" type="text" required>**City**<br />
            The city of the employee<br />
            Unified field: `home_address.city`</ResponseField>
            <ResponseField name="postalCode" type="text" required>**ZIP Code**<br />
            The ZIP code of the employee<br />
            Unified field: `home_address.zip_code`</ResponseField>
            <ResponseField name="postalCodeExtension" type="text">**Postal Code Extension (for address type)**</ResponseField>
            <ResponseField name="countrySubdivisionCode" type="text">**State**<br />
            The state of the employee<br />
            Unified field: `home_address.state`</ResponseField>
            <ResponseField name="countryCode" type="single_select">**Country**<br />
            The uppercase two-letter ISO country code (e.g., DE).<br />
            Unified field: `home_address.country`</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="mobilePhone" type="object">
          **Mobile Phone**

          <Expandable title="properties">
            <ResponseField name="usageType" type="single_select">**Usage Type**</ResponseField>
            <ResponseField name="dialCountry" type="text">**Dial Country**<br />
            The country dialing code for a communication number.</ResponseField>
            <ResponseField name="dialArea" type="text">**Dial Area**<br />
            The area code for a communication number.</ResponseField>
            <ResponseField name="dialNumber" type="text">**Dial Number**<br />
            The communication number, not including country dialing or area dialing codes.</ResponseField>
            <ResponseField name="dialExtension" type="text">**Dial Extension**<br />
            The extension of the associated communication number.</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="clockId" type="text">**Clock ID**<br />
    The clock ID of the worker that can be an identification for other systems.</ResponseField>
    <ResponseField name="laborAssignmentId" type="text">**Labor Assignment ID**</ResponseField>

    <ResponseField name="location" type="object">
      **Location**

      <Expandable title="properties">
        <ResponseField name="locationId" type="single_select" required>**Location**<br />
        References `/v1/hris/locations?remote_model=location`</ResponseField>
        <ResponseField name="organization" type="single_select" required>**Organization**<br />
        References `/v1/hris/groups`</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="supervisor" type="single_select">**Supervisor**<br />
    References `/v1/hris/employees?remote_model=employee`</ResponseField>

    <ResponseField name="currentStatus" type="object">
      **Current Status**

      <Expandable title="properties">
        <ResponseField name="statusType" type="single_select">**Status Type**</ResponseField>
        <ResponseField name="statusReason" type="text">**Status Reason**</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>
