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

# Visma Raet - Youforce HRIS Integration

> Visma Raet - Youforce connector for Kombo's HRIS API

The Visma Raet - Youforce HRIS integration allows you to sync HRIS data between Visma Raet - Youforce and your application through Kombo's unified API. The tool slug for this connector is `youforce`.

## Guides and Resources

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

## Supported Features & Coverage

<Tabs>
  <Tab title="Models">
    <Accordion title="Work Locations">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | address             |       |
    </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      |       |
      | weekly\_hours         |       |
      | work\_location\_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          |       |
      | employment\_type    |       |
      | effective\_date     |       |
      | remote\_data        |       |
      | custom\_fields      |       |
      | integration\_fields |       |
    </Accordion>

    <Accordion title="Groups">
      | Field               | Notes |
      | ------------------- | ----- |
      | id                  |       |
      | remote\_id          |       |
      | changed\_at         |       |
      | remote\_deleted\_at |       |
      | name                |       |
      | type                |       |
      | parent\_id          |       |
    </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      |       |
  </Tab>

  <Tab title="Create Employee with Form">
    <Note>
      Youforce creates hires through an asynchronous HSS workflow. Kombo waits for that workflow and surfaces any validation error it reports, but the new employee only appears in Kombo on a later sync, once Youforce has finished processing it.
    </Note>

    <Note>
      Hires run through an HSS workflow that must be configured on the customer's Youforce tenant. The workflow that runs — and which fields it treats as mandatory (e.g. some require payroll client/institution codes) — depends on that tenant's setup.
    </Note>

    <ResponseField name="workflowName" type="text">**Workflow Name**<br />
    Optional override for the HSS workflow to start, sent as `X-Raet-Workflow`. Must exactly match a workflow name configured on the customer's Youforce tenant (case-sensitive). When omitted, Youforce starts the default workflow configured for this endpoint.</ResponseField>
    <ResponseField name="lastNameAtBirth" type="text" required>**Last Name**<br />
    The last name of the employee<br />
    Unified field: `last_name`</ResponseField>
    <ResponseField name="lastNameAtPrefix" type="text">**Last Name at Birth Prefix**<br />
    Optional Dutch tussenvoegsel for the birth name (e.g. `de`, `van der`).</ResponseField>
    <ResponseField name="knownAs" type="text" required>**First Name**<br />
    The name the person is commonly known by.<br />
    Unified field: `first_name`</ResponseField>
    <ResponseField name="initials" type="text" required>**Initials**</ResponseField>
    <ResponseField name="firstNames" type="text">**First Names**</ResponseField>
    <ResponseField name="gender" type="single_select">**Gender**<br />
    When omitted, Youforce defaults to `Unknown`.<br />
    Unified field: `gender`</ResponseField>
    <ResponseField name="birthDate" type="date" required>**Date of Birth**<br />
    The employee's date of birth<br />
    Unified field: `date_of_birth`</ResponseField>
    <ResponseField name="birthPlace" type="text">**Birth Place**</ResponseField>
    <ResponseField name="birthCountry" type="text">**Birth Country**</ResponseField>
    <ResponseField name="titlePrefix" type="text">**Title Prefix**<br />
    Title shown before the name.</ResponseField>
    <ResponseField name="titleSuffix" type="text">**Title Suffix**<br />
    Title shown after the name.</ResponseField>
    <ResponseField name="maritalStatus" type="text">**Marital Status**</ResponseField>
    <ResponseField name="lastNamePreference" type="text">**Last Name Preference**<br />
    Youforce code controlling how the displayed last name is composed from the birth and partner names (e.g. `E` for the birth name).</ResponseField>
    <ResponseField name="lastNamePartner" type="text">**Partner's Last Name**</ResponseField>
    <ResponseField name="partnerNamePrefix" type="text">**Partner's Last Name Prefix**<br />
    Optional Dutch tussenvoegsel for the partner name.</ResponseField>
    <ResponseField name="socialSecurityNumber" type="text">**Social Security Number**<br />
    Dutch BSN/Sofi number.</ResponseField>
    <ResponseField name="emailAddress" type="text" required>**Private Email**<br />
    Personal email address used for self-service onboarding.<br />
    Unified field: `private_email`</ResponseField>

    <ResponseField name="phoneNumbers" type="object">
      **Phone Numbers**

      <Expandable title="properties">
        <ResponseField name="phoneNumberHome" type="text">**Home Phone Number**</ResponseField>
        <ResponseField name="phoneNumberMobile" type="text">**Mobile Phone Number**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="addresses" type="object">
      **Addresses**

      <Expandable title="properties">
        <ResponseField name="homeAddress" type="object">
          **Home Address**

          <Expandable title="properties">
            <ResponseField name="street" type="text">**Street**</ResponseField>
            <ResponseField name="number" type="number">**Number**</ResponseField>
            <ResponseField name="numberAdditional" type="text">**Number Addition**</ResponseField>
            <ResponseField name="postalCode" type="text">**Postal Code**</ResponseField>
            <ResponseField name="city" type="text">**City**</ResponseField>
            <ResponseField name="country" type="text">**Country**<br />
            ISO country code (e.g. `NL`).</ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="postalAddress" type="object">
          **Postal Address**<br />
          The employee's mailing address, when it differs from the home address.

          <Expandable title="properties">
            <ResponseField name="street" type="text">**Street**</ResponseField>
            <ResponseField name="number" type="number">**Number**</ResponseField>
            <ResponseField name="numberAdditional" type="text">**Number Addition**</ResponseField>
            <ResponseField name="postalCode" type="text">**Postal Code**</ResponseField>
            <ResponseField name="city" type="text">**City**</ResponseField>
            <ResponseField name="country" type="text">**Country**<br />
            ISO country code (e.g. `NL`).</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="employmentDetails" type="object" required>
      **Employment Details**

      <Expandable title="properties">
        <ResponseField name="hireDate" 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="originalHireDate" type="date">**Original Hire Date**<br />
        Used for CAO seniority calculations.</ResponseField>
        <ResponseField name="endDate" type="date">**End Date**</ResponseField>
        <ResponseField name="employeeType" type="single_select" required>**Employee Type**</ResponseField>
        <ResponseField name="contractType" type="text">**Contract Type**<br />
        Code indicating whether the contract is for a (in)definite period.</ResponseField>
        <ResponseField name="probationPeriodEnddate" type="date">**Probation Period End Date**</ResponseField>
        <ResponseField name="organizationUnit" type="single_select" required>**Organization Unit**</ResponseField>
        <ResponseField name="jobProfile" type="single_select" required>**Job Profile**</ResponseField>
        <ResponseField name="amountOfHours" type="number">**Hours per Week**</ResponseField>
        <ResponseField name="parttimePercentage" type="number">**Part-time Percentage**</ResponseField>
        <ResponseField name="payrollClientCode" type="text">**Payroll Client Code**<br />
        The payroll client (Opdrachtgever) code configured by the customer's Visma Raet consultant on their Youforce tenant. Whether this field is mandatory depends on the HSS workflow that handles the request – check with the customer's consultant if unsure.</ResponseField>
        <ResponseField name="payrollInstitutionCode" type="text">**Payroll Institution Code**<br />
        The payroll company (Instelling) code configured by the customer's Visma Raet consultant on their Youforce tenant. Whether this field is mandatory depends on the HSS workflow that handles the request – check with the customer's consultant if unsure.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="salaryDetails" type="object">
      **Salary Details**

      <Expandable title="properties">
        <ResponseField name="salary" type="number">**Salary**</ResponseField>
        <ResponseField name="hourlyRate" type="number">**Hourly Rate**</ResponseField>
        <ResponseField name="payScale" type="text">**Pay Scale**</ResponseField>
        <ResponseField name="payScaleStep" type="text">**Pay Scale Step**</ResponseField>
        <ResponseField name="payScaleAmountNo" type="number">**Pay Scale Amount Number**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="assignments" type="array">
      **Assignments (Inzet)**<br />
      Optional secondary deployments to other organization units. Requires a workflow configured with assignment support on the customer's tenant (e.g. "YF API - Nieuwe Medewerker (incl inzet)") – set "Workflow Name" accordingly.

      <Expandable title="items">
        <ResponseField name="startDate" type="date">**Start Date**</ResponseField>
        <ResponseField name="endDate" type="date">**End Date**</ResponseField>
        <ResponseField name="assignmentType" type="text">**Assignment Type**</ResponseField>
        <ResponseField name="organizationUnit" type="single_select">**Organization Unit**</ResponseField>
        <ResponseField name="jobProfile" type="single_select">**Job Profile**</ResponseField>
        <ResponseField name="amountOfHours" type="number">**Hours per Week**</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="files" type="array">
      **Files**<br />
      Attachments forwarded with the HSS workflow, up to roughly 28 MB total per request.

      <Expandable title="items">
        <ResponseField name="file" type="file" required>**File**</ResponseField>
        <ResponseField name="category" type="text">**Category**<br />
        Optional category label shown alongside the file in the HSS workflow.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="customFields" type="array">
      **Custom Fields**

      <Expandable title="items">
        <ResponseField name="fieldCode" type="text" required>**Field Code**<br />
        Native Youforce field code, e.g. `P00390`.</ResponseField>
        <ResponseField name="fieldValue" type="text" required>**Field Value**<br />
        String-encoded value for this field.</ResponseField>
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>
