Create Employee
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
This endpoint creates an Employee Object to represent a W-2 employee.
Note: This employee cannot be included in a payroll run until they are also onboarded.
If any of the optional residential address fields are specified, the whole address must be suitable for taxation. Error Code 34 will be returned otherwise.
Query the Resolve Taxable Location Endpoint for further details on why the address was not suitable.
Note: before creating an employee, a Work Location must be created and its ID must be provided during employee creation
Returns Skip link to Returns
| attribute | type | description |
|---|---|---|
| success | boolean | Response status |
| data | object | Contains newly created Employee Object |
| errors | array | Contains a list of error objects which consists of:message: Error messagecode: Error code as described in Error codes |
companyID
string
required
Company ID of employer (you can access your companyID on the Zeal dashboard)
new_employees
array of objects
required
List of The Employee Object
new_employees* ADD object
``200 200
``400 400
Updated about 1 year ago
Shell
xxxxxxxxxx
{
"companyID": "1b5n28nrideucd24",
"new_employees": [
{
"email": "erlich@zeal.com",
"first_name":"Erlich",
"last_name":"Bachman",
"default_pay_schedule": "daily",
"title": "Brand Ambassador",
"start_date": "2019-11-01",
"default_wage": 20,
"overtime_rate": 1.6,
"double_time_rate": 2.1,
"workLocationID": "531fece70b6d0b5d29c9f352",
"ssn": "182563748",
"phone_number": "8716738956",
"is_943" : false,
"is_scheduleH" : false
},
{
"email": "richard@zeal.com",
"first_name":"Richard",
"last_name":"Hendricks",
"default_pay_schedule": "biweekly",
"title": "Caterer",
"workLocationID": "531fece70b6d0b5d29c8f352",
"start_date": "2019-11-01",
"default_wage": 25,
"is_943" : true,
"is_scheduleH" : false
},
{
"email": "peter@zeal.com",
"first_name":"Peter",
"last_name":"Gregory",
"workLocationID": "531fece72b6d0b5d29c9f352",
"default_pay_schedule": "weekly",
"title": "Staffing Manager",
"start_date": "2019-11-01",
"default_wage": 23,
"is_943" : true,
"is_scheduleH" : false
}
]
}
Click Try It! to start a request and see the response here! Or choose an example:
application/json
200 - Result400 - Result
Updated about 1 year ago
Did this page help you?
Yes
No