getEmployeeV1

get https://webservices-test.net-chef.com/employee/v1/detail

Retrieve one employee's details using employeeNumber and siteName.

Responses

Response body

object

address1

string

"Address" from Employee setup screen
Alphanumeric (30) Reference Data for the employee's Net-Chef Profile

address2

string

Not in use

age

int32

Age

allergies

string

Employee's allergies (free text field)
Alphanumeric (25) Reference Data for the employee's Net-Chef Profile

breakWaiver

string

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

N Y

broadcastSchedule

string

Should the weekly labor schedule be emailed to this employee (Y/N)

N Y

city

string

Now storing city as character data
Alphanumeric (40) Reference Data for the employee's Net-Chef Profile

country

string

Country
Alphanumeric (40) Reference Data for the employee's Net-Chef Profile

createUser

int64

User that created the employee (FK to t_user)

dateCreate

date

Date the employee was created

dateEdit

date

Date the employee was last edited

dateEditUtc

string

Date the employee was last edited in UTC

dateHired

date

required

"Date Hired" from Employee setup screen
Date (mm/dd/yyyy) Reference Data for the employee's Net-Chef Profile

dateOfBirth

date

required

"Date of Birth" from Employee setup screen
Date (mm/dd/yyyy) Used by the employee as part of Teamworx login authentication

dateTerminated

date

"Date Terminated" from Employee setup screen
Date (mm/dd/yyyy) Reference Data for the employee's Net-Chef Profile

editUser

int64

User that last edited the employee (FK to t_user)

eligibleForRehire

string

Is this employee eligible for rehire (Y/N)
Alphanumeric (1) If populated, must be ‘Y’ or ‘N’

false true

emailAddress

string

Employee's email address
Alphanumeric (75) Reference data - Employee's Email Address

emergencyContactName

string

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

emergencyContactPhone

string

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

employeeAudits

array of objects

employeeAudits

object

auditDate

date-time

Date of add, change or delete

changeType

string

'A' = Add, 'C' = Change, 'D' = Delete', 'X' = Export

A C D E X

changeValue

string

Review date, availability week ending date + time, position name of value being changes (used for multiple row employee information)

editValue

string

fieldName

string

int64

required

Unique Identifier

originalValue

string

sectionName

string

Section name

userFirstName

string

userId

string

userLastName

string

valueDataType

string

'C' = Character, 'D'= Date, 'N' = Numeric

C D N

employeeChecklistItem01

string

Check List Item 1
Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager

employeeChecklistItem02

string

Check List Item 2
Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager

employeeChecklistItem03

string

Check List Item 3
Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager

employeeChecklistItem04

string

Check List Item 4
Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager

employeeChecklistItem05

string

Check List Item 5
Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager

employeeChecklistItem06

string

Check List Item 6
Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager

employeeChecklistItem07

string

Check List Item 7
Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager

employeeChecklistItem08

string

Check List Item 8
Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager

employeeChecklistItem09

string

Check List Item 9
Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager

employeeChecklistItem10

string

Check List Item 10
Alphanumeric (40) Reference Data associated to the "New Hire Checklist" configured in Enterprise Manager

employeeLocations

array of objects

employeeLocations

object

activeFlag

string

activeFlag
Alphanumeric (1) If populated, must be ‘Y’ or ‘N’. If not populated, will be set to ‘Y’ cannot be 'N' for the employee's primary location.Indicates whether the employee is "active" at the (non-primary) location.If the employee/location relationship is not active, the employee is ineligible to work at the location

N Y

allocateLaborTo

string

Allocate labor indicator
Alphanumeric (1) If populated, must be ‘Y’ or ‘N’. If not populated, will be set to ‘N’.If ‘Y’, this record must come after a record where this value =‘N’.Indicates whether this location will be used when allocating labor data for multiple locations that the employee has worked

N Y

deleteFlag

string

deleteFlag

N Y

employeeNumber

string

employeeNumber

int64

Unique Identifier

