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:

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.

includeInactiveEmployees
boolean

Filter to include inactive employees.

modifiedSince
string or null <date-time>

The modifiedSince datetime.

employeeIds
Array of strings or null <uuid>

List of Employee Ids. Used to limit transactions. Returns transactions only for employees specified.

isApproved
boolean or null

Optional. When set, returns only timecards with a status of approved.

isAccepted
boolean or null

Optional. When true, returns only timecards with a status of accepted. This combines with isApproved and isReviewed parameters with AND logic.

isReviewed
boolean or null

Optional. When set, returns only timecards with a status of accepted. This combines with isAccepted and isApproved parameters with AND logic.

Responses
post/api/v1/hours/employees
Request samples
{
  • "businessUnitId": "c2e2ddb8-513d-424d-a65f-99feae96551e",
  • "includeAllJobs": true,
  • "includeInactiveEmployees": false,
  • "modifiedSince": "2022-08-06T00:00:00",
  • "employeeIds": [
    ],
  • "isApproved": true,
  • "isAccepted": true,
  • "isReviewed": true,
  • "jobIds": [
    ],
  • "jobTagIds": [
    ],
  • "foremanIds": [
    ],
  • "startDate": "2022-08-06T00:00:00",
  • "endDate": "2022-08-06T00:00:00",
  • "cursor": "gCpeihFB1whbiZt1qIf1TbhL8TPbeRP2",
  • "limit": 500
}
Response samples
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}

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:

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.

includeInactiveEquipment
boolean

Filter to include inactive equipment.

equipmentIds
Array of strings or null <uuid>

List of Equipment Ids. Used to limit transactions. Returns transactions only for equipment specified.

modifiedSince
string or null <date-time>

The date since the last update.

linkedEmployeeIds
Array of strings or null <uuid>

List of linked employee ids. Used to limit transactions. Returns transactions only for linked employees specified.

isApproved
boolean or null

Optional. When set, returns only timecards with a status of approved.

isAccepted
boolean or null

Optional. When true, returns only timecards with a status of accepted. This combines with isApproved and isReviewed parameters with AND logic.

isReviewed
boolean or null

Optional. When set, returns only timecards with a status of accepted. This combines with isAccepted and isApproved parameters with AND logic.

Responses
post/api/v1/hours/equipment
Request samples
{
  • "businessUnitId": "c2e2ddb8-513d-424d-a65f-99feae96551e",
  • "includeAllJobs": true,
  • "includeInactiveEquipment": false,
  • "equipmentIds": [
    ],
  • "modifiedSince": "2024-06-26T00:00:00Z",
  • "linkedEmployeeIds": [
    ],
  • "isApproved": true,
  • "isAccepted": true,
  • "isReviewed": true,
  • "jobIds": [
    ],
  • "jobTagIds": [
    ],
  • "foremanIds": [
    ],
  • "startDate": "2022-08-06T00:00:00",
  • "endDate": "2022-08-06T00:00:00",
  • "cursor": "gCpeihFB1whbiZt1qIf1TbhL8TPbeRP2",
  • "limit": 500
}
Response samples
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}