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

# Paylocity HRIS Integration

> Paylocity connector for Kombo's HRIS API

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

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

## Guides and Resources

<CardGroup cols={2}>
  <Card title="Connection Setup Guide" icon="link" href="https://help.kombo.dev/hc/en-us/articles/26665234201617-Paylocity-How-do-I-link-my-account">
    Step-by-step instructions to connect your Paylocity 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                |       |
    </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 |       |
      | ssn                   |       |
      | gender                |       |
      | ethnicity             |       |
      | marital\_status       |       |
      | employment\_status    |       |
      | employment\_type      |       |
      | weekly\_hours         |       |
      | home\_address         |       |
      | bank\_accounts        |       |
      | date\_of\_birth       |       |
      | 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         |       |
      | pay\_frequency      |       |
      | employment\_type    |       |
      | 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                |       |
    </Accordion>

    <Accordion title="Timesheets">
      | Field                  | Notes |
      | ---------------------- | ----- |
      | id                     |       |
      | remote\_id             |       |
      | changed\_at            |       |
      | remote\_deleted\_at    |       |
      | employee\_id           |       |
      | started\_at            |       |
      | ended\_at              |       |
      | timezone               |       |
      | payable\_hours         |       |
      | unpaid\_break\_minutes |       |
      | breaks                 |       |
      | custom\_fields         |       |
      | integration\_fields    |       |
      | 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>
        Created Paylocity employees will enter the 'pre-hire' status and be deleted on the next sync. They will reappear after the onboarding process is completed. Valid phone format are: "(###) ###-####" or "###-###-####" or "### ### ####" or "##########" or, if international, starts with "+#", only spaces and digits allowed. Paylocity does not allow specifying the employee's country via API. It will always be set to "US".
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | home\_address.street\_1 |       |
      | home\_address.street\_2 |       |
      | home\_address.city      |       |
      | home\_address.state     |       |
      | home\_address.zip\_code |       |
      | date\_of\_birth         |       |
      | mobile\_phone\_number   |       |
      | start\_date             |       |
    </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      |       |
    | Create credentials    |       |
    | API Passthrough       |       |
    | Scope Testing         |       |
    | Per Model Tests       |       |
    | Per Field Tests       |       |
    | Group Types           |       |
    | COST\_CENTER          |       |
    | Custom Field Explorer |       |
    | Employees             |       |
  </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="companyId" type="single_select" required>**Legal Entity**<br />
    Select the legal entity to create the employee for.<br />
    References `/v1/hris/legal-entities?remote_model=legal_entity`</ResponseField>
    <ResponseField name="address1" type="text">**Address 1**<br />
    Employee home 1st address line.<br />
    Unified field: `home_address.street_1`</ResponseField>
    <ResponseField name="address2" type="text">**Address 2**<br />
    Employee home 2nd address line.<br />
    Unified field: `home_address.street_2`</ResponseField>
    <ResponseField name="autoPayType" type="single_select">**Auto Pay Type**<br />
    The type of auto pay for the employee.</ResponseField>
    <ResponseField name="baseRate" type="number">**Base Rate (hourly employees)**<br />
    Employee base rate, used for Hourly employees.</ResponseField>
    <ResponseField name="city" type="text">**City**<br />
    Employee home city.<br />
    Unified field: `home_address.city`</ResponseField>
    <ResponseField name="costCenter1" type="single_select">**Cost Center 1**<br />
    Employer defined location, like branch, division, department, etc.</ResponseField>
    <ResponseField name="costCenter2" type="single_select">**Cost Center 2**<br />
    Employer defined location, like branch, division, department, etc.</ResponseField>
    <ResponseField name="costCenter3" type="single_select">**Cost Center 3**<br />
    Employer defined location, like branch, division, department, etc.</ResponseField>
    <ResponseField name="defaultHours" type="number">**Default Hours**<br />
    Employee default hours consistently worked.</ResponseField>
    <ResponseField name="employeeStatus" type="single_select">**Employee Status**<br />
    Employee current work status.</ResponseField>
    <ResponseField name="employmentType" type="single_select">**Employment Type**<br />
    Employee employment type.</ResponseField>
    <ResponseField name="federalFilingStatus" type="single_select">**Federal Filing Status**<br />
    Employee federal filing status.</ResponseField>
    <ResponseField name="firstName" type="text" required>**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="sex" type="single_select">**Sex**<br />
    Employee gender.</ResponseField>
    <ResponseField name="hireDate" type="date">**Hire Date**<br />
    Employee hire date.<br />
    Unified field: `start_date`</ResponseField>
    <ResponseField name="homePhone" type="text">**Home Phone Number**<br />
    Employee home phone number.<br />
    Unified field: `home_phone_number`</ResponseField>
    <ResponseField name="lastName" type="text" required>**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="maritalStatus" type="single_select">**Marital Status**<br />
    Employee marital status.</ResponseField>
    <ResponseField name="personalMobilePhone" type="text">**Mobile Phone Number**<br />
    Employee personal mobile phone number.<br />
    Unified field: `mobile_phone_number`</ResponseField>
    <ResponseField name="payFrequency" type="single_select">**Pay Frequency**<br />
    Employee pay frequency.</ResponseField>
    <ResponseField name="personalEmailAddress" type="text">**Private Email**<br />
    Employee personal email address.<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="payType" type="single_select">**Pay Type**<br />
    Employee pay type.</ResponseField>
    <ResponseField name="ratePer" type="single_select">**Rate Per**<br />
    Employee base rate frequency (only used with payType Hourly).</ResponseField>
    <ResponseField name="salary" type="number">**Yearly Salary**<br />
    Employee yearly gross salary (only used with payType Salary).<br />
    Unified field: `yearly_salary`</ResponseField>
    <ResponseField name="state" type="single_select">**State**<br />
    Employee home state.<br />
    Unified field: `home_address.state`</ResponseField>
    <ResponseField name="ssn" type="text">**Social Security Number**<br />
    Employee social security number. Leave it blank if valid social security number not available.</ResponseField>
    <ResponseField name="stateFilingStatus" type="single_select">**State Filing Status**<br />
    Employee state filing status.</ResponseField>
    <ResponseField name="suiState" type="single_select">**SUI State**<br />
    Employee SUI (State Unemployment Insurance) state.</ResponseField>
    <ResponseField name="taxForm" type="single_select">**Tax Form**<br />
    Employee tax form for reporting income.</ResponseField>
    <ResponseField name="taxState" type="single_select">**Tax State**<br />
    Employee tax state.</ResponseField>
    <ResponseField name="userName" type="text" required>**User Name**<br />
    Employer assigned username to log into Onboarding. Duplicate usernames are not allowed. The username cannot have special characters other than . (period) and \_ (underscore)</ResponseField>
    <ResponseField name="workEmailAddress" type="text">**Work Email Address**<br />
    Employee work email address.<br />
    Unified field: `work_email`</ResponseField>
    <ResponseField name="zip" type="text">**Zip**<br />
    Employee home zip code.<br />
    Unified field: `home_address.zip_code`</ResponseField>
  </Tab>
</Tabs>

## Integration Variants

**Current connector:** Paylocity

For **Paylocity**, we also offer the following other connector variants:

<CardGroup cols={2}>
  <Card title="Paylocity ATS" icon="https://storage.googleapis.com/kombo-assets/integrations/paylocity/icon.svg" href="/ats/connectors/paylocity">
    Paylocity for the ATS category
  </Card>
</CardGroup>