CostCodeTag

Returns cost code setup tags with their groups

This call returns a list of cost code setup tags with their groups.

Securitybearer
Request
query Parameters
businessUnitId
required
string <uuid>

The business unit ID you are requesting setup filters for.

modifiedSince
string <date-time>
Responses
get/api/v1/costCodeSetupFilters
Request samples 
Response samples 
application/json
[
  • {
    }
]
Returns a list of cost code - tag relationships.
Securitybearer 
Request 
query Parameters
jobId
string <uuid> 
The job ID.


 
costCodeId
string <uuid> 
The cost code ID.


 
tagId
string <uuid> 
The tag ID.


 
modifiedSince
string <date-time> 
The date of your last update.


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


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


 
Responses 
get/api/v1/costCodeTags
Request samples 
Deletes cost code - tag relationships.
Securitybearer 
Request 
query Parameters
jobId
string <uuid> 
The job ID.


 
costCodeId
string <uuid> 
The cost code ID.


 
tagId
string <uuid> 
The tag ID.


 
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.


delete/api/v1/costCodeTags
Request samples 
Upserts cost code setup tags
This call creates and updates setup tags associated with cost codes.


Securitybearer 
Request 
Request Body schema: 
required
The list of cost codes and associated setup tag to be created or updated.


 Array ([ 1 .. 1000 ] items)
costCodeId
required
string <uuid> 
The cost code id.


 
tagId
required
string <uuid> 
The tag id.


 
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.


patch/api/v1/costCodeTags
Request samples 
[
  • {
    },
  • {
    },
  • {
    }
]
Returns cost codes with associated setup tags
This call will return a list of cost codes and their associated setup tags for the specified cost codes, jobs, tags or modified since date.


Securitybearer 
Request 
Request Body schema: 
Set of filters for the request.


costCodeIds
Array of strings or null <uuid> 
List of Cost Code Ids.


 
jobIds
Array of strings or null <uuid> 
List of Job Ids.


 
tagIds
Array of strings or null <uuid> 
List of Tag Ids.


 
modifiedSince
string or null <date-time> 
The date since the last update.


 
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.


 
Responses 
post/api/v1/costCodeTags/advancedRequest
Request samples 
{
  • "costCodeIds": [
    ],
  • "jobIds": [
    ],
  • "tagIds": [
    ],
  • "modifiedSince": "2022-08-01T00:00:00",
  • "cursor": "gCpeihFB1whbiZt1qIf1TbhL8TPbeRP2",
  • "limit": 1000
}
Response samples 
application/json
[
  • {
    }
]