locationCityName

string

"City" selected in the Location/Company setup screen

locationCode

string

required

Location Code
Alphanumeric (6) Must match an existing locationCode from /getAllLocations

locationMarketName

string

"Market" selected in the Location/Company setup screen (if any)

locationName

string

"Name" from the Location/Company setup screen

locationStateName

string

"State/Province" selected in the Location/Company setup screen (if any)

posExportFlag

boolean

Export indicator

posId

string

"POS Type" selected in Location/Company setup screen

primaryLocationFlag

boolean

Is Primary location for user working shift
At least one Location must be flagged as Primary

employeeNickname

string

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

employeeNumber

string

required

"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

employeePositions

array of objects

employeePositions

object

altLocationsFlag

string

altLocationsFlag
Alphanumeric (1) If populated, must be ‘Y’ or ‘N’. Allows employee to work this position at any non-primary Location. If 'N', an employee can only work that Position at their primary Location

N Y

deleteFlag

string

deleteFlag
Alphanumeric (1) If populated, must be ‘Y’ or ‘N’. An employee must have/retain at least one Position, flagged as "primaryPositionFlag": "Y".You can also "delete" an Employee/Position record by excluding it from the current "save" input

N Y

employeeNumber

string

employeeNumber

int64

Unique Identifier

payRate

number

Pay Rate
Number (12,4) Required if employee “Pay Type” is ‘Hourly’

payRateDefault

number

Default pay rate for this position

payRateMaximum

number

Maximum pay rate for this position

payRateMinimum

number

Minimum pay rate for this position

payrollCode

string

Payroll code
Alphanumeric (3) Reference Position Code that could be used in payroll exports

posCode

string

required

POS Code
Alphanumeric (10) Position Code that's used in the POS. The posCode is validated against the saveTimeClockEnhanced. Will default to the "positionCode"

positionCode

string

required

Code describing position
Alphanumeric (10) Must match a Position Code configured in the Enterprise Manager Positions module

positionGlDescription

string

GL to which this position is mapped

positionGlSubstructure

string

positionName

string

Full description of position

positionPlGroupingCode

string

positionPlGroupingDesc

string

primaryPositionFlag

string

Primary Position Flag
At least one Position must be flagged as Primary

N Y

skillLevelCode

int64

skillLevelCode
Number (3) Must match a code configured in the Enterprise Manager Skill Levels module

skillLevelDescription

string

wageMatrix

int64

Wage Matrix assigned to the location
Number (3) Required if the employee’s primary location is associated with an active wage matrix that has passed its first effective date

ethnicGroup

string

Employee's ethnic group
Alphanumeric (10) Code for the "Ethnic Group" from Enterprise Manager

federalAdditionalWithholding

number

Employee's additional withholding (federal taxation purposes)
Number (8,2) Reference Data for the employee's Net-Chef Profile

federalExemptions

int64

Employee's additional withholding (federal taxation purposes)
Number (3,0) Reference Data for the employee's Net-Chef Profile

federalMaritalStatus

string

Employee's federal marital status
Alphanumeric (10) Code for the "Marital Status" from Enterprise Manager

firstName

string

required

"First Name" from Employee setup screen
Alphanumeric (40) "First Name" for the Employee Profile

flexField01

string

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

flexField02

string

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

flexField03

string

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

flexField04

string

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

flexField05

string

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

flexField06

string

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

flexField07

string

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

flexField08

string

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

flexField09

string

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

flexField10

string

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

lastName

string

required

"Last Name" from Employee setup screen
Alphanumeric (40) "Last Name" for the Employee Profile

locationId

int64

"location Id" from Employee setup screen

locationName

string

Unique identifier for Location at/for which Employee record was created from Employee setup screen

manager

string

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

N Y

mealProgramDeduction

number

Employee's meal program deduction amount
Number (8,2) Meal Program Deduction from the Net-Chef Employee record

middleName

string

"Middle Name" from Employee setup screen
Alphanumeric (40) "Middle Name" for the Employee Profile

