getEmployeeV1
Retrieve one employee's details using employeeNumber and siteName.
Query parameters
Use true to retrieve the employee's audit log.
The employee number from the employee record.
The employee id from the employee record.
Specify 'true' to output null data elements.
Headers
Secure token for API authentication.
Password for the Crunchtime Application User.
Crunchtime site identifier. (test or production)
User ID for the Crunchtime Application User.
Optional trace identifier for troubleshooting.
Response
Success
"Address" from Employee setup screen Alphanumeric (30) Reference Data for the employee's Net-Chef Profile
Not in use
Age
Employee's allergies (free text field) Alphanumeric (25) Reference Data for the employee's Net-Chef Profile
Employee has signed a break waiver or not. Impacts Employee Break reports and Labor Actuals. Alphanumeric (1) If populated, must be ‘Y’ or ‘N’. If not populated, will set to ‘N’ for new records; will not update existing records
Should the weekly labor schedule be emailed to this employee (Y/N)
Now storing city as character data Alphanumeric (40) Reference Data for the employee's Net-Chef Profile
Country Alphanumeric (40) Reference Data for the employee's Net-Chef Profile
User that created the employee (FK to t_user)
Date the employee was created
Date the employee was last edited
Date the employee was last edited in UTC
"Date Hired" from Employee setup screen Date (mm/dd/yyyy) Reference Data for the employee's Net-Chef Profile
"Date of Birth" from Employee setup screen Date (mm/dd/yyyy) Used by the employee as part of Teamworx login authentication
"Date Terminated" from Employee setup screen Date (mm/dd/yyyy) Reference Data for the employee's Net-Chef Profile
User that last edited the employee (FK to t_user)
Is this employee eligible for rehire (Y/N) Alphanumeric (1) If populated, must be ‘Y’ or ‘N’
Employee's email address Alphanumeric (75) Reference data - Employee's Email Address
Name of person to contact in the event of an emergency regarding this employee Alphanumeric (40) Reference Data for the employee's Net-Chef Profile
Phone number of person to contact in the event of an emergency regarding this employee Alphanumeric (30) Reference Data for the employee's Net-Chef Profile
Check List Item 1 Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager
Check List Item 2 Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager
Check List Item 3 Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager
Check List Item 4 Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager
Check List Item 5 Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager
Check List Item 6 Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager
Check List Item 7 Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager
Check List Item 8 Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager
Check List Item 9 Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager
Check List Item 10 Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager
Employee nickname Alphanumeric (20) Must not contain characters other than letters, numbers, spaces and the following special characters: single quote, hyphen or underline. Reference Data for the employee's Net-Chef Profile and visible on the schedule
"Employee Number" from Employee setup screen Alphanumeric (40) Must be unique globally. Primary key to make updates against an employees profile, meaning it cannot be updated /save calls
Employee's ethnic group Alphanumeric (10) Code for the "Ethnic Group" from Enterprise Manager
Employee's additional withholding (federal taxation purposes) Number (8,2) Reference Data for the employee's Net-Chef Profile
Employee's additional withholding (federal taxation purposes) Number (3,0) Reference Data for the employee's Net-Chef Profile
Employee's federal marital status Alphanumeric (10) Code for the "Marital Status" from Enterprise Manager
"First Name" from Employee setup screen Alphanumeric (40) "First Name" for the Employee Profile
Flexible Field 1 Alphanumeric (30) Data for the selected Flex Field from the Net-Chef Employee record. Integrators are responsible for knowing which values belong in which "flexField" #s
Flexible Field 2 Alphanumeric (30) Data for the selected Flex Field from the Net-Chef Employee record. Integrators are responsible for knowing which values belong in which "flexField" #s
Flexible Field 3 Alphanumeric (30) Data for the selected Flex Field from the Net-Chef Employee record. Integrators are responsible for knowing which values belong in which "flexField" #s
Flexible Field 4 Alphanumeric (30) Data for the selected Flex Field from the Net-Chef Employee record. Integrators are responsible for knowing which values belong in which "flexField" #s
Flexible Field 5 Alphanumeric (30) Data for the selected Flex Field from the Net-Chef Employee record. Integrators are responsible for knowing which values belong in which "flexField" #s
Flexible Field 6 Alphanumeric (30) Data for the selected Flex Field from the Net-Chef Employee record. Integrators are responsible for knowing which values belong in which "flexField" #s
Flexible Field 7 Alphanumeric (30) Data for the selected Flex Field from the Net-Chef Employee record. Integrators are responsible for knowing which values belong in which "flexField" #s
Flexible Field 8 Alphanumeric (30) Data for the selected Flex Field from the Net-Chef Employee record. Integrators are responsible for knowing which values belong in which "flexField" #s
Flexible Field 9 Alphanumeric (30) Data for the selected Flex Field from the Net-Chef Employee record. Integrators are responsible for knowing which values belong in which "flexField" #s
Flexible Field 10 Alphanumeric (30) Data for the selected Flex Field from the Net-Chef Employee record. Integrators are responsible for knowing which values belong in which "flexField" #s
"Last Name" from Employee setup screen Alphanumeric (40) "Last Name" for the Employee Profile
"location Id" from Employee setup screen
Unique identifier for Location at/for which Employee record was created from Employee setup screen
Is this employee a manager (Y/N) Alphanumeric (1) If populated, must be ‘Y’ or ‘N’. If not populated, will set to ‘N’ for new records
Employee's meal program deduction amount Number (8,2) Meal Program Deduction from the Net-Chef Employee record
"Middle Name" from Employee setup screen Alphanumeric (40) "Middle Name" for the Employee Profile
Minor program for employee Alphanumeric (10) Code for any Minor Labor Program configured in Enterprise Manager
Marked Y/true when not full time Alphanumeric (1) If populated, must be ‘Y’ or ‘N’
Pay Rate 1 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Pay Rate 2 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Pay Rate 3 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Pay Rate 4 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Pay Rate 5 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Pay Rate 6 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Pay Rate 7 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Pay Rate 8 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Pay Rate 9 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Pay Rate 10 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Employee pay type Alphanumeric (20) Must be ‘Salary’, ‘Hourly’ or ‘Salary Exempt’
Employee Payroll ID Number Alphanumeric (20) If the Labor Preference to “Allow Duplicate Payroll ID Number” is NOT enabled, must not be the Payroll ID Number for any other existing employee
Employee's phone number Alphanumeric (30) Reference Data for the employee's Net-Chef Profile
POS Id Alphanumeric (40) Must not be the POS ID for any other Employee/Location. This will default to the employeeNumber by default unless otherwise entered to match the employee ID used in the POS. For the saveTimeClockEnhanced API endpoint, the Location "posId" must be provided as the "employeeNumber"
Position Code 1 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Position Code 2 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Position Code 3 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Position Code 4 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Position Code 5 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Position Code 6 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Position Code 7 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Position Code 8 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Position Code 9 Recommended to use the "employeePositions" array to create and update employees positions and payRates
Position Code 10 Recommended to use the "employeePositions" array to create and update employees positions and payRates
"Zip" from Employee setup screen Alphanumeric (10) Reference Data for the employee's Net-Chef Profile
Assigned location employee typically works at Recommendation to use the "employeeLocations" array to assign and update Locations
Primary job description
Paid Time Off 1. Formatted as '000.0000'. Setting 'null' value for a field does not override (i.e. delete) an existing value for that field in the Employee's record. Employee setup allows customers to customize up to 10 "Paid Time Off" type records, in the Enterprise Manager "Paid Time Off" screen. You can import PTO balances for employee's to reference. Integrators are responsible for knowing which values correspond to particular "pto" #s
Paid Time Off 2. Formatted as '000.0000'. Setting 'null' value for a field does not override (i.e. delete) an existing value for that field in the Employee's record. Employee setup allows customers to customize up to 10 "Paid Time Off" type records, in the Enterprise Manager "Paid Time Off" screen. You can import PTO balances for employee's to reference. Integrators are responsible for knowing which values correspond to particular "pto" #s
Paid Time Off 3. Formatted as '000.0000'. Setting 'null' value for a field does not override (i.e. delete) an existing value for that field in the Employee's record. Employee setup allows customers to customize up to 10 "Paid Time Off" type records, in the Enterprise Manager "Paid Time Off" screen. You can import PTO balances for employee's to reference. Integrators are responsible for knowing which values correspond to particular "pto" #s
Paid Time Off 4. Formatted as '000.0000'. Setting 'null' value for a field does not override (i.e. delete) an existing value for that field in the Employee's record. Employee setup allows customers to customize up to 10 "Paid Time Off" type records, in the Enterprise Manager "Paid Time Off" screen. You can import PTO balances for employee's to reference. Integrators are responsible for knowing which values correspond to particular "pto" #s
Paid Time Off 5. Formatted as '000.0000'. Setting 'null' value for a field does not override (i.e. delete) an existing value for that field in the Employee's record. Employee setup allows customers to customize up to 10 "Paid Time Off" type records, in the Enterprise Manager "Paid Time Off" screen. You can import PTO balances for employee's to reference. Integrators are responsible for knowing which values correspond to particular "pto" #s
Paid Time Off 6. Formatted as '000.0000'. Setting 'null' value for a field does not override (i.e. delete) an existing value for that field in the Employee's record. Employee setup allows customers to customize up to 10 "Paid Time Off" type records, in the Enterprise Manager "Paid Time Off" screen. You can import PTO balances for employee's to reference. Integrators are responsible for knowing which values correspond to particular "pto" #s
Paid Time Off 7. Formatted as '000.0000'. Setting 'null' value for a field does not override (i.e. delete) an existing value for that field in the Employee's record. Employee setup allows customers to customize up to 10 "Paid Time Off" type records, in the Enterprise Manager "Paid Time Off" screen. You can import PTO balances for employee's to reference. Integrators are responsible for knowing which values correspond to particular "pto" #s
Paid Time Off 8. Formatted as '000.0000'. Setting 'null' value for a field does not override (i.e. delete) an existing value for that field in the Employee's record. Employee setup allows customers to customize up to 10 "Paid Time Off" type records, in the Enterprise Manager "Paid Time Off" screen. You can import PTO balances for employee's to reference. Integrators are responsible for knowing which values correspond to particular "pto" #s
Paid Time Off 9. Formatted as '000.0000'. Setting 'null' value for a field does not override (i.e. delete) an existing value for that field in the Employee's record. Employee setup allows customers to customize up to 10 "Paid Time Off" type records, in the Enterprise Manager "Paid Time Off" screen. You can import PTO balances for employee's to reference. Integrators are responsible for knowing which values correspond to particular "pto" #s
Paid Time Off 10. Formatted as '000.0000'. Setting 'null' value for a field does not override (i.e. delete) an existing value for that field in the Employee's record. Employee setup allows customers to customize up to 10 "Paid Time Off" type records, in the Enterprise Manager "Paid Time Off" screen. You can import PTO balances for employee's to reference. Integrators are responsible for knowing which values correspond to particular "pto" #s
Employee's salary Number (10,2) Required if "Pay Type" is not "Hourly"
Employee's sex Alphanumeric (1) Valid values are 'F' (Female), 'M' (Male), 'X' (Non-Binary)
Number of sick leave hours available. Value can be negative Number (7,4) Reference data to track and deplete employee sick time
Skill Level 1 Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions
Skill Level 2 Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions
Skill Level 3 Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions
Skill Level 4 Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions
Skill Level 5 Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions
Skill Level 6 Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions
Skill Level 7 Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions
Skill Level 8 Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions
Skill Level 9 Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions
Skill Level 10 Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions
Social Security Number Alphanumeric (20) Reference Data
Employee's additional withholding (state taxation purposes) Number (8,2) Reference Data for the employee's Net-Chef Profile
Employee's additional withholding (state taxation purposes) Number (3,0) Reference Data for the employee's Net-Chef Profile
Employee's state marital status Alphanumeric (10) Code for the "Marital Status" from Enterprise Manager
State Alphanumeric (3) Reference Data for the employee's Net-Chef Profile
Employee status description Alphanumeric (10) Must be ‘Active’, ‘Leave’ or 'Terminated' or the Code associated to these descriptions in Enterprise Manager
"statusCode" from Employee setup screen
Employee SUI/SDI Tax Jurisdiction Code Alphanumeric (6) Reference Data for the employee's Net-Chef Profile
Reason that employee was terminated. 'Code' of the configured termination reason from EM Alphanumeric (10) Reference data - 'Code' of the configured termination reason from Enterprise Manager
Employee's uniform deduction amount Number (8,2) Reference Data for the employee's Net-Chef Profile
Union that employee belongs Alphanumeric (10) Reference Data for the employee's Net-Chef Profile based on Union Codes configured in Enterprise Manager
Wage Matrix 1 Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions
Wage Matrix 2 Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions
Wage Matrix 3 Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions
Wage Matrix 4 Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions
Wage Matrix 5 Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions
Wage Matrix 6 Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions
Wage Matrix 7 Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions
Wage Matrix 8 Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions
Wage Matrix 9 Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions
Wage Matrix 10 Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions
Example response
{
"address1": "200 Main Street",
"age": 29,
"breakWaiver": "Y",
"broadcastSchedule": "Y",
"city": "Anywhere",
"country": "USA",
"createUser": 10000003,
"dateCreate": "04/17/2012",
"dateEdit": "11/30/2016",
"dateEditUtc": "2021-08-12T10:21:46",
"dateHired": "02/01/2012",
"dateOfBirth": "07/30/1991",
"dateTerminated": "12/31/9999",
"editUser": 10000001,
"employeeAudits": [
{
"auditDate": "2015-06-19T17:34:36",
"changeType": "E",
"changeValue": "LABOR AUTOMATION THREE",
"editValue": "N",
"fieldName": "NC Changed Employee",
"id": 388777,
"originalValue": "Y",
"sectionName": "Employee",
"userFirstName": "John",
"userId": "IM_OWNER",
"userLastName": "Doe",
"valueDataType": "C"
}
],
"employeeLocations": [
{
"activeFlag": "Y",
"allocateLaborTo": "N",
"deleteFlag": "N",
"id": 17,
"locationCityName": "Anywhere",
"locationName": "AUTOMATION THREE",
"locationStateName": "MASSACHUSETTS",
"primaryLocationFlag": true
}
],
"employeeNumber": "AUTO-0000000004",
"employeePositions": [
{
"deleteFlag": "N"
}
],
"federalMaritalStatus": "SINGLE",
"firstName": "John",
"lastName": "Doe",
"locationName": "AUTOMATION THREE",
"manager": "Y",
"middleName": "Middle",
"partTime": "Y",
"payType": "H",
"payrollIdNumber": "0000000004",
"postalCode": "01234",
"primaryPositionName": "DINING ROOM SERVER (GT)",
"sex": "F",
"stateMaritalStatus": "SINGLE",
"stateProvince": "MA",
"status": "Leave",
"statusCode": "Terminated"
}