API Reference

Create a complete employee record

post
https://api.everee.com/api/v2/workers/employee

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

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

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:
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
int32
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.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
text/plain
application/json

Updated 3 months ago