Hours

Returns employee time card hours

This call returns a paginated list of employee time card hours and cost adjustments for the specified business unit, jobs, foremen, employees, and date range.

Securitybearer

Request

Request Body schema:
application/json

Set of filters for the request.

jobIds	Array of strings or null <uuid> List of Job Ids. Used with JobTagIds to limit jobs. Returns jobs with JobIds and JobTagIds.
jobTagIds	Array of strings or null <uuid> List of Job Tag Ids. Used with JobIds to limit jobs. Returns jobs with JobIds and JobTagIds.
foremanIds	Array of strings or null <uuid> List of Foreman Ids. Used to limit transactions. Returns transactions only for foremen specified.
startDate	string or null <date-time> Beginning local date (yyyy-MM-dd) of date range. Used with EndDate. Transactions whose dates fall within this date range will be included.
endDate	string or null <date-time> End local date (yyyy-MM-dd) of date range. Used with StartDate. Transactions whose dates fall within this date range will be included.
cursor	string or null Optional. When there are additional results, the metadata nextCursor field should be passed to retrieve the next page of results.
limit	integer or null <int32> The maximum number of results that should be returned.
businessUnitId	string or null <uuid> The business unit id.
includeAllJobs	boolean If the other job filters are not used, and parameter is set to true, transactions for active and non-active jobs will be returned.
employeeIds	Array of strings or null <uuid> List of Employee Ids. Used to limit transactions. Returns transactions only for employees specified.

Responses

200

Success

400

Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

post/api/v1/hours/employees

Request samples

{"businessUnitId": "c2e2ddb8-513d-424d-a65f-99feae96551e",
"includeAllJobs": false,
"employeeIds": ["c2e2ddb8-513d-424d-a65f-99feae96551e",
"8cb64519-9938-43e0-a947-4002f1dcc6e5"
],
"jobIds": ["565947f8-528c-4667-9351-8db02eab1157"
],
"jobTagIds": ["39bda327-ada0-4aab-ab03-a3fe621cc547"
],
"foremanIds": ["c28aee2e-6e0e-4c91-a82a-931417c12f9e"
],
"startDate": "2022-08-06T00:00:00",
"endDate": "2022-08-06T00:00:00",
"cursor": "gCpeihFB1whbiZt1qIf1TbhL8TPbeRP2",
"limit": 500
}

Response samples

application/json

{"results": [{"employee": {"employeeId": "8b25782d-5085-4f63-b635-a0cbcce0ed47",
"employeeCode": "EMPCODE",
"employeeFirstName": "Employee",
"employeeLastName": "Name"
},
"foreman": {"employeeId": "d01d3fb9-c579-4cb7-b405-60c7eaa791ec",
"employeeCode": "FOREMANCODE",
"employeeFirstName": "Foreman",
"employeeLastName": "Name"
},
"job": {"jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobCode": "HCSS-BLDG3",
"jobDescription": "Third building on the HCSS campus"
},
"payClass": {"payClassId": "ec8cecdf-24d2-4aaa-8a43-868e22b4fc1d",
"payClassCode": "PC1",
"payClassDescription": "Pay Class 1"
},
"date": "2022-08-06",
"notes": "Time card notes",
"startTime": "12:45",
"endTime": "22:45",
"meal1Start": "16:45",
"meal1End": "17:15",
"meal2Start": "20:30",
"meal2End": "20:45",
"break1": "30",
"break2": "15",
"timeCardShift": 2,
"timeCardRevision": 5,
"hoursDetails": [{"costCode": {"costCodeId": "5d05001a-acde-4203-a38c-684bb5f47a33",
"costCodeCode": "CC1",
"costCodeDescription": "Cost Code 1"
},
"regularHours": 6,
"overtimeHours": 2,
"otherHours": 2,
"hourTag": {"hourTagId": "007306b1-6bf4-4e79-a866-87ccb38161e4",
"hourTagCode": "H",
"hourTagDescription": "Hour Tag"
},
"isInTimeCardHours": true,
"isCosted": false,
"costAdjustmentCosts": [{"costAdjustment": {"costAdjustmentId": "9d1ace9f-58b2-45d4-bd17-0d454ecb5b4b",
"costAdjustmentCode": "CA1",
"costAdjustmentDescription": "Cost Adjustment 1"
},
"cost": 150.75
}
]
}
],
"costAdjustmentQuantities": [{"costAdjustment": {"costAdjustmentId": "9d1ace9f-58b2-45d4-bd17-0d454ecb5b4b",
"costAdjustmentCode": "CA1",
"costAdjustmentDescription": "Cost Adjustment 1"
},
"quantity": 25.5
}
]
}
],
"metadata": {"nextCursor": "DGDS93EaYwDQj4ggr0meNz6T7vkZpDqxLFIs2leWDww"
}
}

