API Reference
  1. Create Worker API

Create a complete employee record

post
https://api.everee.com/integration/v1/workers/employee

Creates a complete employee profile, with all details necessary for the employee to receive ACH direct deposit payments through Everee.

Profile Status

The employee's "status" will be set to "Active", indicating that no further worker-facing onboarding is required. In hosted payroll, either a payroll administrator or the employee themselves may make further changes to this profile, depending on access settings. In Payroll Infrastructure, changes are made through the API.

Data Security

You must capture all required worker data in order to create a complete profile, so this option is only appropriate if the integrating application assumes the risk and responsibility of capturing potentially sensitive personally-identifiable data about the worker.

Note that this operation will designate the worker as a W2-issued employee with a formal employment relationship.

Body Params
string
required
string
string
required
string
required

9-digit numeric string (no hyphens or other characters)

string
required

ISO8601 date

string
required

10 digits

string
required

email format

homeAddress
object
required
legalWorkAddress
object
required
bankAccount
object
required
string
required
Defaults to HOURLY

one of: “HOURLY”, “SALARY”

payRate
object
required

if payType = "HOURLY", then an hourly rate, or if payType = "SALARY", then an annual salary amount

string
required

ISO8601 date

string
enum
deprecated

Deprecated: use payrollCalendarId. 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. Can't be combined with payrollCalendarId.

Allowed:
string

The ID of one of the company's payroll calendars, from the Payroll Calendar API. The calendar must exist (otherwise 404), can't be archived, and must already be effective on the worker's start date (otherwise 422). Can't be combined with paySchedule. Defaults to the company's default calendar if neither is specified.

int32
required

number from 1 to 40, inclusive

withholdingSettings
object
required

Specifies the employee's federal income tax withholding options. The fields in this structure correspond to the fields on the 2020-and-later version of IRS Form W-4.

boolean
Defaults to true

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

boolean
Defaults to true

Specifies the desired "onboarding status" of the employee profile. If true, marks the "onboarding status" as "Complete", which will move the employee to "Active" once their hire date is reached. If false, leaves the new profile in the "onboarding in progress" status and allows the employee to complete self-onboarding (if available).

string
string

The ID of the approval group to assign this worker to, as returned by the List approval groups endpoint. Optional. If you leave it out, the worker isn't in any group.

int32

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

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.

costCenters
array of objects
length ≤ 3

The worker's default cost centers, each as a type key and value, with at most one entry per type. They're used for any cost center type that a shift, time card, or other wage item doesn't specify itself. Each type must be the key of an active cost center; see the Cost Centers guide. Leave out for no defaults.

costCenters
Responses

Updated 11 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated 11 days ago

Did this page help you?