minorLaborProgramCode

string

Minor program for employee
Alphanumeric (10) Code for any Minor Labor Program configured in Enterprise Manager

partTime

string

Marked Y/true when not full time
Alphanumeric (1) If populated, must be ‘Y’ or ‘N’

N Y

payRate01

number

Pay Rate 1
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

payRate02

number

Pay Rate 2
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

payRate03

number

Pay Rate 3
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

payRate04

number

Pay Rate 4
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

payRate05

number

Pay Rate 5
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

payRate06

number

Pay Rate 6
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

payRate07

number

Pay Rate 7
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

payRate08

number

Pay Rate 8
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

payRate09

number

Pay Rate 9
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

payRate10

number

Pay Rate 10
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

payType

string

required

Employee pay type
Alphanumeric (20) Must be ‘Salary’, ‘Hourly’ or ‘Salary Exempt’

payrollIdNumber

string

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

phoneNumber

string

Employee's phone number
Alphanumeric (30) Reference Data for the employee's Net-Chef Profile

posId

string

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"

positionCode01

string

Position Code 1
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

positionCode02

string

Position Code 2
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

positionCode03

string

Position Code 3
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

positionCode04

string

Position Code 4
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

positionCode05

string

Position Code 5
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

positionCode06

string

Position Code 6
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

positionCode07

string

Position Code 7
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

positionCode08

string

Position Code 8
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

positionCode09

string

Position Code 9
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

positionCode10

string

Position Code 10
Recommendation to use the "employeePositions" array to create and update employees positions and payRates

postalCode

string

"Zip" from Employee setup screen
Alphanumeric (10) Reference Data for the employee's Net-Chef Profile

primaryLocationCode

string

Assigned location employee typically works at
Recommendation to use the "employeeLocations" array to assign and update Locations

primaryPositionName

string

Primary job description

pto01

object

Paid Time Off 1. Setting 'null' value for a field does not override (i.e. null out) an existing value for that field in the Employee's record
Number (7,4) 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

Has additional fields

pto02

object

Paid Time Off 2. Setting 'null' value for a field does not override (i.e. null out) an existing value for that field in the Employee's record
Number (7,4) 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

Has additional fields

pto03

object

Paid Time Off 3. Setting 'null' value for a field does not override (i.e. null out) an existing value for that field in the Employee's record
Number (7,4) 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

Has additional fields

pto04

object

Paid Time Off 4. Setting 'null' value for a field does not override (i.e. null out) an existing value for that field in the Employee's record
Number (7,4) 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

Has additional fields

pto05

object

Paid Time Off 5. Setting 'null' value for a field does not override (i.e. null out) an existing value for that field in the Employee's record
Number (7,4) 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

Has additional fields

pto06

object

Paid Time Off 6. Setting 'null' value for a field does not override (i.e. null out) an existing value for that field in the Employee's record
Number (7,4) 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

Has additional fields

pto07

object

Paid Time Off 7. Setting 'null' value for a field does not override (i.e. null out) an existing value for that field in the Employee's record
Number (7,4) 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

Has additional fields

pto08

object

Paid Time Off 8. Setting 'null' value for a field does not override (i.e. null out) an existing value for that field in the Employee's record
Number (7,4) 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

Has additional fields

pto09

object

Paid Time Off 9. Setting 'null' value for a field does not override (i.e. null out) an existing value for that field in the Employee's record
Number (7,4) 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

Has additional fields

pto10

object

Paid Time Off 10. Setting 'null' value for a field does not override (i.e. null out) an existing value for that field in the Employee's record
Number (7,4) 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

Has additional fields

salaryAmount

number

Employee's salary
Number (10,2) Required if "Pay Type" is not "Hourly"

sex

string

Employee's sex
Alphanumeric (1) Valid values are 'F' (Female), 'M' (Male), 'X' (Non-Binary)

F M X

sickHours

number

Number of sick leave hours available. Value can be negative
Number (7,4) Reference data to track and deplete employee sick time

skillLevel01

number

Skill Level 1
Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions

skillLevel02

number

Skill Level 2
Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions

skillLevel03

number

Skill Level 3
Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions

skillLevel04

number

Skill Level 4
Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions

skillLevel05

number

Skill Level 5
Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions

skillLevel06

number

Skill Level 6
Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions

skillLevel07

number

Skill Level 7
Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions

skillLevel08

number

Skill Level 8
Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions

skillLevel09

number

Skill Level 9
Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions

skillLevel10

number

Skill Level 10
Recommendation to use the "employeePositions" array to update Skill levels as they relate to Positions

socialSecurityNumber

string

Social Security Number
Alphanumeric (20) Reference Data

stateAdditionalWithholding

number

Employee's additional withholding (state taxation purposes)
Number (8,2) Reference Data for the employee's Net-Chef Profile

stateExemptions

int64

Employee's additional withholding (state taxation purposes)
Number (3,0) Reference Data for the employee's Net-Chef Profile

stateMaritalStatus

string

Employee's state marital status
Alphanumeric (10) Code for the "Marital Status" from Enterprise Manager

stateProvince

string

State
Alphanumeric (3) Reference Data for the employee's Net-Chef Profile

status

string

required

Employee status description
Alphanumeric (10) Must be ‘Active’, ‘Leave’ or 'Terminated' or the Code associated to these descriptions in Enterprise Manager

statusCode

string

"statusCode" from Employee setup screen

suiSdiTaxJurisdictionCode

string

Employee SUI/SDI Tax Jurisdiction Code
Alphanumeric (6) Reference Data for the employee's Net-Chef Profile

terminationReason

string

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

uniformDeductionAmount

number

Employee's uniform deduction amount
Number (8,2) Reference Data for the employee's Net-Chef Profile

unionMembership

string

Union that employee belongs
Alphanumeric (10) Reference Data for the employee's Net-Chef Profile based on Union Codes configured in Enterprise Manager

wageMatrixRow01

number

Wage Matrix 1
Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions

wageMatrixRow02

number

Wage Matrix 2
Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions

wageMatrixRow03

number

Wage Matrix 3
Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions

wageMatrixRow04

number

Wage Matrix 4
Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions

wageMatrixRow05

number

Wage Matrix 5
Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions

wageMatrixRow06

number

Wage Matrix 6
Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions

wageMatrixRow07

number

Wage Matrix 7
Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions

wageMatrixRow08

number

Wage Matrix 8
Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions

wageMatrixRow09

number

Wage Matrix 9
Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions

wageMatrixRow10

number

Wage Matrix 10
Recommendation to use the "employeePositions" array to update Wage Matrix as they relate to Positions

500

Unexpected Error

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://webservices-test.net-chef.com/employee/v1/detail?auditLog=false' \
3
     --header 'accept: application/json'


xxxxxxxxxx
185
}
1
{
2
  "address1": "200 Main Street",
3
  "address2": "string",
4
  "age": 29,
5
  "allergies": "string",
6
  "breakWaiver": "Y",
7
  "broadcastSchedule": "Y",
8
  "city": "Anywhere",
9
  "country": "USA",
10
  "createUser": 10000003,
11
  "dateCreate": "04/17/2012",
12
  "dateEdit": "11/30/2016",
13
  "dateEditUtc": "2021-08-12T10:21:46",
14
  "dateHired": "02/01/2012",
15
  "dateOfBirth": "07/30/1991",
16
  "dateTerminated": "12/31/9999",
17
  "editUser": 10000001,
18
  "eligibleForRehire": false,
19
  "emailAddress": "string",
20
  "emergencyContactName": "string",
21
  "emergencyContactPhone": "string",
22
  "employeeAudits": [
23
    {
24
      "auditDate": "2015-06-19T17:34:36",
25
      "changeType": "E",

200Success

400Validation Error

401Authorization

404Employee Not Found

504Timeout