• The fields not supported by this API for Paycorare:

  • employment -> workShiftId

  • workAddress -> addressLine1, addressLine2, city, state, country, zipCode

  • presentAddress

• Hibob only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored
• workadress.id corresponds to the Work Site in Hibob. To get the list of Work Sites available in Hibob, refer to this example: https://developers.getknit.dev/docs/hibob#get-list-of-work-sites-from-hibob
• The fields not supported by this API for Hibob are:
  • employment -> workShiftId
  • workAddress -> addressLine1, addressLine2, city, state, country, zipCode
  • presentAddressFor more information and request examples, refer to https://developers.getknit.dev/docs/hibob#update-an-employee-details

• BambooHR only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored
• workadress.id corresponds to the Work Location in BambooHR. To get the list of Work Sites available in BambooHR, refer to this example: https://developers.getknit.dev/docs/getting-started-with-bamboohr-api#get-list-of-work-locations-from-bamboohr
• The fields not supported by this API for BambooHR are:
  • employment -> workShiftId
  • workAddress -> addressLine1, addressLine2, city, state, country, zipCodeFor more information and request examples, refer to https://developers.getknit.dev/docs/getting-started-with-bamboohr-api#update-an-employee-details-api-in-bamboohr

• The fields not supported by this API for Personio are:
  • employment -> workShiftId
  • workAddress->addressLine1, addressLine2, city, state, country, zipCode
  • workEmail
  • personalEmails
  • presentAddressFor more information and request examples, refer to: https://developers.getknit.dev/docs/getting-started-with-personio-hris-api#update-an-employee-in-personio-api

• Darwinbox only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored

  • The fields not supported by this API for Darwinbox are:

  • employment

  • workAddress

• Zoho People only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored

• The fields not supported by this API for Zoho People are:

  • employment -> workShiftId
  • workAddress
  • presentAddress

Supported Request Fields:

• employeeId - Required
• firstName
• lastName
• workEmail
• personalEmails
• presentAddress
• presentAddress.addressLine1
• presentAddress.addressLine2
• presentAddress.city
• presentAddress.state
• presentAddress.country
• presentAddress.zipCode
• employment
• employment.positionId
• metadata

Additional Metadata:

• metadata.payScaleArea - Required
• metadata.payScaleType - Required

• Oracle HCM only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored

You must include the following fields in the metadata field:

• employeeNumber(Unique identifier in the company.)

Refer api specific guides - PrismHR API Guide

Supported Request Fields:

• employeeId - Required
• firstName
• lastName
• workEmail
• personalEmails
• presentAddress.addressLine1
• presentAddress.addressLine2
• presentAddress.city
• presentAddress.state
• presentAddress.country
• presentAddress.zipCode
• employment.designation
• companyId
• department
• employeeNumber
• startDate
• birthDate
• gender
• phones
• manager.id

Supported Request Fields:

• employeeId - Required
• firstName
• lastName
• workEmail
• presentAddress.addressLine1
• presentAddress.addressLine2
• presentAddress.city
• presentAddress.country
• presentAddress.zipCode

Additional Metadata:

• Any additional key-value pairs can be passed in metadata and will be forwarded to the TimeTac API

Supported Response Fields:

• employeeId

Supported Request Fields:

• firstName
• lastName
• workEmail
• gender - Allowed values - male female diverse not specified
• employmentType - Allowed values - apprentice externalWorker intern marginalEmployment regularEmployee shortTermEmployment studentTrainee
• startDate - YYYY-MM-DD format
• birthDate - YYYY-MM-DD format
• department - department Id obtained using list all departments API
• phones - only of one phone number of type WORK is honored.
• manager.id
• employment.designation
• presentAddress

Additional Metadata:

• metadata.personId - Required, The user id assigned to the person. Used as the login name. Unique identifier.

• metadata.personnelNumber - Required, The personnel number assigned to the person. Unique identifier.

• Any key-value pairs can be passed in metadata and will be forwarded to the HR Works API

Supported Request Fields:

• employeeId - Required
• firstName
• lastName
• workEmail
• employeeNumber
• phones
• startDate
• employmentType
• employment.designation

Additional Metadata:

• Any key-value pairs can be passed in metadata object

Supported Response Fields:

• No specific response data fields (returns default success response)

Remarks
You can set employmentType to full_time, part_time or casual. employment. designation can be employee, department_admin, location-admin, company_admin.

Supported Request Fields:

• employeeId - Required
• firstName
• lastName
• workEmail
• gender
• employment.positionId
• employment.designation
• personalEmails
• presentAddress.addressLine1
• presentAddress.addressLine2
• presentAddress.city
• presentAddress.state
• presentAddress.country
• presentAddress.zipCode

Additional Metadata:

• Any custom fields can be passed in metadata

Supported Request Fields:

• employeeId - Required
• firstName
• lastName
• workEmail
• employment.designation
• presentAddress.addressLine1
• presentAddress.addressLine2
• presentAddress.city
• presentAddress.state
• presentAddress.country
• presentAddress.zipCode
• metadata

Supported Request Fields:

• employeeId - Required
• firstName
• lastName
• workEmail
• employment.designation
• employment.positionId
• workAddress.addressLine1
• workAddress.addressLine2
• workAddress.city
• workAddress.state
• workAddress.country
• `workAddress.zipCode
• presentAddress.addressLine1
• presentAddress.addressLine2
• presentAddress.city
• presentAddress.state
• presentAddress.country
• `presentAddress.zipCode
• metadata