CostCodeTransaction

Returns a paginated list of cost code time card transactions for the specified business unit or specified job list, or specified foreman list or specified date range.

Securitybearer
Request
query Parameters
includeCostsAndHours
boolean
Default: false
Request Body schema:
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.

costCodeIds
Array of strings or null <uuid>

List of Cost Code Ids.

Responses
post/api/v1/costCodeTimeCardTransactions/advancedRequest
Request samples
{
  • "businessUnitId": "81aa06f2-46ec-457f-9b35-ae6e05d4dbef",
  • "costCodeIds": [
    ],
  • "jobIds": [
    ],
  • "jobTagIds": [
    ],
  • "foremanIds": [
    ],
  • "startDate": "2022-08-06T00:00:00",
  • "endDate": "2022-08-06T00:00:00",
  • "cursor": "gCpeihFB1whbiZt1qIf1TbhL8TPbeRP2",
  • "limit": 500
}
Response samples
{
  • "results": [
    ],
  • "metadata": {
    }
}