API Catalog

Retrieve JC Job Phases By Code

22 Oct 2025
4 Minutes to read

Print
Dark
Light

Retrieve JC Job Phases By Code

Updated on 22 Oct 2025
4 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Get

/jc-rest-api/rest/1/jcjobcostcodes

Overview

Cost codes are used in combination with categories (categories of cost types) to specify a job’s cost elements. For example, a cost code for electrical work can have categories for materials, labor, and equipment associated to the cost code to allow specification of the cost code’s type of cost. The JCJobCostCodes endpoint allows the create, update and query of cost codes under a specified company and job combination.

Notes

Project Controls > Job Costing > Job > Assigned Cost Codes

Reference Article

Job Costing – Assign Cost Codes (Phases)

Job Costing – Enter Cost Codes

Path Parameters

Parameter	Description	Example
/VUUID	The VUuid attribute is the Unique row ID	E731F2DF0435AED6E053B08610AC219A

Query Standards

Key	Recommended	Description
finder	Yes	Filters data based on attributes. See finder details below. Finders can be combined using a comma delimiter between parameters that implies an "and" statement. For more information on using the finder functionality please see Best Practice	Data Filtering requirements
limit	Yes	A limit restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count, then the framework will return all available resources. For additional information on using the limit functionality please visit Best Practice	Data Filtering requirements
offset	Yes	The offset skips a specified number of items in a data list before it starts showing results. For example, if you set an offset of 10, it skips the first 10 items and begins showing from the 11th item. For additional information on using Offset functionality please visit Best Practice	Data Filtering requirements
orderBy	Yes	The orderBy attribute retrieves rows using an order ensuring the response payload displays data in the order supplied in the URL parameter using the GET method. For more information on using orderBy functionality please visit Best Practice	Data Filtering requirements

jcjobcostcodes Finders

Finder	Parameter	Data Type	Data Length	Description	Example
PrimaryKey	GjjpVUuid	string	64	This finder parameter queries a single cost code record by Vuuid.	/jc-rest-api/rest/1/jcjobcostcodes?finder=PrimaryKey;GjjpVUuid=E731F2DF042AAED6E053B08610AC219A
selectJobPhases	auditDate	datetime		This finder parameter queries cost codes based on the combined uICreate and uIUpdate dates. Supplying a date will return all records created or updated after that date, making it useful for retrieving only changes since the last invoice data pull. Can be combined with optional parameters ‘compCode’, ‘jobCode’ and ‘phaseCode’	/jc-rest-api/rest/1/jcjobcostcodes?finder=selectJobPhases;auditDate=2015-05-04
selectJobPhases	compCode	string	8	This finder parameter queries cost codes by Company Code. Can be combined with optional parameters ‘auditDate’, ‘jobCode’ and ‘phaseCode’	/jc-rest-api/rest/1/jcjobcostcodes?finder=selectJobPhases;compCode=001
selectJobPhases	jobCode	string	10	This finder parameter queries cost codes by Job Code. Can be combined with optional parameters ‘compCode’, ‘auditDate’ and ‘phaseCode’.	/jc-rest-api/rest/1/jcjobcostcodes?finder=selectJobPhases;jobCode=000001
selectJobPhases	phaseCode	string	16	This finder parameter queries cost codes by Cost Code. Can be combined with optional parameters ‘compCode’, ‘auditDate’ and ‘jobCode’.	/jc-rest-api/rest/1/jcjobcostcodes?finder=selectJobPhases;phaseCode=00

Example Payload (JSON):

{

"GjjpCompCode": "ZZ",

"GjjpJobCode": "PHTEST",

"GjjpCode": "01",

"GjjpName": "550 name",

"GjjpStoreFcastApprovedFlg": "N",

"GjjpActiveFlag": "Y",

"GjjpFactorableFlg": "N",

"GjjpCtrlCode": "ALL",

"GjjpJobCtrlCode": "ALL",

"GjjpVUuid": ""

}

jcjobcostcodes Attributes (required)

