Returns equipment time card hours

post

https://api.hcssapps.com/heavyjob/api/v1/hours/equipment

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Set of filters for the request.

A model that represents an advanced request to find equipment hours.

jobIds

array of uuids | null

List of Job Ids.
Used with JobTagIds to limit jobs. Returns jobs with JobIds and JobTagIds.

jobIds

jobTagIds

array of uuids | null

List of Job Tag Ids.
Used with JobIds to limit jobs. Returns jobs with JobIds and JobTagIds.

jobTagIds

foremanIds

array of uuids | null

List of Foreman Ids.
Used to limit transactions. Returns transactions only for foremen specified.

foremanIds

startDate

date-time | null

Beginning local date (yyyy-MM-dd) of date range.
Used with EndDate. Transactions whose dates fall within this date range will be included.

endDate

date-time | null

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 | null

Optional.
When there are additional results, the metadata nextCursor field should be passed to retrieve the next page of results.

limit

int32 | null

The maximum number of results that should be returned.

businessUnitId

uuid | null

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 uuids | null

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

equipmentIds

modifiedSince

date-time | null

The date since the last update.

linkedEmployeeIds

array of uuids | null

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

linkedEmployeeIds

isApproved

boolean | null

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

isAccepted

boolean | null

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

isReviewed

boolean | null

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

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

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.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK