General
- Introduction
- Getting started
- Implementation guide
- FAQ
Features
Guides
HRIS API Reference
- Employees
- Organization
- Employee Documents
- Time off
- Time and attendance
General API Reference
- Kombo Connect
- Integrations
- Filtering
- Custom Fields
- Other
DATEV
- Getting Started
- DATEV Payroll
- DATEV Documents ( Payslips )
- DATEV eAU
- DATEV ( legacy )
Create employee
Create a new employee.
Create an API key on the Secrets page in the Kombo dashboard.
ID of the integration you want to interact with.
The first name of the employee.
The last name of the employee.
The email address of the employee to be created. For tools where the personal email address is required, we map this input to the personal email. This is documented on a per-tool basis.
The gender of the employee.
The title of the position this person is working in.
The employee's home address.
The uppercase two-letter ISO country (e.g., DE). For systems that use codes in formats other than ISO 3166-1 alpha-2, Kombo transforms the ISO Codes to the appropriate value.
The employee's date of birth. This is a plain date (i.e., yyyy-MM-dd), all time information is discarded.
The uppercase two-letter ISO country (e.g., DE). For systems that use codes in formats other than ISO 3166-1 alpha-2, Kombo transforms the ISO Codes to the appropriate value.
Start date of the employee. Also considered to be the hire date. This is a plain date (i.e., yyyy-MM-dd), all time information is discarded.
The Kombo ID of the legal entity the employee should be in. This field is required for certain integrations.
The Kombo ID of the location the employee should be in. This field is required for certain integrations.
Additional fields that we will pass through to specific HRIS systems.
Fields specific to Humaans.
Fields that we will pass through to Humaans Employee object.
Fields specific to Hibob.
Fields that we will pass through to Hibob's Person endpoint.
Fields specific to PeopleHR.
The effective date of the employee's current role. This is a plain date (i.e., yyyy-MM-dd), all time information is discarded.
Fields specific to Zoho People.
A personnel code used to identify individuals working for the business.
Fields specific to Workday.
Workday job requisition ID of that the employee belongs to.
The social security number of the employee.
The employee's bank account.
Fields specific to Deel.
The unique identifier of the candidate in the ATS.
The link to the candidate's profile in the ATS.
Fields specific to BambooHR.
Fields that we will pass through to BambooHR Employee object.
Fields specific to Oracle HCM.
The business unit group ID for which the employee should be created. It can be found as a group with the type null.
The department group ID for which the employee should be created. It can be found as a group with thre type "DEPARTMENT".
Fields specific to Oracle HCM.
The onboarding template to be used for the created employee. View the possible values in the Kombo dashboard by clicking on the ADP Workforce Now integration and viewing the field report in the settings tab.
The payroll group code (a.k.a. "Company Code") to be used for the created employee. View the possible values in the Kombo dashboard by clicking on the ADP Workforce Now integration and viewing the field report in the settings tab.
Fields specific to Oracle HCM.
Azure / entra requires a password to be set when creating a user. The user has to use the password on his initial sign-in and will be forced to change the password once signed in.
{
"status": "success",
"data": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"employee_number": "3243422",
"first_name": "John",
"last_name": "Doe",
"nationality": "French",
"display_full_name": "John Doe",
"job_title": "Integrations Team Lead",
"work_email": "john.doe@acme.com",
"personal_email": "john@doe.me",
"mobile_phone_number": "801-555-4687",
"ssn": "555-32-6395",
"tax_id": "12 345 678 901",
"gender": "MALE",
"ethnicity": "BLACK_AFRICAN_AMERICAN",
"marital_status": "MARRIED",
"employment_status": "INACTIVE",
"employment_type": "FULL_TIME",
"weekly_hours": 40,
"avatar": "https://resources.bamboohr.com/images/photo_person_150x150.png",
"work_location_id": "7E2gyuv6TmvtByzBxW9Sxt53",
"legal_entity_id": "xB32bied320csBSsl3XWdlw33",
"manager_id": "9pf2pxBB8VX8EQMC9aipW2Bo",
"home_address": {
"city": "Berlin",
"country": "DE",
"raw": "Sonnenallee 63\n12045 Berlin\nGermany",
"state": "Berlin",
"street_1": "Sonnenallee 63",
"street_2": null,
"zip_code": "12045"
},
"bank_accounts": [
{
"account_number": "1234567890",
"bank_name": "Commerzbank",
"bic": "COBADEFFXXX",
"domestic_bank_routing": {
"number": "34567890",
"type": "DE_BANKLEITZAHL"
},
"holder_name": "John Doe",
"iban": "DE12345678901234567890"
}
],
"date_of_birth": "1986-01-01T00:00:00.000Z",
"start_date": "2020-04-07T00:00:00.000Z",
"termination_date": "2022-05-20T00:00:00.000Z",
"remote_created_at": "2020-04-07T12:32:01.000Z",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"custom_fields": {},
"integration_fields": [],
"remote_data": null
}
}This feature is currently available for the following integrations:
Personio
Workday
SAP SuccessFactors
Factorial
UKG Pro
ADP Workforce Now
BambooHR
HiBob
Cezanne HR
Microsoft Entra ID
Microsoft Azure AD
Google Workspace
Nmbrs
Deel
Remote
Okta
Sage HR
Humaans
Oracle HCM
Zoho People
Gusto
Breathe HR
AlexisHR
Paylocity
Rippling
Kallidus (Sapling)
PeopleHR
Cornerstone OnDemand
Square
Leapsome
Kombo Sandbox
You’d like to see this feature for another integration? Please reach out! We’re always happy to discuss extending our coverage.
This endpoint requires the permission Create and manage employees to be enabled in your scope config.
Example Request Body
{
"first_name": "John",
"last_name": "Doe",
"work_email": "john.doe@acme.com",
"gender": "MALE",
"date_of_birth": "1986-01-01",
"start_date": "2020-04-07",
"job_title": "Integrations Team Lead",
"home_address": {
"city": "Berlin",
"country": "DE",
"state": "Berlin",
"street_1": "Sonnenallee 63",
"zip_code": "12045"
}
}
Authorizations
Headers
ID of the integration you want to interact with.
Body
The first name of the employee.
The last name of the employee.
The email address of the employee to be created. For tools where the personal email address is required, we map this input to the personal email. This is documented on a per-tool basis.
The gender of the employee.
MALE, FEMALE, NON_BINARY, NOT_SPECIFIED The title of the position this person is working in.
The employee's home address.
The uppercase two-letter ISO country (e.g., DE). For systems that use codes in formats other than ISO 3166-1 alpha-2, Kombo transforms the ISO Codes to the appropriate value.
The employee's date of birth. This is a plain date (i.e., yyyy-MM-dd), all time information is discarded.
The uppercase two-letter ISO country (e.g., DE). For systems that use codes in formats other than ISO 3166-1 alpha-2, Kombo transforms the ISO Codes to the appropriate value.
Start date of the employee. Also considered to be the hire date. This is a plain date (i.e., yyyy-MM-dd), all time information is discarded.
The Kombo ID of the legal entity the employee should be in. This field is required for certain integrations.
The Kombo ID of the location the employee should be in. This field is required for certain integrations.
Additional fields that we will pass through to specific HRIS systems.
Fields specific to Zoho People.
A personnel code used to identify individuals working for the business.
1Fields specific to Workday.
Workday job requisition ID of that the employee belongs to.
The social security number of the employee.
Fields specific to Oracle HCM.
The business unit group ID for which the employee should be created. It can be found as a group with the type null.
The department group ID for which the employee should be created. It can be found as a group with thre type "DEPARTMENT".
Fields specific to Oracle HCM.
The onboarding template to be used for the created employee. View the possible values in the Kombo dashboard by clicking on the ADP Workforce Now integration and viewing the field report in the settings tab.
The payroll group code (a.k.a. "Company Code") to be used for the created employee. View the possible values in the Kombo dashboard by clicking on the ADP Workforce Now integration and viewing the field report in the settings tab.
Response
success The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.
The employee’s organization-internal employee number.
The employee’s first name.
The employee’s last name.
The employee’s nationality.
The employee’s full name, including any middle names. Not all HR systems provide an explicit display name, so we recommend falling back to first_name and last_name.
The employee’s job title.
The employee’s work email address. If the email address is invalid, we will set this to null.
The employee’s personal email address. If the email address is invalid, we will set this to null.
The employee’s mobile phone number.
The employee’s social security number
The employee’s tax ID.
The employee’s gender.
MALE, FEMALE, NON_BINARY, NOT_SPECIFIED The employee’s ethnicity. In rare cases where we can’t find a clear mapping, the original string is passed through.
WHITE, ASIAN, HISPANIC_LATINO, HAWAIIAN, NATIVE_AMERICAN, BLACK_AFRICAN_AMERICAN, MULTIPLE_ETHNICITIES, DECLINE_TO_SPECIFY The employee’s current marital status. In rare cases where we can’t find a clear mapping, the original string is passed through.
SINGLE, MARRIED, DOMESTIC_PARTNERSHIP, WIDOWED, DIVORCED, SEPARATED, NOT_MARRIED The employee’s current employment status:
ACTIVE: the employee is actively employedPENDING: the employee is not actively employed yet (but they signed their contract or are part of an onboarding process)INACTIVE: the employee is not actively employed anymoreLEAVE: the employee is still employed but currently on leave (note that not all HR systems support this status — use our absences API for detailed information)
In rare cases where we can’t find a clear mapping, the original string is passed through.
ACTIVE, PENDING, INACTIVE, LEAVE The employee’s current employment type:
FULL_TIME: the employee is actively employedPART_TIME: the employee is working only part of the usual working hoursCONTRACT: the employee is working temporarily under a contractINTERNSHIP: the employee is working as an internFREELANCE: the employee is working as a freelancerWORKING_STUDENT: the employee is working as a working studentAPPRENTICESHIP: the employee is working in an apprenticeshipTRAINING: the employee is working in a training program
In rare cases where we can’t find a clear mapping, the original string is passed through.
FULL_TIME, PART_TIME, CONTRACT, INTERNSHIP, FREELANCE, WORKING_STUDENT, APPRENTICESHIP, TRAINING The employee’s weekly working hours.
URL to the employee’s avatar. This is either the raw URL from the HR system (in cases where it can be requested without short-lived authentication) or a URL to a temporarily cached version of the file hosted by Kombo. Kombo will delete the cached file after its deletion in the source system.
The Kombo ID of the employee’s work location. The ID can be used to retrieve the work location from the get work locations endpoint.
The Kombo ID of the employee’s legal entity. The ID can be used to retrieve the legal entity from the get legal entities endpoint.
The Kombo ID of the employee’s manager. The ID can be used to retrieve the manager from the get employees endpoint.
The employee’s home address.
Contains the ISO2 country code if possible. If not, it contains the original value.
If we have address data, this is filled with the raw address string.
If we can parse the address data, this field contains the first part of the street information.
The employee’s bank accounts.
The internationally unique IBAN identifying this account. If we detect a valid IBAN from the account number and this field would otherwise be empty, we will automatically populate this field.
The internationally unique BIC/SWIFT code identifying the bank behind this account. If we detect a valid BIC from the domestic bank routing number and this field would otherwise be empty, we will automatically populate this field.
The bank-specific account number. Some companies use the account number field to put the IBAN here.
The name of the holder of this account.
The name of the bank behind this account.
Bank routing number (e.g. DE Bankleitzahl, GB Sort Code, US ABA routing number, AU BSB code). This field is not formatted and therefore might contain delimiters (eg. 01-23-45).
Enum of the routing type, prefixed with the iso-3166-1-alpha-2 banks origin country. If there is uncertainty about the type, it will be set to null.
GB_SORT_CODE, DE_BANKLEITZAHL, US_ABA_ROUTING_TRANSIT_NUMBER, CA_ROUTING_NUMBER, AU_BSB_CODE, FR_RIB The employee’s date of birth.
The date the employee started working for the organization.
The date when the employment ends. Can be in the past or future.
The date and time the object was created in the remote system.
The timestamp when this object was last changed. This value is tracked by Kombo based on changes in the data.
The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear.
An array of selected pass-through integration fields. Read more
The globally unique ID of this object.
The key of the field in the remote system.
DEFAULT: static fields in the remote system.CUSTOM: fields that are created/editable by the user.
DEFAULT, CUSTOM The field's value.
The label of the field. (not always available)
Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set.
Remote data always has the endpoint path that we got the data from as the
top level key. For example, it could look like: { "/companies": { ... }}
This is not available on all plans. Reach out to Kombo if you need it.
{
"status": "success",
"data": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"employee_number": "3243422",
"first_name": "John",
"last_name": "Doe",
"nationality": "French",
"display_full_name": "John Doe",
"job_title": "Integrations Team Lead",
"work_email": "john.doe@acme.com",
"personal_email": "john@doe.me",
"mobile_phone_number": "801-555-4687",
"ssn": "555-32-6395",
"tax_id": "12 345 678 901",
"gender": "MALE",
"ethnicity": "BLACK_AFRICAN_AMERICAN",
"marital_status": "MARRIED",
"employment_status": "INACTIVE",
"employment_type": "FULL_TIME",
"weekly_hours": 40,
"avatar": "https://resources.bamboohr.com/images/photo_person_150x150.png",
"work_location_id": "7E2gyuv6TmvtByzBxW9Sxt53",
"legal_entity_id": "xB32bied320csBSsl3XWdlw33",
"manager_id": "9pf2pxBB8VX8EQMC9aipW2Bo",
"home_address": {
"city": "Berlin",
"country": "DE",
"raw": "Sonnenallee 63\n12045 Berlin\nGermany",
"state": "Berlin",
"street_1": "Sonnenallee 63",
"street_2": null,
"zip_code": "12045"
},
"bank_accounts": [
{
"account_number": "1234567890",
"bank_name": "Commerzbank",
"bic": "COBADEFFXXX",
"domestic_bank_routing": {
"number": "34567890",
"type": "DE_BANKLEITZAHL"
},
"holder_name": "John Doe",
"iban": "DE12345678901234567890"
}
],
"date_of_birth": "1986-01-01T00:00:00.000Z",
"start_date": "2020-04-07T00:00:00.000Z",
"termination_date": "2022-05-20T00:00:00.000Z",
"remote_created_at": "2020-04-07T12:32:01.000Z",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"custom_fields": {},
"integration_fields": [],
"remote_data": null
}
}