Create a JC Job Cost Code (Job Phases)
    • 04 Nov 2025
    • 3 Minutes to read
    • Dark
      Light

    Create a JC Job Cost Code (Job Phases)

    • Dark
      Light

    Article summary

    Post
    /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

    UI Navigation

    Project Controls > Job Costing > Job > Assigned Cost Codes

    Reference Article

    Job Costing – Assign Cost Codes (Phases)

    Job Costing – Enter Cost Codes

    jcjobcostcodes Attributes (required)

    CMiC UI FieldnameObjectNameDescriptionTypeData LengthExample
    Cost Code Active FlagjcjobcostcodesGjjpActiveFlagThis flag identifies if the cost code is active on the system.string1Y=Job-Phase is active;  N=Job-Phase is inactive.
    Cost CodejcjobcostcodesGjjpCodeThis is the Cost (Phase) code. Can also be the sub-cost code.string1602
    Company CodejcjobcostcodesGjjpCompCodestring8001
    Cost Code Control CodejcjobcostcodesGjjpCtrlCodeThis 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.string16Default – ‘ALL’, or any other alphanumeric combination. For example ‘02.100’
    Factorable FlagjcjobcostcodesGjjpFactorableFlgThis 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.string1Y/N
    Job CodejcjobcostcodesGjjpJobCodeThis is the Job Code this cost code is assigned to. Must be a valid Job Code in CMiC.string1015600GC
    Job Control CodejcjobcostcodesGjjpJobCtrlCodeThis is the Control Job Code this cost code record belongs to. Must be a valid Control Job Code in CMiC.string10ALL
    Cost Code NamejcjobcostcodesGjjpNameThis is the name of the Cost code.string50Masonry
    Stored Forecast Approval FlagjcjobcostcodesGjjpStoreFcastApprovedFlgThis is the Stored Forecast Approval Flag. When ‘Y’, the forcast is stored as approved.string1Y/N
    VuuidjcjobcostcodesGjjpVUuidThis is the unique identifier code used for the specific cost code record.string64
    Security
    HTTP
    Type basic

    Basic authentication

    Header parameters
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceitem+json
    Body parameters
    object
    Example{ "GjjpCompCode": "001", "GjjpJobCode": "00100", "GjjpCode": "002", "GjjpActiveFlag": "Y", "GjjpStoreFcastApprovedFlg": "N", "GjjpFactorableFlg": "N", "GjjpCtrlCode": "00", "GjjpJobCtrlCode": "ALL", "GjjpName": "Drawings", "GjjpVUuid": "" }
    Responses
    201

    Created

    Headers
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceitem+json
    example-0

    Successful Response

    {
      "GjjpActComplDate": null,
      "GjjpActStartDate": null,
      "GjjpActiveFlag": "Y",
      "GjjpAttachOraseq": null,
      "GjjpBillCode": null,
      "GjjpBillName": null,
      "GjjpBillingRateTableCode": null,
      "GjjpBillingTypeCode": null,
      "GjjpBillingUnitFlag": null,
      "GjjpBudgUnit": null,
      "GjjpChgOrdUnit": null,
      "GjjpClvValueCode1": null,
      "GjjpClvValueCode2": null,
      "GjjpClvValueCode3": null,
      "GjjpClvValueCode4": null,
      "GjjpClvValueCode5": null,
      "GjjpClvValueCode6": null,
      "GjjpCode": "002",
      "GjjpCompCode": "001",
      "GjjpComplUnit": null,
      "GjjpCreateDate": null,
      "GjjpCtrlCode": "00",
      "GjjpEbudgCostAmt": null,
      "GjjpEbudgRevenueAmt": null,
      "GjjpEqpOraseq": null,
      "GjjpEstComplDate": null,
      "GjjpEstStartDate": null,
      "GjjpFactor": null,
      "GjjpFactorableFlg": "N",
      "GjjpFinalProductFlag": null,
      "GjjpHbRecAmt": null,
      "GjjpHier": null,
      "GjjpInvoiceFormatCode": null,
      "GjjpItemCode": null,
      "GjjpItemCompCode": null,
      "GjjpItemTypeCode": null,
      "GjjpIuCreateDate": null,
      "GjjpIuUpdateDate": null,
      "GjjpJobCode": "00100",
      "GjjpJobCtrlCode": "ALL",
      "GjjpMaxBillingAmt": null,
      "GjjpMaxBillingBudgetAmt": null,
      "GjjpName": "Drawings",
      "GjjpObudgCostAmt": null,
      "GjjpObudgRevenueAmt": null,
      "GjjpObudgUnit": null,
      "GjjpPhsTypeCode": null,
      "GjjpPriorComplUnit": null,
      "GjjpProjQty": null,
      "GjjpProjThresholdPct": null,
      "GjjpQraOverrideIndicator": null,
      "GjjpRecAmt": null,
      "GjjpSingleCatBudgFlag": null,
      "GjjpStatusCode": null,
      "GjjpStoreFcastApprovedFlg": "N",
      "GjjpUeValidFlag": null,
      "GjjpUnitFcastAttachOraseq": null,
      "GjjpUserEnteredProjQty": null,
      "GjjpWmCode": null,
      "GjjpVUuid": "03210A6E8A8A6B82E06316821FACF1C1",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcostcodes/03210A6E8A8A6B82E06316821FACF1C1",
          "name": "jcjobcostcodes",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcostcodes/03210A6E8A8A6B82E06316821FACF1C1",
          "name": "jcjobcostcodes",
          "kind": "item"
        }
      ]
    }
    example-1

    Successful Response

    {
      "GjjpActComplDate": null,
      "GjjpActStartDate": null,
      "GjjpActiveFlag": "Y",
      "GjjpAttachOraseq": null,
      "GjjpBillCode": null,
      "GjjpBillName": null,
      "GjjpBillingRateTableCode": null,
      "GjjpBillingTypeCode": null,
      "GjjpBillingUnitFlag": null,
      "GjjpBudgUnit": null,
      "GjjpChgOrdUnit": null,
      "GjjpClvValueCode1": null,
      "GjjpClvValueCode2": null,
      "GjjpClvValueCode3": null,
      "GjjpClvValueCode4": null,
      "GjjpClvValueCode5": null,
      "GjjpClvValueCode6": null,
      "GjjpCode": "002",
      "GjjpCompCode": "001",
      "GjjpComplUnit": null,
      "GjjpCreateDate": null,
      "GjjpCtrlCode": "00",
      "GjjpEbudgCostAmt": null,
      "GjjpEbudgRevenueAmt": null,
      "GjjpEqpOraseq": null,
      "GjjpEstComplDate": null,
      "GjjpEstStartDate": null,
      "GjjpFactor": null,
      "GjjpFactorableFlg": "N",
      "GjjpFinalProductFlag": null,
      "GjjpHbRecAmt": null,
      "GjjpHier": null,
      "GjjpInvoiceFormatCode": null,
      "GjjpItemCode": null,
      "GjjpItemCompCode": null,
      "GjjpItemTypeCode": null,
      "GjjpIuCreateDate": null,
      "GjjpIuUpdateDate": null,
      "GjjpJobCode": "00100",
      "GjjpJobCtrlCode": "ALL",
      "GjjpMaxBillingAmt": null,
      "GjjpMaxBillingBudgetAmt": null,
      "GjjpName": "Drawings",
      "GjjpObudgCostAmt": null,
      "GjjpObudgRevenueAmt": null,
      "GjjpObudgUnit": null,
      "GjjpPhsTypeCode": null,
      "GjjpPriorComplUnit": null,
      "GjjpProjQty": null,
      "GjjpProjThresholdPct": null,
      "GjjpQraOverrideIndicator": null,
      "GjjpRecAmt": null,
      "GjjpSingleCatBudgFlag": null,
      "GjjpStatusCode": null,
      "GjjpStoreFcastApprovedFlg": "N",
      "GjjpUeValidFlag": null,
      "GjjpUnitFcastAttachOraseq": null,
      "GjjpUserEnteredProjQty": null,
      "GjjpWmCode": null,
      "GjjpVUuid": "03210A6E8A8A6B82E06316821FACF1C1",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcostcodes/03210A6E8A8A6B82E06316821FACF1C1",
          "name": "jcjobcostcodes",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jc-rest-api/rest/1/jcjobcostcodes/03210A6E8A8A6B82E06316821FACF1C1",
          "name": "jcjobcostcodes",
          "kind": "item"
        }
      ]
    }
    object