TAeEmployeeDetail() Structure

Field Data Type Description Notes
Active Status Integer Employee active status 1, 18
ActiveStatusConditionEffDate String Effective date ActiveStatusCondition was set 2
ActiveStatusConditionID Integer Employee active status identifier 3, 12
Address1 String Employee address line 1
Address2 String Employee address line 2
Address3 String Employee address line 3
AddressCity String Employee city
AddressStateProv String Employee state or province abbreviation
AddressZIPPC String Employee zip code or postal code
AvgWeeklyHrs Integer Average hours employee works per week (in minutes)
Badge Integer Employee badge number
BirthDate String Employee birth date 2
ClockGroupID Integer Clock group identifier 4
CurrentRate Double Employee rate of pay
CurrentRateEffDate String Date pay rate became effective 2
DateOfHire String Employee date of hire 2
EmergencyContact String Emergency contact information
EmpID String Employee ID (unique) 12
EmpName String Employee full name 13
Filekey Integer AoD unique identifier 14
FirstName String Employee first name 12
HourlyStatusEffDate String Date hourly status became effective 2
HourlyStatusID Integer Hourly status identifier 5
InactiveStatusConditionID Integer Inactive status identifier 6, 18
Initial String Employee middle name initial
LastName String Employee last name 12
PayClassEffDate String Date pay class became effective 2, 11
PayClassID Integer Pay class identifier 7
PayTypeEffDate String Date pay type became effective 2
PayTypeID Integer Pay type identifier 8
Phone1 String Employee primary phone number
Phone2 String Employee secondary phone number
SchPatternEffDate String Date schedule pattern became effective 2
SchPatternID Integer Schedule pattern identifier 9, 10
SSN String Employee SSN 17
StaticCustom1 String Custom field used to store any other pertinent employee information
StaticCustom2 String Custom field used to store any other pertinent employee information
StaticCustom3 String Custom field used to store any other pertinent employee information
StaticCustom4 String Custom field used to store any other pertinent employee information
StaticCustom5 String Custom field used to store any other pertinent employee information
StaticCustom6 String Custom field used to store any other pertinent employee information
UnionCode String Employee union code
WG1 Integer Employee workgroup level 1 identifier 12
WG2 Integer Employee workgroup level 2 identifier 12
WG3 Integer Employee workgroup level 3 identifier 12
WG4 Integer Employee workgroup level 4 identifier 15
WG5 Integer Employee workgroup level 5 identifier 15
WG6 Integer Employee workgroup level 6 identifier 15
WG7 Integer Employee workgroup level 7 identifier 15
WGDescr String Workgroup description 16
WGEffDate String Date employee workgroup became effective 2

Notes

  1. 0 = Active, 1 = Inactive
  2. yyyy-mm-dd format
  3. Use getActiveStatusConditions to retrieve a list of Active Status ID’s and values
  4. Use getClockGroupsSimple to retrieve a list of Clock Group ID’s and values
  5. Use getHourlyStatusTypesSimple to retrieve a list of Hourly Status ID’s and values
  6. Use getInactiveStatusConditions to retrieve a list of Inactive Status Condition ID’s and values
  7. Use getPayClassesSimple to retrieve a list of Pay Class ID’s and values
  8. Use getPayTypes to retrieve a list of Pay Type ID’s and values
  9. Use getSchedulePatternsSimple to retrieve a list of Schedule Pattern ID’s and values
  10. Zero value = No assigned schedule pattern
  11. Attempting to change it to anything sooner than the first date of the previous pay period will automatically change it to the first date of the previous pay period
  12. Required when adding a new employee
  13. Last, first, middle format
  14. Unique identifier to AoD. Read only
  15. Required, but can use defualt of 0
  16. Usually a string representation of the employee’s first three workgroups
  17. DO NOT include the dashes
  18. If terminating an employee, you must set the InactiveStatusConditionID to a valid value

Usage on Add and Update

