This API makes up to three independent calls to Paycor, depending on which fields are supplied: a Contact update, a Position update, and a Personal Data update. Each is only called if a relevant field is present in the request.

Supported Request Fields:

• employeeId - Required
• workEmail - Triggers a Contact update
• personalEmails - Triggers a Contact update. Only the first email is used; any additional emails are ignored
• presentAddress.addressLine1, addressLine2, city, state, country, zipCode - Triggers a Contact update. Sent as the employee's primary address in Paycor
• phones.type, phones.phoneNumber - Triggers a Contact update. Only included if metadata.areaCode is also supplied (see below); otherwise phones is silently omitted from the request entirely. HOME, PERSONAL, and WORK are mapped to Paycor's Home, Mobile, and Work respectively
• employment.designation - Triggers a Position update. Sent as the Job Title. Must be an existing Job Title name in Paycor, can be obtained using a passthrough request with method GET and path /tenants/{tenantId}/jobtitles
• workAddress.id - Triggers a Position update. Corresponds to the Work Location name in Paycor (not an ID), can be obtained using a passthrough request with method GET and path /legalentities/{legalEntityId}/worklocations, use the name value from this response. If not supplied but employment.designation is, the employee's current Work Location is fetched from Paycor and resent unchanged, since Paycor requires this field on every Position update
• firstName - Triggers a Personal Data update
• lastName - Triggers a Personal Data update

The fields not supported by this API for Paycor are:

• employment.positionId (Paycor has no ID-based Job Title lookup for this endpoint; use employment.designation instead)
• employment.workShiftId
• workAddress -> addressLine1, addressLine2, city, state, country, zipCode (only workAddress.id is used)

Additional Metadata:

• areaCode - Required for phones to be included in the Contact update; Paycor requires an area code alongside every phone number
• suffix, socialSecurityNumber, birthDate - Not required in the common case. Paycor's Personal Data endpoint requires these three fields on every call with no "keep existing value" option, so Knit automatically fetches and resends the employee's current values from Paycor. Only supply these in metadata if the employee is missing one of them in Paycor already (for example, an employee with no SSN on file) - otherwise the Personal Data update will fail

Remarks

• Contact updates and Personal Data updates are submitted to Paycor as pending change requests. Depending on your Paycor tenant's configuration, these may require manual approval from the Paycor dashboard before the change is reflected. Position updates are not affected by this and apply immediately.
• Only one pending Contact or Personal Data change request is allowed per employee at a time. If a previous request for the same employee hasn't been approved yet, a new request in the same category will be rejected by Paycor.

• 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

Supported Request Fields:

• employeeId - Required
• firstName
• lastName
• startDate
• employeeNumber
• metadata

Supported Request Fields:

• employeeId - Required
• firstName
• lastName
• employeeNumber