CHcheckhq

Create an employee

Changed on

Creates an employee.

post/employees (COPY)

Request

Request body

first_namestring

Employee's first name

middle_namestring

Employee's middle name, if available

last_namestring required

Employee's last name

emailstring

Employee's email address

dobstring date

Employee's date of birth. Until dob is added, it will show up as a blocking employee onboard step.

companystring required

ID of employee's company

start_datestring date

Most recent start date of employment. Until start date is added, it will show up as a blocking employee onboard step.

termination_datestring date

Most recent date of employment termination. Will be set to null if a more recent start date is set.

default_net_pay_splitstring

ID of employee's net pay split

workplacesstring[] required

IDs of workplaces where the employee works. Optionally, an empty list can be passed in and workplaces can be added after employee creation. Until the workplaces are added, this will show up as a blocking step in the onboarding status.

primary_workplacestring

The Workplace ID of the employee's primary workplace.

ssnstring

Employee's TIN (usually their Social Security Number). Must be unique across all employees in a company. Only the last four digits of an SSN will be made available in ssn_last_four after being set.

payment_method_preferencestring

Either "direct_deposit" or "manual", default null

activeboolean

Indicates whether the employee is currently employed. Used only for filtering.

w2_electronic_consent_providedboolean

Indicates whether the employee has opted into electronic delivery of W2 PDF.

metadatastring json

Additional loosely structured information to associate with the employee

Response

201

Changes