Returns cost codes

post

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

VOLATILE
The query parameters and responses are likely to change. Do not use this operation for mission-critical applications yet.

This call returns a list of cost codes for the specified business unit, jobs, job tags, and cost codes

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The request object for getting cost codes.

Request body for querying cost codes with advanced filtering.

businessUnitId

uuid | null

Business Unit Id

jobIds

array of uuids | null

List of job IDs

jobIds

costCodeIds

array of uuids | null

List of cost code Ids

costCodeIds

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.

jobTagIds

array of uuids | null

List of job tag IDs

jobTagIds

excludedJobIds

array of uuids | null

List of excluded job IDs

excludedJobIds

searchString

string | null

Search string to filter cost codes by name or code.

jobStatuses

array of objects | null

Job statuses to filter cost codes by associated job status.

jobStatuses

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