Patch
/jc-rest-api/rest/2/jcjobcategory/4E3680B7126A0823E0630B811DAC767F
Overview
PATCH will allow users to update any specific job cost budget category.
UI Navigation
Project Controls > Job Costing > Job > Enter Budget
Reference Article
Body Parameters
| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Required | Updatable |
|---|---|---|---|---|---|---|---|---|
| jcjobcategory | JcatCatActiveFlag | Category Active Flag - A flag indicating whether the specific category is active ("Y") or not ("N"). Note that inactive categories will not be available for any transaction entry or posting | string | 1 | N | Yes | Yes | |
| Actual Labor Amount | jcjobcategory | JcatActLbAmt | Actual Labor Amount - Represents the actual monetary amount allocated or spent on labor within the specific job code/cost code/category code combination. Not updatable. | BigDecimal | 18,2 | 10000 | No | Yes |
| Add-On Amount | jcjobcategory | JcatAddonAmt | Add-On Amount has been deprecated and should no longer be used. | BigDecimal | 18,2 | No | Yes | |
| Billing Amount | jcjobcategory | JcatBillAmt | The total billing amount posted against a specific job/cost code/category combination. This reflects the invoiced charges to clients or stakeholders for the work performed. Not updatable. | BigDecimal | 18,2 | 10000 | No | Yes |
| Budget Adjustment Amount | jcjobcategory | JcatBudgAdjustmentAmt | The amount by which the original cost budget has been adjusted. | BigDecimal | 18,2 | No | Yes | |
| Budget Amount | jcjobcategory | JcatBudgAmt | The current cost budgeted amount. | BigDecimal | 18,2 | 12000 | No | Yes |
| Budget Revenue Amount | jcjobcategory | JcatBudgRevenueAmt | The current revenue budgeted amount. | BigDecimal | 18,2 | No | Yes | |
| Budget Unit | jcjobcategory | JcatBudgUnit | The current cost budgeted units. | Number | 500 | No | Yes | |
| Budget Unit Rate | jcjobcategory | JcatBudgUnitRate | The current cost budget unit rate. | BigDecimal | 20,4 | 300 | No | Yes |
| Committed Unit | jcjobcategory | JcatCommUnit | Current units complete. Refers to the total units that are completed and posted against the phase/cost code containing the given category in a job | Number | No | Yes | ||
| Completion Unit | jcjobcategory | JcatComplUnit | Current units complete. Refers to the total units that are completed and posted against the phase/cost code containing the given category in a job. | Number | No | Yes | ||
| Cost to Complete Override Flag | jcjobcategory | JcatCostToComplOvrdFlg | A flag indicating whether the Contract Forecast - Cost to Complete amount has been overridden ("Y") or not ("N"). | string | 1 | Yes | Yes | |
| Cost Amount | jcjobcategory | JcatCostAmt | Current cost amount. Refers to the total costs incurred for the given job code/cost code/category code. This includes all expenses related to labor, materials, and other resources. | BigDecimal | 18,2 | No | Yes | |
| Cost Entry | jcjobcategory | JcatCstEntry | has been deprecated and should no longer be used. | string | 1 | No | Yes | |
| Disbursement Amount | jcjobcategory | JcatDisbAmt | Disbursement Amount has been deprecated and should no longer be used. | BigDecimal | 18,2 | No | Yes | |
| Delay Amount | jcjobcategory | JcatDlbAmt | The monetary value associated with delays in the job category, such as penalties, additional costs, or extended resource allocations due to project delays. | BigDecimal | 18,2 | 5000 | No | Yes |
| Exclude Cost Budget Work-in-Progress | jcjobcategory | JcatExclCostBudgWip | The flag determines if the cost budget allocated to a given category will be included (flag - "N") or excluded (flag - "Y") while calculating the WIP (work-In-Progress) adjustment amount. | string | 1 | N | Yes | Yes |
| Exclude Cost Work-in-Progress | jcjobcategory | JcatExclCostWip | The flag determines if the posted costs against a given category will be included (flag - "N") or excluded (flag - "Y") while calculating the WIP (work-In-Progress) adjustment amount. | string | 1 | Y | Yes | Yes |
| Freeze Projected Amount flag - Checkbox | jcjobcategory | JcatFreezeProjAmtFlag | A flag that determines whether the amount entered in the Projected Final field will be updated – Flag = "Y" or not – Flag = "N" by the system when costs are posted. | string | 1 | Y | No | Yes |
| Forward Loss Override Percentage | jcjobcategory | JcatFwdLossOvrhPct | Forward Loss Override Percentage - The percentage used to override the standard calculation of forward losses for the given job code/cost code/category code. | Number | 18,4 | 5 | No | Yes |
| Habitual Pay Amount | jcjobcategory | JcatHbPayAmt | Refers to the standard or regular pay amount allocated for the job category. | Number | 18,2 | 400 | No | Yes |
| Invoice Committed Amount | jcjobcategory | JcatInvCommAmt | The total amount invoiced on posted commitments against a specific job code/cost code/category code combination | Number | 18,2 | 3000 | No | Yes |
| Invoice Committed Unit | jcjobcategory | JcatInvCommUnit | The total units invoiced on posted commitments against a specific job code/cost code/category code combination. | Number | 3000 | No | Yes | |
| Invoice unit | jcjobcategory | JcatInvUnit | The number of units invoiced under the specific job code/cost code/category code, such as hours billed, materials delivered, or tasks completed. | Number | 4 | No | Yes | |
| Non-Invoice Committed Amount | jcjobcategory | JcatNinvCommAmt | Non-Invoice Committed Amount - The total amount invoiced on non-commitments against a specific job code/cost code/category code combination. | Number | 18,2 | 7500 | No | Yes |
| Labour Forecast Flag | jcjobcategory | JcatLabourForecastFlag | A flag indicating whether the record type is "Labor" and the costs and units posted against a given category will be used for Labor forecasting. "Y" indicates that Labor Forecasting is enabled, and "N" indicates not enabled. | string | 1 | N | Yes | Yes |
| Phase active flag | jcjobcategory | JcatPhaseActiveFlag | A flag indicating whether a specific phase/cost code is active ("Y") or not ("N"). Note that inactive cost codes will not be available for any transaction entry or posting. | string | 1 | Y | Yes | Yes |
| Project Amount | jcjobcategory | JcatProjAmt | Number | 18,2 | No | Yes | ||
| Project Unit | jcjobcategory | JcatProjUnit | Number | No | Yes | |||
| Time Phased – Checkbox | jcjobcategory | JcatTimePhasedFlag | A flag indicating if the specific job code/cost code/category code is using a time phased cost budget (detail time phasing). Mark ("Y") for Yes and ("N") for No. Note that since detailed time phased budgeting has been deprecated, ensure that this flag is left as a null value. | string | 1 | No | Yes | |
| Variable Code | jcjobcategory | JcatVarCode | A code that categorizes variables or modifiers applicable to the job code/cost code/category code. | string | 1 | No | Yes | |
| WBS Budget Flag | jcjobcategory | JcatWbsBudgetFlag | A flag indicating whether the Work Breakdown Structure (WBS) budget is active ("Y") or not ("N") for the job code/cost code/category code. | string | 1 | Y | No | Yes |
| WM Code | jcjobcategory | JcatWmCode | This code specifies the unit of measure for the category or subcategory being set up. | string | 2 | "NA" | No | Yes |
Security
HTTP
Type basic
Basic authentication
Header parameters
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourceitem+json
Body parameters
object
Example{
"JcatWmCode": "HR"
}
Responses
200
OK
Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourceitem+json
"{\n \"JcatActLbAmt\": 6000,\n \"JcatAddedFromApp\": null,\n \"JcatAddonAmt\": 8000,\n \"JcatAnticipatedCostAmt\": null,\n \"JcatBidItemRemainingAmt\": null,\n \"JcatBillingTypeCode\": null,\n \"JcatBillAmt\": 9760,\n \"JcatBillCode\": null,\n \"JcatBillName\": null,\n \"JcatBudgAdjustmentAmt\": null,\n \"JcatBudgAmt\": 10000,\n \"JcatBudgRevenueAmt\": 4000,\n \"JcatBudgRevAmt\": null,\n \"JcatBudgRevQty\": null,\n \"JcatBudgRevRevAmt\": null,\n \"JcatBudgUnit\": 20,\n \"JcatBudgUnitRate\": 200,\n \"JcatBudmethCode\": \"A\",\n \"JcatCalculateColumnName\": null,\n \"JcatCatActiveFlag\": \"Y\",\n \"JcatCatHier\": \"ZZ PC-20246R 2000 \",\n \"JcatChgOrdAmt\": null,\n \"JcatChgOrdQty\": null,\n \"JcatChgOrdRevAmt\": null,\n \"JcatCode\": \"2000\",\n \"JcatCommUnit\": 12,\n \"JcatComplPc\": 100,\n \"JcatComplPcDate\": null,\n \"JcatComplUnit\": 6,\n \"JcatCompCode\": \"ZZ\",\n \"JcatCostAmt\": 10000,\n \"JcatCostRateOverrideAmt\": null,\n \"JcatCostToComplOvrdFlg\": \"N\",\n \"JcatCstEntry\": \"B\",\n \"JcatCtrlCode\": \"ALL\",\n \"JcatDisbAmt\": 10000,\n \"JcatDlbAmt\": 10000,\n \"JcatExclCostBudgWip\": \"Y\",\n \"JcatExclCostWip\": \"Y\",\n \"JcatFreezeProjAmtFlag\": \"Y\",\n \"JcatFwdLossOvrhPct\": 100,\n \"JcatHbPayAmt\": 10000,\n \"JcatIdealRevenueAmt\": null,\n \"JcatInvoiceFormatCode\": null,\n \"JcatInvCommAmt\": 10000,\n \"JcatInvCommUnit\": 1000,\n \"JcatInvUnit\": 100,\n \"JcatJobCode\": \"PC-20246R\",\n \"JcatJobCtrlCode\": \"ALL\",\n \"JcatLabourForecastFlag\": \"Y\",\n \"JcatMaxBillingAmt\": null,\n \"JcatMaxBillingBudgetAmt\": null,\n \"JcatNcommCostAmt\": null,\n \"JcatNinvCommAmt\": 10000,\n \"JcatObudgAmt\": null,\n \"JcatObudgChgOrdAmt\": null,\n \"JcatObudgChgOrdRevAmt\": null,\n \"JcatObudgChgOrdUnit\": null,\n \"JcatObudgRevenueAmt\": null,\n \"JcatObudgUnit\": null,\n \"JcatPbBillCode\": null,\n \"JcatPhaseActiveFlag\": \"Y\",\n \"JcatPhsCode\": \"02-100\",\n \"JcatPhsCtrlCode\": \"02\",\n \"JcatPhsHier\": \"ZZ PC-20246R 02 02-100 \",\n \"JcatPriorCostAmt\": null,\n \"JcatPriorCostQty\": null,\n \"JcatProductivityOverride\": null,\n \"JcatProjAmt\": 10000,\n \"JcatProjUnit\": 1000,\n \"JcatRevAdjustmentAmt\": null,\n \"JcatRuleCode\": null,\n \"JcatTimePhasedFlag\": \"N\",\n \"JcatUserEnteredProjAmt\": null,\n \"JcatUserEnteredProjUnit\": null,\n \"JcatVarCode\": \"L\",\n \"JcatWbsvCode1\": null,\n \"JcatWbsvCode10\": null,\n \"JcatWbsvCode11\": null,\n \"JcatWbsvCode12\": null,\n \"JcatWbsvCode2\": null,\n \"JcatWbsvCode3\": null,\n \"JcatWbsvCode4\": null,\n \"JcatWbsvCode5\": null,\n \"JcatWbsvCode6\": null,\n \"JcatWbsvCode7\": null,\n \"JcatWbsvCode8\": null,\n \"JcatWbsvCode9\": null,\n \"JcatWbsvEditableFlag1\": \"Y\",\n \"JcatWbsvEditableFlag10\": null,\n \"JcatWbsvEditableFlag11\": null,\n \"JcatWbsvEditableFlag12\": null,\n \"JcatWbsvEditableFlag2\": \"Y\",\n \"JcatWbsvEditableFlag3\": \"N\",\n \"JcatWbsvEditableFlag4\": \"Y\",\n \"JcatWbsvEditableFlag5\": null,\n \"JcatWbsvEditableFlag6\": null,\n \"JcatWbsvEditableFlag7\": null,\n \"JcatWbsvEditableFlag8\": null,\n \"JcatWbsvEditableFlag9\": null,\n \"JcatWbsvPciLineOraseq\": null,\n \"JcatWbsvRequiredFlag1\": \"N\",\n \"JcatWbsvRequiredFlag10\": null,\n \"JcatWbsvRequiredFlag11\": null,\n \"JcatWbsvRequiredFlag12\": null,\n \"JcatWbsvRequiredFlag2\": \"N\",\n \"JcatWbsvRequiredFlag3\": \"N\",\n \"JcatWbsvRequiredFlag4\": \"N\",\n \"JcatWbsvRequiredFlag5\": null,\n \"JcatWbsvRequiredFlag6\": null,\n \"JcatWbsvRequiredFlag7\": null,\n \"JcatWbsvRequiredFlag8\": null,\n \"JcatWbsvRequiredFlag9\": null,\n \"JcatWbsBudgetFlag\": \"N\",\n \"JcatWcbCode\": null,\n \"JcatWmCode\": \"NA\",\n \"JcatIuCreateDate\": \"2026-03-29T15:06:09-04:00\",\n \"JcatIuUpdateDate\": \"2026-03-29T23:13:16-04:00\",\n \"JcatVUuid\": \"4E2F47457822A3B1E0630B811DACA3D2\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://127.0.0.1:7101/jc-rest-api/rest/2/jcjobcategory/4E2F47457822A3B1E0630B811DACA3D2\",\n \"name\": \"jcjobcategory\",\n \"kind\": \"item\"\n },\n {\n \"rel\": \"canonical\",\n \"href\": \"http://127.0.0.1:7101/jc-rest-api/rest/2/jcjobcategory/4E2F47457822A3B1E0630B811DACA3D2\",\n \"name\": \"jcjobcategory\",\n \"kind\": \"item\"\n }\n ]\n}"string