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

# SD Worx HRIS Integration

> SD Worx connector for Kombo's HRIS API

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

## Guides and Resources

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

  <Card title="How to find your standard employees" icon="book" href="https://help.kombo.dev/hc/en-us/articles/35481610928785-SD-Worx-How-do-I-find-the-Standard-Employees-Default-Persons">
    Additional documentation and guides for SD Worx.
  </Card>
</CardGroup>

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Legal Entities">
      <Note>
        SD Worx differentiates between companies and organizations. This integration only maps companies and does not interact with organizations in any way. If you need to access organization data, please contact the support team.
      </Note>

      | 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            |                                                                                                                                                                                                                                                       |
      | nationality           |                                                                                                                                                                                                                                                       |
      | display\_full\_name   |                                                                                                                                                                                                                                                       |
      | job\_title            |                                                                                                                                                                                                                                                       |
      | work\_email           | SD Worx provides a list of email addresses for each employee, but does not provide a way to distinguish between personal and work email addresses. We only use the first one.                                                                         |
      | mobile\_phone\_number | SD Worx provides a list of phone numbers for each employee, but we only use the first one.                                                                                                                                                            |
      | ssn                   | SD Worx provides a citizen service number for each employee, which can be roughly mapped to social security number or tax id.                                                                                                                         |
      | tax\_id               | SD Worx provides a citizen service number for each employee, which can be roughly mapped to social security number or tax id.                                                                                                                         |
      | gender                |                                                                                                                                                                                                                                                       |
      | marital\_status       |                                                                                                                                                                                                                                                       |
      | employment\_status    | SD Worx does not provide a uniform way to query employment status. This integration assumes that all employees that are not currently employed are INACTIVE.                                                                                          |
      | employment\_type      | SD Worx does not provide a uniform employment type. All employees in a fixed working contract with more than 32 hours per week are considered FULL\_TIME. All employees with a contract with a defined duration are considered as CONTRACT employees. |
      | weekly\_hours         |                                                                                                                                                                                                                                                       |
      | work\_location\_id    |                                                                                                                                                                                                                                                       |
      | legal\_entity\_id     |                                                                                                                                                                                                                                                       |
      | manager\_id           |                                                                                                                                                                                                                                                       |
      | home\_address         |                                                                                                                                                                                                                                                       |
      | bank\_accounts        |                                                                                                                                                                                                                                                       |
      | date\_of\_birth       |                                                                                                                                                                                                                                                       |
      | start\_date           |                                                                                                                                                                                                                                                       |
      | termination\_date     |                                                                                                                                                                                                                                                       |
      | custom\_fields        |                                                                                                                                                                                                                                                       |
      | integration\_fields   |                                                                                                                                                                                                                                                       |
      | remote\_data          |                                                                                                                                                                                                                                                       |
    </Accordion>

    <Accordion title="Employments">
      | Field               | Notes                                                                                                                                                                                                                                                          |
      | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
      | id                  |                                                                                                                                                                                                                                                                |
      | remote\_id          | Our system uses SD Worx' employment history resource to generate employments. As this is generated on the fly by SD Worx, the remote\_id is not stable and can change between runs. We use a compound key to ensure that the employment is upserted correctly. |
      | changed\_at         |                                                                                                                                                                                                                                                                |
      | remote\_deleted\_at |                                                                                                                                                                                                                                                                |
      | employee\_id        |                                                                                                                                                                                                                                                                |
      | job\_title          |                                                                                                                                                                                                                                                                |
      | pay\_rate           |                                                                                                                                                                                                                                                                |
      | pay\_period         |                                                                                                                                                                                                                                                                |
      | employment\_type    | SD Worx does not provide a uniform employment type. All employees in a fixed working contract with more than 32 hours per week are considered FULL\_TIME. All employees with a contract with a defined duration are considered as CONTRACT employees.          |
      | pay\_currency       | SD Worx does not provide a pay currency for employees. EUR is assumed for all employees                                                                                                                                                                        |
      | effective\_date     |                                                                                                                                                                                                                                                                |
    </Accordion>

    <Accordion title="Groups">
      <Note>
        SD Worx' Group resource is mapped as Kombo Teams SD Worx does not support getting cost centers without having access to companies. The legal entities scope must therefore be enabled to sync cost centers.
      </Note>

      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee Document Categories">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | remote\_data        |       |
    </Accordion>

    <Accordion title="Employee <> Group">
      <Note>
        SD Worx provides employee group associations through CurrentEmployment.DepartmentId, CurrentEmployment.CostCenterId, and ParticipantInGroups. Note that ParticipantInGroups requires additional permissions (GroupParticipant GET) and may not be available in all accounts.
      </Note>

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

    <Accordion title="Add document to employee">
      | Input Field        | Notes |
      | ------------------ | ----- |
      | employee\_id       |       |
      | category\_id       |       |
      | document.name      |       |
      | document.data\_url |       |
      | document.data      |       |
    </Accordion>
  </Tab>

  <Tab title="Features">
    | Feature          | Notes |
    | ---------------- | ----- |
    | Connection Guide |       |
    | API Passthrough  |       |
    | Scope Testing    |       |
    | Per Model Tests  |       |
    | Group Types      |       |
    | TEAM             |       |
    | DEPARTMENT       |       |
    | COST\_CENTER     |       |
  </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:

      * Legal Entities

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

    <ResponseField name="StartDate" 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="OrganizationId" type="single_select" required>**Organization**</ResponseField>
    <ResponseField name="PersonNumber" type="text">**Person Number**<br />
    The person number of the employee.</ResponseField>
    <ResponseField name="CitizenServiceNumber" type="text">**Citizen Service Number**<br />
    The citizen service number of the employee. Use 0 to apply the next available number</ResponseField>
    <ResponseField name="Initials" type="text">The initials of the employee.</ResponseField>
    <ResponseField name="Prefixes" type="text">The prefixes of the employee.</ResponseField>
    <ResponseField name="Lastname" type="text">**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="Names" type="text">**First Name**<br />
    The first name of the employee<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="Nickname" type="text">The nickname of the employee.</ResponseField>

    <ResponseField name="Gender" type="single_select" />

    <ResponseField name="DateOfBirth" type="date">**Date of Birth**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="Email" type="text" required>**Work Email**<br />
    The email address of the employee<br />
    Unified field: `work_email`</ResponseField>
    <ResponseField name="DepartmentId" type="single_select" required>**Department**<br />
    References `/v1/hris/groups?types=DEPARTMENT`</ResponseField>
    <ResponseField name="FunctionId" type="single_select" required>**Function**</ResponseField>
    <ResponseField name="DefaultPerson" type="number" required>**Standard Employee**<br />
    The number of the standard employee to use in SD Worx' New Person workflow. You can find this in the 'Manage default person' task of the organization you want to create the employee in. Take a look at the guide here [https://help.kombo.dev/hc/en-us/articles/35481610928785-SD-Worx-How-do-I-find-the-Standard-Employees-Default-Persons](https://help.kombo.dev/hc/en-us/articles/35481610928785-SD-Worx-How-do-I-find-the-Standard-Employees-Default-Persons)</ResponseField>
    <ResponseField name="CompanyId" type="single_select">**Company**<br />
    References `/v1/hris/legal-entities?remote_model=legal_entity`</ResponseField>
  </Tab>
</Tabs>