getEmployeePayrollByDayAndPlant
This web service report allows you to view all payroll information associated with an employeeUser accounts for drivers, dispatchers, and other staff to perform varying functions in TrackIt. based on factors like hotspots, statusThe specific activity or task a driver is currently engaged in, typically as part of a process called a "status loop.", and equipmentAll machines used as a means of production on a construction site or at a batch plant..
Parameters
PayrollParams
Parameter |
Description |
Type |
Required |
Notes |
---|---|---|---|---|
plantNums | The identifying numbers for the plantA production plant or material storage location.(s) queried. |
String |
Required |
Required: Separate multiple entries with a comma.
Wildcard: Use -1 to query all data of this type. |
The day(s) desired for report data querying. |
Date Range |
Required |
||
allowMissingLogouts | Allows for the return of data even if drivers haven't yet clocked out from a shift. Logged in users are omitted from the report. | Boolean | When false, an error will display if includeUsersWithMissingLogouts is invalid. |
|
Displays users currently logged in if true. |
Boolean |
When true, the value for logout will display as null and all hourly counts will be calculated based on the current time. | ||
getStatusInfo |
Allows for the return of status information, such as status changes, names, and account codes. |
Boolean |
Querying this data will require significant bandwidth. Only set to true if you need this data. |
|
getHotspotInfo |
Allows for the return of hotspotGeographic areas marked on a map that act as destinations for driver navigation or triggers for automated behaviors in TrackIt. information, such as plant details. |
Boolean |
Querying this data will require significant bandwidth. Only set to true if you need this data. |
|
getEquipmentInfo |
Allows for the return of equipment information such as engine data. |
Boolean |
Querying this data will require significant bandwidth. Only set to true if you need this data. |
Returns
EmployeePayroll
Parameter | Description | Notes |
---|---|---|
altEmployeeNum |
The alternative employee's identification number, as used by an integrated system. This is also known as the interface number. |
|
employeeNum |
The employee's identification number. |
|
firstName |
The employee's first name. |
|
lastName |
The employee’s last name. |
|
plantNum |
The plant's identification number. |
|
defaultWorkType |
The work type associated with the employee's shift. This is based on the Employee Type Setup. |
|
id |
The work type identification number. |
|
name |
The work type name. |
|
nondriverstatusType |
The non-driver's status type, as based on their employee type. This helps to determine what status to use if the driver is not logged into a vehicleAll machines used as a means of production on a construction site or at a batch plant.. |
|
id |
The driver status type identification number, as provided by a third-party hours of service or DVIR app. |
|
name |
The driver status type name, as provided by ISE eFleetSuite. |
DayInfo array
Parameter | Description | Notes |
---|---|---|
exported |
The data received was previously exported to a CSV file. |
Included in the DayInfo parent node. |
holidayHours |
The amount of time spent working on a day flagged as a holiday. |
Included in the DayInfo parent node. |
lunch |
The amount of time spent on a lunch break. This is based on the threshold and times set under Employee Type Setup. |
Included in the DayInfo parent node. |
manHours |
The total amount of time an employee works, based on the scheduled clock-in and clock-out times. |
Included in the DayInfo parent node. |
overtime |
The total amount of time an employee logs during the day that qualifies as overtime. |
Included in the DayInfo parent node. |
payHours |
The total amount of time an employee spends on the clock, minus any unpaid statuses such as break and lunch time. |
Included in the DayInfo parent node. |
rejected |
The time cardA log of an employee's start and quit times. The time card collects both the scheduled and actual times captured via TrackIt. was rejected by management. |
Included in the DayInfo parent node. |
shifts array
Parameter | Description | Notes |
---|---|---|
equipmentHours |
The total engine hours logged for a shift based upon Question Setup. |
Included in the shifts parent node. |
equipmentMiles |
The total equipment's odometer reading based upon Question Setup. |
Included in the shifts parent node. |
lunchHours |
The amount of time spent on a lunch break. This is based on the threshold and times set under Employee Type Setup. |
Included in the shifts parent node. |
manHours |
The total amount of time spent on the clock, not including lunch hours or other unpaid statuses. |
Included in the shifts parent node. |
payHours |
The total amount of time spent clocked in for a shift that can be billed as work time by the employee. |
Included in the shifts parent node. |
schedule array
Parameter | Description | Notes |
---|---|---|
comments |
The comments associated with the scheduleA tool for scheduling daily employee shifts. Employers may use this to set start and end times for each employee. |
Included in the schedule parent node. |
hourMeter |
The total engine hours logged according to the last received engine diagnosticsTrackable vehicle data reported by the ECU. Such information allows a company to proactively monitor the health of equipment. update or question response. |
Included in the schedule parent node. |
odometer |
The vehicle's current or last odometer reading received by engine diagnostics update or question response. |
Included in the schedule parent node. |
plantNum |
The equipment's identification number. |
Included in the schedule parent node. |
scheduleIn |
The scheduled clock-in time for an employee to begin their shift, as set on the timecard. |
Included in the schedule parent node. |
scheduleOut |
The scheduled clock-out time for an employee to end their shift, as set on the timecard. |
Included in the schedule parent node. |
ticketId |
The number for the ticketShort for “delivery ticket,” which is printed and given to the driver. Also called a tag or docket. The ticket includes, at a minimum, the product(s) ordered and the delivery address. It can also include the amounts of materials batched to form the mix. In the past, producers sent copies of the delivery ticket with prices as invoices; now tickets and invoices are two separate documents. assigned to the equipment. |
Included in the schedule parent node. |
workType |
The name of the work type performed by the employee during the shift. |
Included in the schedule parent node. |
timecard array
All items included in this array are provided when the getStatusInfo parameter is set to true.
Parameter | Description | Notes |
---|---|---|
login |
The time an employee was recorded as logging into TrackIt Android or starting on a time card. |
Included in the timecard parent node. |
logout |
The time an employee was recorded as logging out from the TrackIt Android app, or ending a time card. |
Included in the timecard parent node. |
statusChanges |
A list of statuses entered by the equipment throughout the shift. | Included in the timecard parent node. |
accountCode1 accountCode2 |
The account code associated with the status, as used for payroll purposes with integrated solutions. |
Included in the timecard parent node. |
description |
The name of the status. |
Included in the timecard parent node. |
hotspot array
All items included in this array are provided when the getHotspotInfo parameter is set to true.
Parameter | Description | Notes |
---|---|---|
id |
The hotspot's identification number. |
Included in the hotspot parent node. |
plantNum |
The plant associated with the hotspot, identified by plant number. |
Included in the hotspot parent node. |
hourMeter |
The total engine hours logged according to the last received update. |
Included in the hotspot parent node. |
lunch |
The status is flagged as lunch. |
Included in the hotspot parent node. |
odometer |
The vehicle's current or last recorded odometer reading. |
Included in the hotspot parent node. |
paid |
The status is flagged as paid time. |
Included in the hotspot parent node. |
productive |
The status is flagged as productive. |
Included in the hotspot parent node. |
questions array
Parameter | Description | Notes |
---|---|---|
answer |
The driver's selected or manually-entered response to the question. |
Included in the questions parent node. |
The order in which the question appears to the driver in comparison to other questions. |
Included in the questions parent node. | |
text |
The question displayed on the device screen upon entering the status. |
Included in the questions parent node. |
statusNum |
The status's corresponding identification number. | Included in the questions parent node. |
ticketId |
The number for the ticket assigned to the equipment. |
Included in the questions parent node. |
time |
The time the employee entered the status. |
Included in the questions parent node. |
ticket array
Parameter | Description | Notes |
---|---|---|
activeTime |
The total time the ticket has been or was in the Active status. | Included in the ticket parent node. |
actualDestination |
The timestamp for when the equipment arrived at the destinationThe location of a job or pour site that a driver must navigate to. location associated with the ticket. | Included in the ticket parent node. |
actualOrigination |
The timestamp for when the equipment received its initial loadThe total amount of concrete or asphalt that is being or has been batched for delivery. for the ticket. |
Included in the ticket parent node. |
actualReturnTime |
The timestamp for when the equipment returned to the plant after pouring its load at the destination. |
Included in the ticket parent node. |
altTicketNum |
The ticket's alternative number. |
Included in the ticket parent node. |
comment |
Dispatcher and driver comments associated with the incident, occurrenceA single incident or event recorded by TrackIt., or item. |
Included in the ticket parent node. |
contactInfo |
Any customer-provided contact information, typically a phone number or name. | Included in the ticket parent node. |
customer |
The customer's name associated with the ticket and order. |
Included in the ticket parent node. |
day |
The date of the associated ticket activity. |
Included in the ticket parent node. |
destinationAddress |
The building number and street address of the destination. |
Included in the ticket parent node. |
employeeNum |
The employee's identification number. |
Included in the ticket parent node. |
The job name associated with the ticket(s) queried. | Included in the ticket parent node. | |
jobCode |
The job number associated with the ticket(s) queried. |
Included in the ticket parent node. |
materialLeftOn |
The total amount of remaining material measured in the equipment drum. |
Included in the ticket parent node. |
order |
The order number associated with the equipment's assigned ticket. |
Included in the ticket parent node. |
phaseCode |
The phase code associated with the equipment's assigned ticket, as used by payroll. |
Included in the ticket parent node. |
originationAddress |
The street address of the plant that batched the equipment's load. |
Included in the ticket parent node. |
POnumber |
The PO number associated with the equipment's assigned ticket, as used by payroll. |
Included in the ticket parent node. |
productAmounts |
The total amount of material ordered for the ticket. |
Included in the ticket parent node. |
returnAddress |
The street address of the return address location, such as a plant. |
Included in the ticket parent node. |
scheduleDestination |
The originally-scheduled time for delivery of the load to the destination location. |
Included in the ticket parent node. |
scheduleOriginTime |
The originally-scheduled time for the equipment departing the origination plant. |
Included in the ticket parent node. |
ticketId |
The ticket's identification number assigned to corresponding a TrackIt database table. |
Included in the ticket parent node. |
ticketNum |
The ticket's number. |
Included in the ticket parent node. |
updateTime |
The timestamp of when the last change was made to the ticket's information. |
Included in the ticket parent node. |
vehicleNum |
The equipment's identification number. | Included in the ticket parent node. |
workState |
The ticket's current state. |
Included in the ticket parent node. Values:
|
timeOff array
Parameter | Description | Notes |
---|---|---|
balanceRemaining |
The total remaining number of PTOHours provided by the employer that employees may use for sick, vacation, and personal days. hours an employee has. |
Included in the timeoff parent node. |
hours |
The total number of hours being requested for time off. |
Included in the timeoff parent node. |
exportCode |
The code used to indicate this time off type with your integrated payroll service. |
Included in the timeoff parent node. |
timeOffCategoryDescription |
The label that identifies the category of paid time offHours provided by the employer that employees may use for sick, vacation, and personal days.. |
Included in the timeoff parent node. |
timeOffTypeDescription |
The label that identifies the type of paid time off. |
Included in the timeoff parent node. |