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

# Planday HRIS Integration

> Planday connector for Kombo's HRIS API

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

## Guides and Resources

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

  <Card title="Sandbox Environment" icon="flask" href="https://www.planday.com/signup/">
    Access the Planday sandbox environment for testing and development.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <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       |       |
      | mobile\_phone\_number |       |
      | ssn                   |       |
      | gender                |       |
      | employment\_type      |       |
      | 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="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
    </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>
        Planday requires a department to be assigned when creating employees. Please provide it via the `department_remote_id` field of the `remote_fields`. The `work_email` field is required for creating employees in Planday.
      </Note>

      | Input Field             | Notes |
      | ----------------------- | ----- |
      | first\_name             |       |
      | last\_name              |       |
      | work\_email             |       |
      | gender                  |       |
      | job\_title              |       |
      | home\_address.street\_1 |       |
      | home\_address.street\_2 |       |
      | home\_address.city      |       |
      | 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 |       |
    | Prerequisites    |       |
    | 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

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

      * Groups

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

    <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="ssn" type="text">**Ssn**</ResponseField>
    <ResponseField name="zip" type="text">**Zip**<br />
    The ZIP code of the employee<br />
    Unified field: `home_address.zip_code`</ResponseField>
    <ResponseField name="city" type="text">**City**<br />
    The city of the employee<br />
    Unified field: `home_address.city`</ResponseField>
    <ResponseField name="email" type="text">**Email**</ResponseField>
    <ResponseField name="phone" type="text">**Phone**</ResponseField>
    <ResponseField name="phoneCountryCode" type="single_select">**Phone Country Code**</ResponseField>
    <ResponseField name="street1" type="text">**Street1**<br />
    The street address of the employee<br />
    Unified field: `home_address.street_1`</ResponseField>
    <ResponseField name="street2" type="text">**Street2**<br />
    The street address of the employee<br />
    Unified field: `home_address.street_2`</ResponseField>
    <ResponseField name="userName" type="text" required>**User Name**<br />
    The private email address of the employee<br />
    Unified field: `private_email`</ResponseField>
    <ResponseField name="departments" type="multi_select" required>**Departments**<br />
    List of Departments associated with the employee</ResponseField>
    <ResponseField name="employeeGroups" type="multi_select">**Employee Groups**</ResponseField>
    <ResponseField name="hiredFrom" type="date">**Hired From**</ResponseField>
    <ResponseField name="birthDate" type="date">**Birth Date**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="gender" type="single_select" required>**Gender**<br />
    The gender of the employee<br />
    Unified field: `gender`</ResponseField>
    <ResponseField name="cellPhone" type="text">**Cell Phone**<br />
    The mobile phone number of the employee<br />
    Unified field: `mobile_phone_number`</ResponseField>
    <ResponseField name="cellPhoneCountryCode" type="single_select">**Cell Phone Country Code**</ResponseField>
    <ResponseField name="salaryIdentifier" type="text">**Salary Identifier**</ResponseField>
    <ResponseField name="jobTitle" type="text">**Job Title**</ResponseField>
    <ResponseField name="employeeTypeId" type="single_select">**Employee Type Id**</ResponseField>
    <ResponseField name="primaryDepartmentId" type="single_select">**Primary Department Id**<br />
    Primary department for the employee<br />
    References `/v1/hris/groups?types=DEPARTMENT`</ResponseField>
    <ResponseField name="custom_33545" type="checkbox">**Use tax main card**</ResponseField>

    <ResponseField name="bankAccount" type="object">
      **Bank Account**

      <Expandable title="properties">
        <ResponseField name="accountNumber" type="text">**Account Number**</ResponseField>
        <ResponseField name="registrationNumber" type="text">**Registration Number**</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>