Returns equipment time card hours

This call returns a paginated list of equipment time card hours for the specified business unit, jobs, foremen, equipment, and date range.

Securitybearer

Request

Request Body schema:
application/json

Set of filters for the request.

jobIds	Array of strings or null <uuid> List of Job Ids. Used with JobTagIds to limit jobs. Returns jobs with JobIds and JobTagIds.
jobTagIds	Array of strings or null <uuid> List of Job Tag Ids. Used with JobIds to limit jobs. Returns jobs with JobIds and JobTagIds.
foremanIds	Array of strings or null <uuid> List of Foreman Ids. Used to limit transactions. Returns transactions only for foremen specified.
startDate	string or null <date-time> Beginning local date (yyyy-MM-dd) of date range. Used with EndDate. Transactions whose dates fall within this date range will be included.
endDate	string or null <date-time> End local date (yyyy-MM-dd) of date range. Used with StartDate. Transactions whose dates fall within this date range will be included.
cursor	string or null Optional. When there are additional results, the metadata nextCursor field should be passed to retrieve the next page of results.
limit	integer or null <int32> The maximum number of results that should be returned.
businessUnitId	string or null <uuid> The business unit id.
includeAllJobs	boolean If the other job filters are not used, and parameter is set to true, transactions for active and non-active jobs will be returned.
equipmentIds	Array of strings or null <uuid> List of Equipment Ids. Used to limit transactions. Returns transactions only for equipment specified.

Responses

200

Success

400

Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

post/api/v1/hours/equipment

Request samples

{"businessUnitId": "c2e2ddb8-513d-424d-a65f-99feae96551e",
"includeAllJobs": false,
"equipmentIds": ["c2e2ddb8-513d-424d-a65f-99feae96551e",
"8cb64519-9938-43e0-a947-4002f1dcc6e5"
],
"jobIds": ["565947f8-528c-4667-9351-8db02eab1157"
],
"jobTagIds": ["39bda327-ada0-4aab-ab03-a3fe621cc547"
],
"foremanIds": ["c28aee2e-6e0e-4c91-a82a-931417c12f9e"
],
"startDate": "2022-08-06T00:00:00",
"endDate": "2022-08-06T00:00:00",
"cursor": "gCpeihFB1whbiZt1qIf1TbhL8TPbeRP2",
"limit": 500
}

Response samples

application/json

{"results": [{"equipment": {"equipmentId": "8b25782d-5085-4f63-b635-a0cbcce0ed47",
"equipmentCode": "EQPCODE",
"equipmentDescription": "Equipment",
"isRental": false
},
"foreman": {"employeeId": "d01d3fb9-c579-4cb7-b405-60c7eaa791ec",
"employeeCode": "FOREMANCODE",
"employeeFirstName": "Foreman",
"employeeLastName": "Name"
},
"job": {"jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"jobCode": "HCSS-BLDG3",
"jobDescription": "Third building on the HCSS campus"
},
"date": "2022-08-06",
"notes": "Time card notes",
"startTime": "12:45",
"endTime": "22:45",
"meterStart": 1000,
"meterStop": 1050,
"engineOffDuration": "15",
"timeCardShift": 2,
"timeCardRevision": 5,
"hoursDetails": [{"costCode": {"costCodeId": "5d05001a-acde-4203-a38c-684bb5f47a33",
"costCodeCode": "CC1",
"costCodeDescription": "Cost Code 1"
},
"totalHours": 6,
"ownershipHours": 2,
"operatingHours": 2,
"hourTag": {"hourTagId": "007306b1-6bf4-4e79-a866-87ccb38161e4",
"hourTagCode": "H",
"hourTagDescription": "Hour Tag"
},
"isInTimeCardHours": true,
"isCosted": false
}
],
"gpsId": "MyGPSFieldId"
}
],
"metadata": {"nextCursor": "DGDS93EaYwDQj4ggr0meNz6T7vkZpDqxLFIs2leWDww"
}
}

Hours

Returns employee time card hours

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Returns equipment time card hours

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json

Request Body schema:
application/json

Request Body schema:
application/json