youforce.
Guides and Resources
Connection Setup Guide
Step-by-step instructions to connect your Visma Raet - Youforce account to Kombo.
Supported Features & Coverage
- Models
- Actions
- Features
- Create Employee with Form
Work Locations
Work Locations
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| address |
Employees
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 |
Employments
Employments
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| employee_id | |
| job_title | |
| employment_type | |
| effective_date | |
| custom_fields | |
| integration_fields |
Groups
Groups
| Field | Notes |
|---|---|
| id | |
| remote_id | |
| changed_at | |
| remote_deleted_at | |
| name | |
| type | |
| parent_id |
Employee <> Group
Employee <> Group
| Field | Notes |
|---|---|
| employee_id | |
| team_id | |
| id | |
| changed_at | |
| remote_deleted_at |
Create employee (v2)
Create employee (v2)
For detailed information about creating employees with form, please see the Create Employee with Form tab above.
| Input Field | Notes |
|---|---|
| staffing_entity_id | |
| properties |
| Feature | Notes |
|---|---|
| API Passthrough | |
| Scope Testing | |
| Custom Field Explorer | |
| Employees | |
| Employments | |
| Connection Guide | |
| Create credentials |
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.
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.
text
Workflow Name
Optional override for the HSS workflow to start, sent as
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.text
required
Last Name
The last name of the employee
Unified field:
The last name of the employee
Unified field:
last_nametext
Last Name at Birth Prefix
Optional Dutch tussenvoegsel for the birth name (e.g.
Optional Dutch tussenvoegsel for the birth name (e.g.
de, van der).text
required
First Name
The name the person is commonly known by.
Unified field:
The name the person is commonly known by.
Unified field:
first_nametext
required
Initials
text
First Names
single_select
Gender
When omitted, Youforce defaults to
Unified field:
When omitted, Youforce defaults to
Unknown.Unified field:
genderdate
required
Date of Birth
The employee’s date of birth
Unified field:
The employee’s date of birth
Unified field:
date_of_birthtext
Birth Place
text
Birth Country
text
Title Prefix
Title shown before the name.
Title shown before the name.
text
Title Suffix
Title shown after the name.
Title shown after the name.
text
Marital Status
text
Last Name Preference
Youforce code controlling how the displayed last name is composed from the birth and partner names (e.g.
Youforce code controlling how the displayed last name is composed from the birth and partner names (e.g.
E for the birth name).text
Partner’s Last Name
text
Partner’s Last Name Prefix
Optional Dutch tussenvoegsel for the partner name.
Optional Dutch tussenvoegsel for the partner name.
text
Social Security Number
Dutch BSN/Sofi number.
Dutch BSN/Sofi number.
text
required
Private Email
Personal email address used for self-service onboarding.
Unified field:
Personal email address used for self-service onboarding.
Unified field:
private_emailobject
Addresses
Show properties
Show properties
object
object
required
Employment Details
Show properties
Show properties
date
required
Start Date
Start date of the employee. Also considered to be the hire date
Unified field:
Start date of the employee. Also considered to be the hire date
Unified field:
start_datedate
Original Hire Date
Used for CAO seniority calculations.
Used for CAO seniority calculations.
date
End Date
single_select
required
Employee Type
text
Contract Type
Code indicating whether the contract is for a (in)definite period.
Code indicating whether the contract is for a (in)definite period.
date
Probation Period End Date
single_select
required
Organization Unit
single_select
required
Job Profile
number
Hours per Week
number
Part-time Percentage
text
Payroll Client Code
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.
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.
text
Payroll Institution Code
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.
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.
object
array
Assignments (Inzet)
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.
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.
array