CMiC UI Fieldname	Object	Name	Description	Type	Data Length	Example
Cost Code Active Flag	jcjobcostcodes	GjjpActiveFlag	This flag identifies if the cost code is active on the system.	string	1	Y=Job-Phase is active; N=Job-Phase is inactive.
Cost Code	jcjobcostcodes	GjjpCode	This is the Cost (Phase) code. Can also be the sub-cost code.	string	16	02
Company Code	jcjobcostcodes	GjjpCompCode		string	8	001
Cost Code Control Code	jcjobcostcodes	GjjpCtrlCode	This is the Controling Cost Code. The highest level of a cost code is designated the controlling cost code, which can consist of one or more sub-cost codes. The relationship between the cost code and sub-cost code is established via this code. efines the cost code hierarchy. If the cost code being entered in this line is a controlling cost code, select "All" to establish the highest level of the cost component.	string	16	Default – ‘ALL’, or any other alphanumeric combination. For example ‘02.100’
Factorable Flag	jcjobcostcodes	GjjpFactorableFlg	This checkbox is only applicable to cost codes for public sector jobs. If checked, cost code quantity factoring (forecasting based on a factor) is allowed for this cost code. Also, the job’s 'Allow Cost Code Qty Factoring' checkbox must be checked on the Settings tab of the Enter Job screen.	string	1	Y/N
Job Code	jcjobcostcodes	GjjpJobCode	This is the Job Code this cost code is assigned to. Must be a valid Job Code in CMiC.	string	10	15600GC
Job Control Code	jcjobcostcodes	GjjpJobCtrlCode	This is the Control Job Code this cost code record belongs to. Must be a valid Control Job Code in CMiC.	string	10	ALL
Cost Code Name	jcjobcostcodes	GjjpName	This is the name of the Cost code.	string	50	Masonry
Stored Forecast Approval Flag	jcjobcostcodes	GjjpStoreFcastApprovedFlg	This is the Stored Forecast Approval Flag. When ‘Y’, the forcast is stored as approved.	string	1	Y/N
Vuuid	jcjobcostcodes	GjjpVUuid	This is the unique identifier code used for the specific cost code record.	string	64

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExampleselectJobPhases;jobCode=00100, phaseCode=00015, compCode=001, auditDate=2016-01-01

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

Exampletrue

orderBy

string

ExampleGjjpVUuid:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

{
  "items": [
    {
      "GjjpActComplDate": null,
      "GjjpActStartDate": null,
      "GjjpActiveFlag": "Y",
      "GjjpAttachOraseq": 829398435,
      "GjjpBillCode": null,
      "GjjpBillName": null,
      "GjjpBillingRateTableCode": null,
      "GjjpBillingTypeCode": null,
      "GjjpBillingUnitFlag": "Y",
      "GjjpBudgUnit": null,
      "GjjpChgOrdUnit": null,
      "GjjpClvValueCode1": null,
      "GjjpClvValueCode2": null,
      "GjjpClvValueCode3": null,
      "GjjpClvValueCode4": null,
      "GjjpClvValueCode5": null,
      "GjjpClvValueCode6": null,
      "GjjpCode": "00015",
      "GjjpCompCode": "001",
      "GjjpComplUnit": null,
      "GjjpCreateDate": "2022-10-20T18:26:03Z",
      "GjjpCtrlCode": "00",
      "GjjpEbudgCostAmt": null,
      "GjjpEbudgRevenueAmt": null,
      "GjjpEqpOraseq": null,
      "GjjpEstComplDate": null,
      "GjjpEstStartDate": null,
      "GjjpFactor": null,
      "GjjpFactorableFlg": "N",
      "GjjpFinalProductFlag": null,
      "GjjpHbRecAmt": null,
      "GjjpHier": "001     00100     00              00015           ",
      "GjjpInvoiceFormatCode": null,
      "GjjpItemCode": null,
      "GjjpItemCompCode": null,
      "GjjpItemTypeCode": null,
      "GjjpIuCreateDate": "2022-10-20T18:26:03Z",
      "GjjpIuUpdateDate": "2023-01-25T04:35:30Z",
      "GjjpJobCode": "00100",
      "GjjpJobCtrlCode": "ALL",
      "GjjpMaxBillingAmt": null,
      "GjjpMaxBillingBudgetAmt": null,
      "GjjpName": "Drawings",
      "GjjpObudgCostAmt": null,
      "GjjpObudgRevenueAmt": null,
      "GjjpObudgUnit": 0,
      "GjjpPhsTypeCode": null,
      "GjjpPriorComplUnit": null,
      "GjjpProjQty": null,
      "GjjpProjThresholdPct": null,
      "GjjpQraOverrideIndicator": null,
      "GjjpRecAmt": null,
      "GjjpSingleCatBudgFlag": null,
      "GjjpStatusCode": "P",
      "GjjpStoreFcastApprovedFlg": "N",
      "GjjpUeValidFlag": "Y",
      "GjjpUnitFcastAttachOraseq": 829398436,
      "GjjpUserEnteredProjQty": null,
      "GjjpWmCode": "LS",
      "GjjpVUuid": "EB75B7A51AA77F0AE05316821FAC1C51",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcostcodes/EB75B7A51AA77F0AE05316821FAC1C51",
          "name": "jcjobcostcodes",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcostcodes/EB75B7A51AA77F0AE05316821FAC1C51",
          "name": "jcjobcostcodes",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 50,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcostcodes",
      "name": "jcjobcostcodes",
      "kind": "collection"
    }
  ]
}

object

What's Next

Create a JC Job Master Category Code

Retrieve JC Job Phases By Code

Overview

Notes

UI Navigation

Reference Article

Path Parameters

Query Standards

jcjobcostcodes Finders

jcjobcostcodes Attributes (required)

What's Next

Contact Us