Kick off onboarding for an employee

post

https://api.everee.com/api/v2/onboarding/employee

Creates a partial profile for a new employee, requiring only minimal data. The rest of the employee’s information will be captured during an Everee-managed onboarding process or directly entered by a payroll administrator, in order for the employee to be payable.

Body Params

firstName

string

required

middleName

string

lastName

string

required

phoneNumber

string

required

10 digits

string

required

email format

payType

string

required

Defaults to HOURLY

one of: “HOURLY”, “SALARY”

payRate

object

required

Money

typicalWeeklyHours

int32

required

Defaults to 40

integer in range 1-40 inclusive

paySchedule

string

enum

The desired pay schedule for this employee. Only options that have been enabled for the current Company are available; specifying an option that is not enabled for a Company will result in an error. Defaults to the company's pay cycle if not specified.

Allowed:

eligibleForOvertime

boolean

Defaults to true

Whether to include this employee in overtime classification for any hours clocked on their Timesheet.

hireDate

string

required

ISO8601 date

legalWorkAddress

object

required

externalWorkerId

string

approvalGroupId

int32

timeOffPolicyId

int32

The Leave Policy ID in which to enroll this employee. Enrollment is effective on the 'hireDate' of this employee.

socCode

string

The Standard Occupational Classification code this employee will be assigned to. For multi-job staffing scenarios, you should provide the code that most closely matches the majority of their expected work. Multiple SOC codes are not supported in employer filings, and are not supported in Everee as a result.

Response

Language

Credentials

Header

Response

Choose an example:

application/json

201201