Searches material, subcontract, and custom cost-type item transactions.

post

https://api.hcssapps.com/heavyjob/api/v1/transactions/search

Returns received, installed, and work-performed transactions across
all requested MSE types, ordered by date descending and grouped into
received and installed arrays. The installed
array contains installed materials, installed custom cost-type items,
and work performed. Received transactions are excluded when a cost
code or only-T&M filter is supplied, since they are not associated
with a cost code.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The request object describing the search filters.

Request body for searching material, subcontract work, and custom
cost-type item transactions through a single unified endpoint.

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.

costCodeIds

array of uuids | null

List of Cost Code Ids.

costCodeIds

modifiedSince

date-time | null

Optional.
Used to filter data by SyncTimestamp

onlyTM

boolean | null

The onlyTM optional parameter to filter to T&M data.

mseTypes

array of objects | null

Optional. The MSE types to include in the search.
When omitted, transactions across all MSE types (Material,
CustomType, and Subcontract) are returned.

mseTypes

Allowed:

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