TimeCard

Returns time card approvals

This call returns a paginated list of time card summary information with approvals for the specified job, foreman, and date range. If there are additional pages, the response metadata will include a "nextCursor" field. That field should be passed as the "cursor" query parameter to request the next page of results.

Securitybearer
Request
query Parameters
jobId
string <uuid>

The job guid. If omitted, returns time cards across all jobs.

foremanId
string <uuid>

The foreman guid. If omitted, returns time cards across all foremen.

employeeId
string <uuid>

If specified, returns only time cards having this employee.

startDate
string <date-time>

The start date in yyyy-MM-dd format. If omitted, returns time cards from the beginning of time. (bounded by the end date).

endDate
string <date-time>

The end date in yyyy-MM-dd format. If omitted, returns time cards until the end of time. (bounded by the start date).

modifiedSince
string <date-time>

If specified, returns only records that have been modified since this time. In RFC-3339 format. (yyyy-MM-ddThh:mm:ssZ) Or (yyyy-MM-ddThh:mm:ss.FFFFFFFZ)

cursor
string

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

limit
integer <int32>
Default: 1000

The maximum number of results that should be returned.

isApproved
boolean

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

isAccepted
boolean

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

isReviewed
boolean

Optional. When true, returns only time cards with a status of accepted. This combines with isAccepted and isApproved parameters with AND logic.

businessUnitId
string <uuid>

Optional. The business unit ID. If omitted, returns time cards for all business units.

Responses
get/api/v1/timeCardApprovalInfo
Request samples 
Response samples 
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}
Returns time cards
This call returns a paginated list of time card summary information for the specified job, foreman, and date range.
If there are additional pages, the response metadata will include a "nextCursor" field.  That field should be passed as the "cursor" query parameter to request the next page of results.


Securitybearer 
Request 
query Parameters
jobId
string <uuid> 
The job guid.  If omitted, returns time cards across all jobs.


 
foremanId
string <uuid> 
The foreman guid.  If omitted, returns time cards across all foremen.


 
employeeId
string <uuid> 
If specified, returns only time cards having this employee.


 
startDate
string <date-time> 
The start date in yyyy-MM-dd format.  If omitted, returns time cards from the beginning of time. (bounded by the end date).


 
endDate
string <date-time> 
The end date in yyyy-MM-dd format.  If omitted, returns time cards until the end of time.  (bounded by the start date).


 
modifiedSince
string <date-time> 
If specified, returns only records that have been modified since this time.  In RFC-3339 format.  (yyyy-MM-ddThh:mm:ssZ) Or (yyyy-MM-ddThh:mm:ss.FFFFFFFZ)


 
onlyTM
boolean
If true, returns only time cards with costs codes marked as T&M


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


 
limit
integer <int32> 
 Default:  1000
The maximum number of results that should be returned.


 
isApproved
boolean
Optional. When set, returns only time cards with a status of approved.


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


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


 
businessUnitId
string <uuid> 
Optional. The business unit ID. If omitted, returns time cards for all business units.


 
Responses 
get/api/v1/timeCardInfo
Request samples 
Response samples 
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}
Returns time cards
This call returns a paginated list of time card summary information containing job tags, accounting values, and foremen summary for the specified request filters.


Securitybearer 
Request 
Request Body schema: 
Set of optional filters for the request, including jobs, foremen, date range, and time card statuses.


businessUnitId
string or null <uuid> 
Business Unit ID


 
object (ApiTimeCardJobFilters) 
Flags to include jobs


 
object (ApiTimeCardFlagFilters) 
Flags to include time cards based on their status


 
object (ApiTimeCardForemanFilters) 
Flags to filter foreman employees


 
startDate
string or null <date-time> 
Start date for filtering time cards


 
endDate
string or null <date-time> 
End date for filtering time cards


 
modifiedSince
string or null <date-time> 
Filter time cards modified since this date


 
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 <int32> 
The maximum number of results that should be returned.


 
Responses 
post/api/v1/timeCardInfo/search
Request samples 
{
  • "businessUnitId": "214dd610-35bc-4504-9246-7073493e0400",
  • "jobs": {
    },
  • "timeCards": {
    },
  • "foremen": {
    },
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "modifiedSince": "2019-08-24T14:15:22Z",
  • "cursor": "string",
  • "limit": 0
}
Response samples 
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}
Returns the time card with the specified id.
Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
 