Detail Level Field Usage on Add Usage on Edit
CurrentRate Optional. Set to -1 to skip Optional. Set to -1 to skip
CurrentRateEffDate Optional Set to empty string to skip. If current rate is set and this fields is blank the system assumes current date Optional. Set to empty string to skip. If current rate is set and this field is blank the system assumes current date
ActiveStatusConditionID Optional. Set to -1 to skip. For lookup and reference of valid values see: getActiveStatusConditions Optional. Set ot -1 to skip. For lookup and reference of valid values see: getActiveStatusConditions
InactiveStatusConditionID Optional. Set to -1 to skip. For lookup and reference: getInactiveStatusConditions Optional. Set to -1 to skip. For lookup and reference: getInactiveStatusConditions
PayTypeID Optional. For lookup and reference: getPayTypes Optional. For lookup and reference: getPayTypes
PayTypeEffDate Optional. Set to empty string to skip. If PayTypeID is set and this field is blank the system assumes the current date. Optional. Set to empty string to skip. If PayTypeID is set and this field is blank the system assumes the current date.
PayClassID Optional. Set to -1 to skip. For lookup and reference: getPayClassesSimple Optional. Set to -1 to skip. For lookup and references: getPayClassesSimple
PayClassEffDate Optional. Set to empty string to skip. If PayClassID is set and this field is blank the system assumes current date. Optional. Set to empty string to skip. If PayClassID is set and this field is blank the system assumes current date.
SchPatternID Optional. Set to -1 to skip. For lookup and reference: getSchedulePatternsSimple Note: 0 = No Assigned Schedule pattern Optional. Set to -1 to skip. For lookup and reference: getSchedulePatternsSimple Note: 0 = No Assigned Schedule Pattern
SchPatternEffDate Optional. Set to empty string to skip. If SchPatternID is set and this field is blank the system assumes current date. Optional. Set to empty string to skip. If SchPatternID is set and this field is blank the system assumes current date.
HourlyStatusID Optional. Set to -1 to skip. For lookup and reference: getHourlyStatusTypesSimple Optional. Set to -1 to skip. For lookup and reference: getHourlyStatusTypesSimple
HourlyStatusEffDate Optional. Set to empty string to skip. If HourlyStatusID is set and this field is blank the system assumes current date. Optional. Set to empty string to skip. If HourlyStatusID is set and this field is blank the system assumes current date.
AvgWeeklyHrs Optional/Desired. Set to zero to skip. Optional/Desired. Set to zero to skip.
ClockGroupID Optional. Set to -1 to skip. For lookup and reference: getClockGroupsSimple Optional. Set to -1 to skip. For lookup and reference: getClockGroupsSimple
WGEffDate Optional. Set to empty string to skip. If any of the employee’s WGx assignments change, and this field is blank, the system assumes current date Optional. Set to empty string to skip. If any of the employee’s WGx assignments change, and this field is blank, the system assumes current date
Phone1 Optional. Blank to skip Optional. Blank to skip
Phone2 Optional. Blank to skip Optional. Blank to skip
EmergencyContact Optional. Blank to skip Optional. Blank to skip
Address1 Optional. Blank to skip Optional. Blank to skip
Address2 Optional. Blank to skip Optional. Blank to skip
Address3 Optional. Blank to skip Optional. Blank to skip
AddressCity Optional. Blank to skip Optional. Blank to skip
AddressStateProv Optional. Blank to skip Optional. Blank to skip
AddressZIPPC Optional. Blank to skip Optional. Blank to skip
UnionCode Optional. Blank to skip Optional. Blank to skip
StaticCustom1 Optional. Blank to skip Optional. Blank to skip
StaticCustom2 Optional. Blank to skip Optional. Blank to skip
StaticCustom3 Optional. Blank to skip Optional. Blank to skip
StaticCustom4 Optional. Blank to skip Optional. Blank to skip
StaticCustom5 Optional. Blank to skip Optional. Blank to skip
StaticCustom6 Optional. Blank to skip Optional. Blank to skip

Note: There are instances where blank/empty values or a space will not be interpreted correctly in its xml form. In cases where a blank value or empty value is required a non-breaking space may also be used. A non-breaking space is represented with: “& nbsp;”

TAeEmployeeBasic
TAeEmployeeDetail2

Methods Referencing Structures

getEmployeeDetailByBadge
getEmployeeDetailByFilekey
getEmployeeDetailByIDNum
getEmployeeDetailBySSN
getEmployeesSearchListDetail
getEmptyEmployeeDetail
maintainEmployeeDetail
setEmployeeDetail