| Property | Value | Description | Patch | Post |
|---|---|---|---|---|
| employee_id | integer | The id of the employee. | ||
| home_phone_number | string | The home phone number of the employee. | writable | optional |
| cell_phone_number | string | The cell phone number of the employee. | writable | optional |
| employee_number | integer | The employee number of the employee. This is an editable identifier. | writable | optional |
| first_name | string | The first name of the employee. | writable | required |
| middle_initial | string | The middle initial of the employee. | writable | optional |
| last_name | string | The last name of the employee. | writable | required |
| address | string |
The street address of the employee.
e.g. 123 Peachtree St. |
writable | required |
| address_2 | string |
The second address line of the employee.
e.g. Suite A. |
writable | optional |
| city | string | The city of the employee address. | writable | required |
| state | string |
The state abbreviation of the employee address.
e.g. GA. |
writable | required |
| zip | string | The 5 digit zip code of the employee address. | writable | required |
| mail_address | string |
The street mailing address of the employee.
e.g. 123 Peachtree St. |
writable | optional |
| mail_address_2 | string |
The second mailing address line of the employee.
e.g. Suite A. |
writable | optional |
| mail_city | string | The city of the employee mailing address. | writable | optional |
| mail_state | string |
The state abbreviation of the employee mailing address.
e.g. GA. |
writable | optional |
| mail_zip | string | The zip code of the employee mailing address. | writable | optional |
| string | The email address of the employee. | writable | optional | |
| ssn | string |
The social security number of the employee.
e.g. 123456789. |
writable | required |
| gender | enum |
The gender of the employee.
f - female m - male |
writable | optional |
| birthday | ISO |
The birthday of the employee as ISO.
e.g. 2017-01-01T05:00:00+00:00 |
writable | required |
| direct_deposit_active | enum |
Direct deposit is active for the employee.
0 - no 1 - yes |
writable | optional |
| type | enum |
The type of the employee.
1 - Salary 2 - Hourly 3 - Contractor |
writable | required |
| pay_frequency | enum |
The pay frequency of the employee.
1 - Weekly 2 - Bi-Weekly 3 - Semi-Monthly 4 - Monthly |
||
| wage | decimal |
The regular wage rate to 3 decimal places of the employee.
10.000 |
||
| rate | decimal |
The regular rate to 3 decimal places of the employee. Same as wage.
10.000 |
||
| pay_schedule_id | integer | The id of the pay schedule assigned to the employee. | writable | optional |
| employment_status | enum |
The status of the employee. Only active employees can be included in pay runs. Employees pending approval are employees that have added themselves through employee invitation and are awaiting approval by owners/approvers.
0 - Active 1 - Inactive 2 - Pending Approval |
||
| part_time | boolean | Indicates if employee is part-time | writable | optional |
| seasonal | boolean | Indicates if employee is seasonal. | writable | optional |
| department_id | integer | The id of the department assigned to the employee. | writable | optional |
| location_id | integer | The id of the location assigned to the employee. | writable | |
| position_id | integer | The id of the position assigned to the employee. | writable | optional |
| manager_id | integer | The id of the manager to which the employee is assigned. | writable | optional |
| workers_compensation_id | integer | The id of the worker's compensation plan assigned to the employee. | writable | optional |
| hire_date | ISO |
The hire date of the employee.
e.g. 2017-01-01T05:00:00+00:00 |
writable | required |
| termination_date | ISO |
The termination date of the employee.
e.g. 2017-01-01T05:00:00+00:00 |
optional | |
| rehire_date | ISO |
The rehire date of the employee.
e.g. 2017-01-01T05:00:00+00:00 |
writable | optional |
| supplemental_calculation_method | enum |
The calculation method for employee supplemental wages
3 - Percent 4 - Aggregate |
writable | optional |
| use_401k_catchup | enum |
Indicates to add the annual catch-up contribution to the contribution limit for the employee
0 - False 1 - True |
writable | optional |
| use_hsa_catchup | enum |
Indicates to add the annual catch-up contribution to the contribution limit for the employee
0 - False 1 - True |
writable | optional |
| use_hsa_family | enum |
Indicates to use the family HSA limit
0 - False 1 - True |
writable | optional |
| date_added | ISO |
The date the employee was added to OnPay.
e.g. 2017-01-01T05:00:00+00:00 |
||
| commit_id | string | Id assigned by partner to employee included in company creation. | ||
| version | string | The version of the employee. See Versioning section. | ||
| compid | integer | The id of the company to which the employee belongs | ||
| profile_image | string |
The file that contains the profile image of the employee.
e.g. https://onpay.dev/imgs/UserImg/employee-profile-image.jpg |