Responses 
get/api/v1/timeCards/{id}
Request samples 
Response samples 
application/json
{
  • "id": "5a6d4a4c-f061-4b02-bbcd-c9f92fbb8819",
  • "foremanId": "bcce40ea-d3c5-40ff-99ec-b60fe146cf39",
  • "foremanCode": "SMITH",
  • "foremanDescription": "John Smith",
  • "jobId": "cc5f264d-e277-40ea-b313-c68c532cbac1",
  • "jobCode": "016-FLD",
  • "jobDescription": "Fountain lake subdivision",
  • "businessUnitId": "e1afcb90-9514-446d-b3e7-d0948827ab5c",
  • "businessUnitCode": "MANAGER",
  • "businessUnitDescription": "Non-enterprise",
  • "date": "2019-01-01",
  • "shift": 2,
  • "revision": 5,
  • "isApproved": true,
  • "approvedById": "e78a0d3c-02ab-440b-b3ce-bb1048f52366",
  • "isReviewed": true,
  • "reviewedById": "af212780-f139-4474-b55e-38a649fd42a6",
  • "isAccepted": true,
  • "acceptedById": "ed674c6a-a6b9-4d0c-b43b-bd544bac806f",
  • "isRejected": false,
  • "sentToPayrollRevision": 0,
  • "sentToPayrollDateTime": "2019-03-03T15:30:00Z",
  • "lastModifiedDateTime": "2019-03-01T12:05:05Z",
  • "lockedDateTime": "2019-02-25T17:29:11Z",
  • "costCodes": [
    ],
  • "employees": [
    ],
  • "equipment": [
    ]
}
Updates time card
Updates an existing time card by id. Sent-to-payroll revision and sent-to-payroll datetime are the only fields supported at this time.


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The id of the time card to be updated.


 
Request Body schema: 
required
The set of values to be updated. Currently only sent-to-payroll revision and sent-to-payroll datetime.


sentToPayrollRevision
required
integer <int32> 
The revision of the time card sent to payroll.


 
sentToPayrollDateTime
required
string <date-time> 
When the time card was sent to payroll.


 
Responses 
204
No Content


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.


404
The specified resource is not found.


put/api/v1/timeCards/{id}
Request samples 
{
  • "sentToPayrollRevision": 2,
  • "sentToPayrollDateTime": "2019-12-10T10:20:15Z"
}
Returns list of foremen with missing time cards for a specified business unit and date who have previously submitted in a specified date range.
Securitybearer 
Request 
path Parameters
businessUnitId
required
string <uuid> 
The business unit guid defaulted to the user's current business unit.


 
query Parameters
startDate
required
string <date-time> 
The start date in yyyy-MM-dd format. (bound by the end date)


 
endDate
required
string <date-time> 
The end date in yyyy-MM-dd format. (bound by the start date)


 
targetDate
required
string <date-time> 
The time card date in yyyy-MM-dd format.


 
Responses 
get/api/v1/businessUnits/{businessUnitId}/missingTimeCards
Request samples 
Response samples 
application/json
[
  • {
    }
]
Returns time card data using a piece of equipment
This call returns time card data for time cards that used a given piece of equipment on a given date.


Securitybearer 
Request 
query Parameters
equipmentId
string <uuid> 
The equipment Id to search for


 
equipmentCode
string
The equipment code to search for (optional instead of equipmentId)


 
date
string <date-time> 
The date to search on


 
Responses 
get/api/v1/timeCardEquipment
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    }
]