The Employee Object

An Employee Object represents a W2 employee for a given company

attribute

type

description

employeeID

string

Zeal Employee ID

companyID

string

Zeal Company ID of this employee's employer

onboarded

boolean

Whether employee has onboarded onto Zeal or not

employment_status

string

Employment status of employee. Holds one of the following values:
live
leave: This employee is 'On Leave'
terminated: This employee has been 'Terminated'. If terminated, must have term_date. (see below)

term_date

string

Termination Date of employee. Termination date is the day in which the employee and the employer end their relationship and is formatted as a date (YYYY-MM-DD)

first_name

string

First name of employee

last_name

string

Last name of employee

title

string

Title of employee

working_state

string

State in which this employee is working.
Represented as state abbreviation

dob

string

Date of birth of employee

start_date

string

Start Date of employee (also known as hire date).
This is the first day that this employee works in return for wages and is formatted as a date (YYYY-MM-DD). Zeal uses this date for new hire reporting.

email

string

Email of employee

address

string

Residential Street address of employee

address_line2

string

Residential Street Address Line 2 of employees (i.e. apt numbers, suite no., etc.)

city

string

Residential City of employee

state

string

Residential State of employee

zip

string

Residential Zip code of employee

phone_number

string

Phone number of employee. Formatted with "+1" country code (e.g. +18214370987)

default_pay_schedule

string

Default pay schedule of employee. See the different options here

default_wage

number

Default wage of employee

default_ot_wage

number

Default overtime wage of employee

default_dt_wage

number

Default double-time wage of employee

ssn

string

Social security number of employee

autopilot

object

Autopilot is a way to run payroll for an employee hands-free. Based on the information given in this object, Zeal will create a check with a portion of the salary on a frequency determined by the default pay schedule of the employee, starting on the salary_firstDate.
Zeal automatically creates checks the morning of the day before the scheduled check date (Zeal also sends a webhook when the check is created)

Show autopilot fields **autopilot_on** type: boolean required: false default: false description: Whether autopilot is on for this employee or not

salary
type: number
required: if autopilot_on is true
description: Annual salary amount

salary_firstDate
type: string
required: if autopilot_on is true

{
  "employeeID": "1234567890",
  "companyID": "0987654321",
  "onboarded": true,
  "employment_status": "live",
  "term_date": null,
  "first_name": "erlich",
  "last_name": "bachman",
  "email": "[email protected]",
  "dob": "1999-12-04",
  "start_date": "2019-06-04",
  "title": "Brand Ambassador",
  "working_state": "CA",
  "address": "320 Pancake Hollow Road",
  "address_line2": null,
  "city": "Highland",
  "state": "NY",
  "zip": "12528",
  "phone_number": "+18214370987",
  "default_pay_schedule": "weekly",
  "default_wage": 20,
  "default_ot_wage": 30,
  "default_dt_wage": 40,
  "ssn": "123456789",
  "autopilot": {
    "autopilot_on": false,
    "salary": 100000,
    "salary_firstDate": "2020-08-25",
 }
}