> ## Documentation Index > Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a JC Job Category > ## Overview This endpoint is primarily utilized for assigning job-based budget categories to specific Jobs and Phases. Users can enhance their budget assignments by including additional details such as quantities, anticipated revenue, and estimated costs to complete. ## Note Additional information must be included when assigning a budget by category to a specific Job and phase. After the budget by category is assigned, a PATCH request is required to update existing record details. ## UI Navigation Project Controls > Job Costing > Job > Enter Budget ## Knowledge Base Article [Setup - Job Costing](https://docs.cmicglobal.com/portal/Content/E_Reference_Material/JC_-_Job_Costing/Reference/Setup/Setup.htm) [Enter Category](https://docs.cmicglobal.com/portal/Content/E_Reference_Material/JC_-_Job_Costing/Reference/Setup/Enter_Category_Screen.htm) ## Commonly Used Body Parameters | **CMiC UI Fieldname** | **Name** | **Description** | **Required** | **Type** | **Data Length** | **Example** | | --- | --- | --- | --- | --- | --- | --- | | Job Category Code | JcatCode | Job Category Code - A unique identified code assigned to a cost code. This code is used to reference and manage job/cost code/category combination for tracking posted units & costs. Ex: 1000, 2000, 3000, 4000 etc, corresponding to Labor, Subcontract, Equipment, Material etc. | TRUE | string | 16 | 4000 | | Company Code | JcatCompCode | Company Code - A unique code representing the Company or business unit containing one or more jobs with the cost codes and categories assigned. This helps in organizing and managing jobs across different companies within an organization. For example a field set to "ZZ", indicates that a given company code is set to "ZZ". | TRUE | string | 8 | ZZ | | Job Code | JcatJobCode | Job Code - A code that uniquely identifies the job within a company or business unit. Each job can consist of one or many phase/cost codes and categories assigned to it. | TRUE | string | 10 | 00100 | | Phase Code | JcatPhsCode | Phase Code - A unique code under a given job used to track the posted costs and units. Each phase code (Also known as cost code) can have one or more categories assigned and can give more flexibility and help track the job's cost elements at a finer level. | TRUE | string | 16 | 15090 | | Phase Active Flag | jcatPhaseActiveFlag | Phase Active Flag - 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. | TRUE | string | 1 | Y | | Category Active Flag | 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. | TRUE | string | 1 | N | | Exclude Cost Work-in-Progress | JcatExclCostWip | Exclude Cost Work-in-Progress - 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. | TRUE | string | 1 | Y | | Labour Forecast Flag | JcatLabourForecastFlag | Labour Forecast Flag - 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. | TRUE | string | 1 | N | | Cost to Complete Override Flag | JcatCostToComplOvrdFlg | Cost to Complete Override Flag - A flag indicating whether the Contract Forecast - Cost to Complete amount has been overridden ("Y") or not ("N"). | TRUE | string | 1 | Y | | Exclude Cost Budget Work-in-Progress | JcatExclCostBudgWip | Exclude Cost Budget Work-in-Progress - 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. | TRUE | string | 1 | N | | Billing Amount | JcatBillAmt | Billing Amount - 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. | FALSE | BigDecimal | 18,2 | 0 | | Budget Amount | JcatBudgAmt | Budget Amount - The current cost budgeted amount. | FALSE | BigDecimal | 18,2 | 10000 | | Budget Revenue Amount | JcatBudgRevenueAmt | Budget Revenue Amount - The current revenue budgeted amount. | FALSE | BigDecimal | 18,2 | 150000 | | Budget Unit | JcatBudgUnit | Budget Unit - The current cost budgeted units. | FALSE | Number | | 500 | | Budget Unit Rate | JcatBudgUnitRate | Budget Unit Rate - The current cost budget unit rate. | FALSE | BigDecimal | 20,4 | 300 | | Method | JcatBudmethCode | Budget Method Code – The forecasting method for the given job code/cost code/category code combination: "A" = Amounts, "P" = Productivity, "U" = Units. | FALSE | string | 1 | P | | Category Hierarchy | JcatCatHier | Category Hierarchy - A string representing the hierarchical structure of the category code for the specific company and job. Not updatable. | FALSE | string | 500 | For example, "ZZ ZZ-WMT 2000 " indicates a hierarchical path where "ZZ" represents the company code, "ZZ-WMT" represents the job code and 2000 represents the category code. | | Change Order Amount | JcatChgOrdAmt | Change Order Amount - To date change order final amount posted via PCI. Not updatable. | FALSE | BigDecimal | 18,2 | | | Invoice Commission Amount | JcatInvCommAmt | Invoice Against Committed Amount – The total amount invoiced on posted commitments against a specific job code/cost code/category code combination. Not updatable. | FALSE | Number | 18,2 | 3000 | | Completion Percentage | JcatComplPc | Completion Percentage – Current percent complete. Refers to the percentage measure of total cost spent against the current cost budget for the given category assigned to the cost code in a job. Not updatable. | FALSE | Number | 16,13 | 68 | | Completion Unit | JcatComplUnit | Completion Unit – 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. Not updatable. | FALSE | Number | | 10 | | Cost Amount | JcatCostAmt | Cost Amount – 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. Not updatable. | FALSE | BigDecimal | 18,2 | 5560 | | Job Control Code | JcatJobCtrlCode | Job Control Code - A code to indicate whether the given job is a standalone job or controls one or more sub job. If the given job is a standalone job then the Control Job Code will be "All". Not updatable. | FALSE | string | 10 | ZZ0001 | | Original Budget Amount | JcatObudgAmt | Original Budget Amount – The original/ initial cost budget amount allocated to the job code/cost code/category code before any adjustments or revisions. | FALSE | Number | 18,2 | 337000 | | Original Budget Revenue Amount | JcatObudgRevenueAmt | Original Budget Revenue Amount - The original/ initial revenue budget amount allocated to the job code/cost code/category code before any adjustments or revisions. | FALSE | Number | 18,2 | 10000 | | Phase Control Code | JcatPhsCtrlCode | Phase Control Code - A code to indicate whether the given phase/cost code is a standalone code or controls one or more cost codes. If the given cost code is a standalone cost code, then the Control Cost Code will be "All". Not updatable. | FALSE | string | 16 | 02 | | Projected Amount | JcatProjAmt | Projected Final/ Cost Amount - The estimate of the total cost amount spent on the category assigned to the cost code in a job. This will initially equal the Current Cost Budget for the category and may change with posted costs in the future. | FALSE | Number | 18,2 | 2420 | | Projected Unit | JcatProjUnit | Projected Units - The estimate of the total quantity for the Phase/Cost Code containing the given category in a job. This will be non-zero, only if the phase budgeted quantity is defined. Not updatable. | FALSE | Number | | 44 | | Create Date | JcatIuCreateDate | Create Date - The timestamp indicating when the category record was created for the cost code in a job through an update. | FALSE | Date | | 2016-01-08T11:13:47-05:00 | | VUUID | JcatVUuid | VUUID - A unique identifier. An example of a VUUID is "B508C0BE1A5181A0E0530100007F6EDF" | FALSE | string | 64 | B508C0BE1A5181A0E0530100007F6EDF | ## Other (Optional) Body Parameters | **CMiC UI Fieldname** | **Name** | **Description** | **Type** | **Data Length** | **Example** | | --- | --- | --- | --- | --- | --- | | Actual Labor Amount | 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 | | Added From Application | JcatAddedFromApp | Added From Application - Indicates the 3-character application code if the specific job code/cost code/category code record is created apart from the "JC" - Job Costing application. Not updatable. | string | 3 | | | Add-On Amount | JcatAddonAmt | Add-On Amount has been deprecated and should no longer be used. | BigDecimal | 18,2 | | | Anticipated Cost Amount | JcatAnticipatedCostAmt | Anticipated Cost Amount - The projected or expected cost associated with the specific job code/cost code/category code combination. This forecast helps in budgeting and financial planning by estimating future expenses.

Not updatable. | BigDecimal | 18,2 | 15000 | | Bid Item Remaining Amount | JcatBidItemRemainingAmt | Bid Item Remaining Amount - The remaining amount allocated for bid items under the job code/cost code/category code. Not updatable. | Number | | 250 | | Billing Code | JcatBillCode | Billing Code has been deprecated and should no longer be used. | string | 12 | | | Billing Name | JcatBillName | Billing Name - has been deprecated and should no longer be used. Not updatable. | string | 15 | | | Billing Type Code | JcatBillingTypeCode | Billing Type Code - A code that indicates the default billing type such cost or milestone-based billing. Not updatable. | string | 4 | | | Budget Adjustment Amount | JcatBudgAdjustmentAmt | Budget Adjustment Amount - The amount by which the original cost budget has been adjusted. Not updatable. | BigDecimal | 18,2 | 500 | | Budgeted Revenue Amount | JcatBudgRevAmt | Budgeted Revenue Amount has been deprecated and should no longer be used. | BigDecimal | 18,2 | | | Budgeted Revenue Quantity | JcatBudgRevQty | Budgeted Revenue Quantity has been deprecated and should no longer be used. | Number | 18,8 | | | Budgeted Revenue Revision Amount | JcatBudgRevRevAmt | Budgeted Revenue Revision Amount - The revised amount of budgeted revenue after adjustments or updates. Not updatable. | BigDecimal | 18,2 | 18000 | | Calculated Column Name | JcatCalculateColumnName | Calculated Column Name - The name of a column used for calculated values for the job code/cost code/category code combination. Not updatable. | string | 30 | | | Change Order Quantity | JcatChgOrdQty | Change Order Quantity – To date posted change order quantities.

Not updatable. | BigDecimal | 18,8 | 200 | | Change Order Revenue Amount | JcatChgOrdRevAmt | Change Order Revenue Amount - To date posted change order bill amount.

Not updatable. | BigDecimal | 18,2 | 10000 | | Committed Unit | JcatCommUnit | Committed Unit – To date posted committed quantity for the given job code/cost code/category code, such as hours, days, or material units.

Not updatable. | Number | | 150 | | Completion Percentage Date | JcatComplPcDate | Completion Percentage Date - The date when the completion percentage was recorded or updated.

Not updatable. | Date | | 2016-05-02T11:13:47-05:00 | | Cost Rate Override Amount | JcatCostRateOverrideAmt | Cost Rate Override Amount - An override value for the standard cost rate, allowing adjustments to the predetermined rates for specific circumstances. This can be used to accommodate changes in labor rates, material costs, or other variables.

Not updatable. | Number | 16,4 | 55 | | Cost Entry | JcatCstEntry | Cost Entry -

has been deprecated and should no longer be used. | string | 1 | | | Category Control Code | JcatCtrlCode | Control Code - A code to indicate whether the given category is a standalone category or controls one or more sub categories. If the given category is a standalone category then the Control Code will be "All".

Not updatable. | string | 16 | All | | Disbursement Amount | JcatDisbAmt | Disbursement Amount has been deprecated and should no longer be used. | BigDecimal | 18,2 | | | Delay Amount | JcatDlbAmt | Delay Amount - The monetary value associated with delays in the job category, such as penalties, additional costs, or extended resource allocations due to project delays.

Not updatable. | BigDecimal | 18,2 | 5000 | | Freeze Projected Amount flag - Checkbox | JcatFreezeProjAmtFlag | Freeze Projected Amount Flag - 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 | | Forward Loss Override Percentage | 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.

Not updatable. | Number | 18,4 | 5% | | Habitual Pay Amount | JcatHbPayAmt | Habitual Pay Amount - Refers to the standard or regular pay amount allocated for the job category.

Not updatable. | Number | 18,2 | 400 | | Ideal Revenue Amount | JcatIdealRevenueAmt | Ideal Revenue Amount - The optimal or target revenue expected from the job category under ideal conditions.

Not updatable. | Number | 18,2 | 10000 | | Invoice Committed Unit | JcatInvCommUnit | Invoice Committed Unit - The total units invoiced on posted commitments against a specific job code/cost code/category code combination.

Not updatable. | Number | | 6 | | Invoice Unit | JcatInvUnit | Invoice Unit - The number of units invoiced under the specific job code/cost code/category code, such as hours billed, materials delivered, or tasks completed.

Not updatable. | Number | | 4 | | Invoice Format Code | JcatInvoiceFormatCode | Invoice Format Code - A code that specifies the format or template used for generating invoices for the job.

Not updatable. | string | 4 | U17 | | Maximum Billing Amount | JcatMaxBillingAmt | Maximum Billing Amount - The upper limit for billing amounts within the job code/cost code/category code.

Not updatable. | Number | 18,2 | 16000 | | Maximum Billing Budget Amount | JcatMaxBillingBudgetAmt | Maximum Billing Budget Amount - The maximum budget allocated for billing activities the specific job code/cost code/category code combination. This ensures that billing does not surpass the defined budget limit.

Not updatable. | Number | 18,2 | 20000 | | Non-Committed Cost Amount | JcatNcommCostAmt | Non-Committed Cost Amount - The total costs incurred on non-commitments.

Not updatable. | Number | 18,2 | 5000 | | Non-Invoice Committed Amount | JcatNinvCommAmt | Non-Invoice Committed Amount - The total amount invoiced on non-commitments against a specific job code/cost code/category code combination.

Not updatable. | Number | 18,2 | 7500 | | Original Budget Change Order Amount | JcatObudgChgOrdAmt | Original Budget Change Order Amount - The original/ initial cost budget amount allocated to the WBS mapped code/cost code/category code combination in Contract Forecasting upon posting change orders before any adjustments or revisions.

Not updatable. | Number | 18,2 | 8000 | | Original Budget Change Order Revenue Amount | JcatObudgChgOrdRevAmt | Original Budget Change Order Revenue Amount - The original/ initial revenue budget amount allocated to the WBS mapped code/cost code/category code combination in Contract Forecasting upon posting change orders before any adjustments or revisions.

Not updatable. | Number | 18,2 | 12000 | | Original Budget Change Order Unit | JcatObudgChgOrdUnit | Original Budget Change Order Unit - The original/ initial quantity allocated to the WBS mapped code/cost code/category code combination in Contract Forecasting upon posting change orders before any adjustments or revisions.

Not updatable. | Number | 18,8 | 25 | | Original Budget Unit | JcatObudgUnit | Original Budget Unit - The original/ initial quantity allocated to the job code/cost code/category code before any adjustments or revisions.

Not updatable. | Number | | 100 | | Progress Billing Billing Code | JcatPbBillCode | Progress Billing Billing Code – the default bill code (the bill code without any WBS information). | string | 50 | | | Phase Hierarchy | JcatPhsHier | Phase Hierarchy - A string representing the hierarchical structure of a specific phase/ cost code and control cost code within the company and job.

Not updatable. | string | 127 | An example of Phase Hierarchy is "ZZ ZZ-T&M 02 02-300" which combines a Company code "ZZ", a Job Code "ZZ-T&M, a Phase control code "02", and a Phase Code, "02-300". | | Prior Cost Amount | JcatPriorCostAmt | Prior Cost Amount – The total cost amount for the job before the date defined for its "Ignore Costs Prior To Date" field.

Not updatable. | Number | 18,2 | 1200 | | Prior Cost Quantity | JcatPriorCostQty | Prior Cost Quantity - The quantity of resources or units associated with the prior cost amounts. A null value indicates no prior cost quantities have been specified.

Not updatable. | Number | | 60 | | Productivity Override | JcatProductivityOverride | Productivity Override – A manual override to the specific job code/cost code/category code combination's Productivity in Contract Forecasting (Productivity is calculated as the ratio of Phase/Cost Code quantity completion to Category quantity completion). The overrides are only applicable if bill code method is either "P" – Productivity or "U" – Units.

Not updatable. | Number | 16,4 | 5 | | Revenue Adjustment Amount | JcatRevAdjustmentAmt | Revenue Adjustment Amount - The amount by which the original revenue budget has been adjusted.

Not updatable. | Number | 18,2 | 2500 | | Rule Code | JcatRuleCode | Rule Code – The budget spread rule code for the company/job code/cost code/category.

Not updatable. | string | 20 | Ex. MONTHLY, WEEKLY | | Time Phased – Checkbox | JcatTimePhasedFlag | Time Phased Flag - 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 | | | User | JcatUserEnteredProjAmt | User-Entered Projected Amount - The projected amount manually entered by the user, allowing for overrides or adjustments to the system-generated projected amounts.

Not updatable. | Number | 18,2 | 15000 | | User | JcatUserEnteredProjUnit | User-Entered Projected Unit - The projected unit manually entered by the user, allowing for overrides or adjustments to the system-generated projected units.

Not updatable. | Number | | 300 | | Variable Code | JcatVarCode | Variable Code - A code that categorizes variables or modifiers applicable to the job code/cost code/category code.

Not updatable. | string | 1 | | | WBS Budget Flag | JcatWbsBudgetFlag | WBS Budget Flag - A flag indicating whether the Work Breakdown Structure (WBS) budget is active ("Y") or not ("N") for the job code/cost code/category code.

Not updatable. | string | 1 | Y | | WBS Value Code 1 | JcatWbsvCode1 | WBS Value Code 1 – The user defined Work Breakdown Structure (WBS) codes provide a supplementary method to effectively track and summarize costs on a transaction to transaction basis. Normally the WBS 1 code is usually set to PCI. | string | 60 | Ex. PCI | | WBS ValueCode 2 | JcatWbsvCode2 | WBS Value Code 2 - The user defined Work Breakdown Structure (WBS) codes provide a supplementary method to effectively track and summarize costs on a transaction to transaction basis. | string | 60 | | | WBS Value Code 3 | JcatWbsvCode3 | WBS Value Code 3 - The user defined Work Breakdown Structure (WBS) codes provide a supplementary method to effectively track and summarize costs on a transaction to transaction basis. | string | 60 | | | WBS Value Code 4 | JcatWbsvCode4 | WBS Value Code 4 - The user defined Work Breakdown Structure (WBS) codes provide a supplementary method to effectively track and summarize costs on a transaction to transaction basis. | string | 60 | | | WBS ValueEditable Flag 1 | JcatWbsvEditableFlag1 | WBS Value Editable Flag 1 - A flag indicating whether the first WBS value code (WbsvCode1) is editable during transaction entry ("Y") or not ("N"). | string | 1 | Y | | WBS ValueEditable Flag 2 | JcatWbsvEditableFlag2 | WBS Value Editable Flag 2 - A flag indicating whether the second WBS value code (WbsvCode2) is editable during transaction entry ("Y") or not ("N"). | string | 1 | Y | | WBS ValueEditable Flag 3 | JcatWbsvEditableFlag3 | WBS Value Editable Flag 3 - A flag indicating whether the third WBS value code (WbsvCode3) is editable during transaction entry ("Y") or not ("N"). | string | 1 | Y | | WBS ValueEditable Flag 4 | JcatWbsvEditableFlag4 | WBS Value Editable Flag 4 - A flag indicating whether the fourth WBS value code (WbsvCode4) is editable during transaction entry ("Y") or not ("N"). | string | 1 | Y | | WBS Value Required Flag 1 | JcatWbsvRequiredFlag1 | WBS Value Required Flag 1 - A flag indicating whether the first WBS value code (WbsvCode1) is required ("Y") or not ("N"). | string | 1 | Y | | WBS Value Required Flag 2 | JcatWbsvRequiredFlag2 | WBS Value Required Flag 2 - A flag indicating whether the second WBS value code (WbsvCode2) is required ("Y") or not ("N"). | string | 1 | Y | | WBS Value Required Flag 3 | JcatWbsvRequiredFlag3 | WBS Value Required Flag 3 - A flag indicating whether the third WBS value code (WbsvCode3) is required ("Y") or not ("N"). | string | 1 | Y | | WBS Value Required Flag 4 | JcatWbsvRequiredFlag4 | WBS Value Required Flag 4 - A flag indicating whether the fourth WBS value code (WbsvCode4) is required ("Y") or not ("N"). | string | 1 | Y | | WCB Code | JcatWcbCode | WCB Code - The Workers compensation code defined for the company/job. | string | 4 | Ex. WC1 | | WM Code | JcatWmCode | WM Code - This code specifies the unit of measure for the category or subcategory being set up. | string | 2 | Ex. hours of labor - HR or Lumpsum – LS or NA – Not Applicable. | | Update Date | JcatIuUpdateDate | Update Date - The timestamp indicating the last time the job category record was updated. An example of an Integration Update is "2024-10-23T10:49:35-04:00" which shows the last update times. | Date | | 2024-10-23T10:49:35-04:00 | ## OpenAPI ````json POST /jc-rest-api/rest/2/jcjobcategory { "openapi": "3.0.0", "info": { "title": "API Catalog", "description": "", "version": "1.0.0" }, "servers": [ { "url": "https://mobtest.cmiccloudr12.com/cmictestrti", "description": "CMIC API Server" } ], "security": [ { "cmicBasicAuth": [] } ], "tags": [ { "name": "Highlights" }, { "name": "Asset Management | Equipment" }, { "name": "Asset Management | Fixed Assets" }, { "name": "Asset Management | Purchase Order" }, { "name": "Asset Management | Inventory" }, { "name": "Asset Management | Requisition" }, { "name": "Asset Management | Purchase Change Order" }, { "name": "Bim Model" }, { "name": "Bim Model Revision" }, { "name": "Bim Tag Model" }, { "name": "Bim Tags" }, { "name": "Bim FileUpload Jersey" }, { "name": "Core System | Business Partners" }, { "name": "Core System | Business Partner Addresses" }, { "name": "Core System | Bank" }, { "name": "Core System | Currency" }, { "name": "Core System | Exchange Rates" }, { "name": "Core System | Global Table Text Codes" }, { "name": "Core System | Global Table Regions" }, { "name": "Core System | Terms" }, { "name": "Core System | System Contact" }, { "name": "Core System | Weight Measures" }, { "name": "Core System | Field User Defined Classifiers" }, { "name": "Core System | User Defined Classifiers by Object" }, { "name": "Core System | User Extension Definitions by Object" }, { "name": "Core System | User Extention Field Data Value" }, { "name": "Core System | User Extension Values by Object" }, { "name": "Core System | User System Role" }, { "name": "Core System | User Project Role" }, { "name": "Core System | Documents by Object" }, { "name": "Core System | Audit Status Log by Object" }, { "name": "Core System | Licensed Users" }, { "name": "Core System | Company Access" }, { "name": "Core System | Copy User Settings" }, { "name": "Core System | User Maintenance" }, { "name": "Core System | User Roles" }, { "name": "Core System | Security Groups" }, { "name": "Core System | Job/Project Security" }, { "name": "Core System | Weight Measure with Conversions Code" }, { "name": "Core System | Weight Measure Conversions Code" }, { "name": "Core System | User-defined-fields" }, { "name": "Core System | User-extension" }, { "name": "ECM and Workflow | Image Manager" }, { "name": "Financials | General Ledger" }, { "name": "Financials | Accounts Payable" }, { "name": "Financials | Accounts Receivable" }, { "name": "Preventative Maintenance | Issue Work Orders" }, { "name": "Preventative Maintenance | Issue Work Items" }, { "name": "Preventative Maintenance | Issue Work Budgets" }, { "name": "Preventative Maintenance | Issue Priorities" }, { "name": "Preventative Maintenance | Issue Status" }, { "name": "Preventative Maintenance | Issue Types" }, { "name": "Preventative Maintenance | Accumulative Equipment" }, { "name": "Preventative Maintenance | Work Orders" }, { "name": "Preventative Maintenance | Work Items" }, { "name": "Preventative Maintenance | Work Budgets" }, { "name": "Preventative Maintenance | Priorities" }, { "name": "Preventative Maintenance | Tasks" }, { "name": "HCM | UKG Pay Deductions" }, { "name": "HCM | UKG Pay Earnings" }, { "name": "HCM | UKG Pay Headers" }, { "name": "HCM | UKG Pay Taxes" }, { "name": "HCM | Payroll Geographical States" }, { "name": "HCM | Payroll Trades" }, { "name": "HCM | Payroll Union" }, { "name": "HCM | Payroll Pay Runs" }, { "name": "HCM | Payroll Pay Groups" }, { "name": "HCM | Payroll Tax" }, { "name": "HCM | Payroll Worker Compensation" }, { "name": "HCM | Payroll Work Locations" }, { "name": "HCM | Payroll Trade Pay Rates" }, { "name": "HCM | Payroll Union Pay Rates" }, { "name": "HCM | Payroll Job Pay Rates" }, { "name": "HCM | Payroll Master Benefits" }, { "name": "HCM | Payroll Master Deductions" }, { "name": "HCM | Payroll Ben/Ded/Leave Base Codes" }, { "name": "HCM | Payroll Ben/Ded Plans" }, { "name": "HCM | Payroll Ben/Ded Plan Options" }, { "name": "HCM | Payroll Company Benefits" }, { "name": "HCM | Payroll Company Deductions" }, { "name": "HCM | Payroll Vertex Geographic Locations" }, { "name": "HCM | Payroll Checks" }, { "name": "HCM | Payroll Timesheets" }, { "name": "HCM | Employee" }, { "name": "HCM | Employee (Minimum payload)" }, { "name": "HCM | Employee History" }, { "name": "HCM | Tax Exemptions" }, { "name": "HCM | Employee Tax Overrides" }, { "name": "HCM | Employee Pay Splits" }, { "name": "HCM | Employee Benefits" }, { "name": "HCM | Employee Clock In and Out" }, { "name": "HCM | Employee Deductions" }, { "name": "HCM | Employee Leaves" }, { "name": "HCM | Employee Leave History" }, { "name": "HCM | Employee Hour Types" }, { "name": "HCM | Employee Pay History" }, { "name": "HCM | Employee Work Statuses" }, { "name": "HCM | Employee Security Group" }, { "name": "HCM | Crewtime Crew" }, { "name": "HCM | Crewtime Employee Timesheet" }, { "name": "HCM | Crewtime Equipment Timesheet" }, { "name": "HCM | Crew Maintenance Activity Assignment" }, { "name": "HCM | Crew Maintenance Member Assignment" }, { "name": "HCM | Crew Maintenance Member Trade and Union Assignment" }, { "name": "HCM | Crew Maintenance Equipment Assignment" }, { "name": "HCM | Crew Maintenance Equipment Detail Assignment" }, { "name": "HCM | HR Requisitions" }, { "name": "HCM | HR Relations" }, { "name": "HCM | HR Employee Skills" }, { "name": "HCM | HR Incident" }, { "name": "HCM | HR Employee Relatives / Dependents" }, { "name": "HCM | HR Employee Positions" }, { "name": "HCM | HR Applicants" }, { "name": "HCM | HR Applications" }, { "name": "HCM | Vertex Location City" }, { "name": "HCM | HR Application History" }, { "name": "HCM | HR Dependent Benefits" }, { "name": "HCM | HR Dependent Deductions" }, { "name": "HCM | HR Employee Elected Plans" }, { "name": "HCM | HR Employee Training Certifications" }, { "name": "HCM | HR Trainings" }, { "name": "HCM | E-Timesheets" }, { "name": "HCM | System Contacts" }, { "name": "HCM | System User Payroll Security Group" }, { "name": "HCM | Payroll Timesheet Posting" }, { "name": "HCM | CrewTimesheet Posting" }, { "name": "HCM | HR Positions Master" }, { "name": "HCM | Payroll Pay Periods" }, { "name": "HCM | Payroll Rate Codes" }, { "name": "HCM | Payroll Overhead Codes and Rates" }, { "name": "HCM | Payroll Assigned Overhead to Jobs" }, { "name": "Materials Management | Material Sale Orders" }, { "name": "Materials Management | Material Sale Orders Details" }, { "name": "Materials Management | Truck Rate Detail" }, { "name": "Opportunity Management | Competitors" }, { "name": "Opportunity Management | Opportunities" }, { "name": "Opportunity Management | Revenue Details" }, { "name": "Opportunity Management | Opportunity History" }, { "name": "Opportunity Management | Organization" }, { "name": "Project Controls | Job Billing" }, { "name": "Project Controls | Job Cost" }, { "name": "Project Controls | PCI Details" }, { "name": "Project Controls | Unposted PCI Details" }, { "name": "Project Controls | PCI Headers" }, { "name": "Project Controls | Owner Change Orders" }, { "name": "Project Controls | CM Statuses" }, { "name": "Project Controls | CM Types" }, { "name": "Project Controls | CM Vendor Details" }, { "name": "Project Controls | Post PCI" }, { "name": "Project Management | Uploading Documents" }, { "name": "Project Management | Downloading Documents" }, { "name": "Project Management | Foreign Bid Item Imports" }, { "name": "Project Management | Communications" }, { "name": "Project Management | Daily Journals" }, { "name": "Project Management | Communications Types" }, { "name": "Project Management | Daily Journal Daily Work Plans" }, { "name": "Project Management | Daily Journal Field Forces" }, { "name": "Project Management | Daily Journal Labour" }, { "name": "Project Management | Daily Journal Materials" }, { "name": "Project Management | Daily Journal Owner Equipment" }, { "name": "Project Management | Daily Journal Quality Control" }, { "name": "Project Management | Daily Journal Tasks" }, { "name": "Project Management | Daily Journal Trade Equipment" }, { "name": "Project Management | Daily Journal Transactions" }, { "name": "Project Management | Daily Journal User Defined Data" }, { "name": "Project Management | Daily Journal Visitors" }, { "name": "Project Management | Daily Journal Bill Details" }, { "name": "Project Management | Field Work Directives" }, { "name": "Project Management | Contract Types" }, { "name": "Project Management | Company Contacts" }, { "name": "Project Management | Distribution BCC" }, { "name": "Project Management | Distribution CC" }, { "name": "Project Management | Field Work Directive Statuses" }, { "name": "Project Management | Issues" }, { "name": "Project Management | Key Players" }, { "name": "Project Management | Meetings" }, { "name": "Project Management | Meeting Attendees" }, { "name": "Project Management | Meeting Item Statuses" }, { "name": "Project Management | Meeting Tracks" }, { "name": "Project Management | Notes" }, { "name": "Project Management | Projects" }, { "name": "Project Management | Project Items" }, { "name": "Project Management | Project Item Phase Segment Sums" }, { "name": "Project Management | Project Partners" }, { "name": "Project Management | Notices" }, { "name": "Project Management | Notice Statuses" }, { "name": "Project Management | Owner JS Query" }, { "name": "Project Management | PCI Real Locations" }, { "name": "Project Management | Project Contacts" }, { "name": "Project Management | RFIs (Requests for Information)" }, { "name": "Project Management | RFI Statuses" }, { "name": "Project Management | Submittal Packages" }, { "name": "Project Management | Submittal Package Details" }, { "name": "Project Management | Submittal Package Status" }, { "name": "Project Management | Submittals" }, { "name": "Project Management | Submittal Status" }, { "name": "Project Management | Transmittals" }, { "name": "Project Management | Subcontract Headers" }, { "name": "Project Management | Subcontract Schedules" }, { "name": "Project Management | Subcontract Sechedule Phase Segment Sums" }, { "name": "Project Management | User Roles" }, { "name": "Project Management | Punchlists" }, { "name": "Project Management | Punchlist Details" }, { "name": "Project Management | Punchlist Statuses" }, { "name": "Project Management | Meeting Items" }, { "name": "Project Management | Self Perform Vendor" }, { "name": "Project Management | Submittal Types" }, { "name": "Project Management | Assign contact and partner to project" }, { "name": "Project Management | Subcontract Prequal" }, { "name": "Project Management | Bid Item Package" } ], "paths": { "/jc-rest-api/rest/2/jcjobcategory": { "post": { "tags": [ "Project Controls | Job Cost" ], "summary": "Create a JC Job Category", "description": "## Overview\n\nThis endpoint is primarily utilized for assigning job-based budget categories to specific Jobs and Phases. Users can enhance their budget assignments by including additional details such as quantities, anticipated revenue, and estimated costs to complete.\n\n## Note\n\nAdditional information must be included when assigning a budget by category to a specific Job and phase. After the budget by category is assigned, a PATCH request is required to update existing record details.\n\n## UI Navigation\n\nProject Controls > Job Costing > Job > Enter Budget\n\n## Knowledge Base Article\n\n[Setup - Job Costing](https://docs.cmicglobal.com/portal/Content/E_Reference_Material/JC_-_Job_Costing/Reference/Setup/Setup.htm)\n\n[Enter Category](https://docs.cmicglobal.com/portal/Content/E_Reference_Material/JC_-_Job_Costing/Reference/Setup/Enter_Category_Screen.htm)\n\n## Commonly Used Body Parameters\n\n| **CMiC UI Fieldname** | **Name** | **Description** | **Required** | **Type** | **Data Length** | **Example** |\n| --- | --- | --- | --- | --- | --- | --- |\n| Job Category Code | JcatCode | Job Category Code - A unique identified code assigned to a cost code. This code is used to reference and manage job/cost code/category combination for tracking posted units & costs. Ex: 1000, 2000, 3000, 4000 etc, corresponding to Labor, Subcontract, Equipment, Material etc. | TRUE | string | 16 | 4000 |\n| Company Code | JcatCompCode | Company Code - A unique code representing the Company or business unit containing one or more jobs with the cost codes and categories assigned. This helps in organizing and managing jobs across different companies within an organization. For example a field set to \"ZZ\", indicates that a given company code is set to \"ZZ\". | TRUE | string | 8 | ZZ |\n| Job Code | JcatJobCode | Job Code - A code that uniquely identifies the job within a company or business unit. Each job can consist of one or many phase/cost codes and categories assigned to it. | TRUE | string | 10 | 00100 |\n| Phase Code | JcatPhsCode | Phase Code - A unique code under a given job used to track the posted costs and units. Each phase code (Also known as cost code) can have one or more categories assigned and can give more flexibility and help track the job's cost elements at a finer level. | TRUE | string | 16 | 15090 |\n| Phase Active Flag | jcatPhaseActiveFlag | Phase Active Flag - 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. | TRUE | string | 1 | Y |\n| Category Active Flag | 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. | TRUE | string | 1 | N |\n| Exclude Cost Work-in-Progress | JcatExclCostWip | Exclude Cost Work-in-Progress - 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. | TRUE | string | 1 | Y |\n| Labour Forecast Flag | JcatLabourForecastFlag | Labour Forecast Flag - 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. | TRUE | string | 1 | N |\n| Cost to Complete Override Flag | JcatCostToComplOvrdFlg | Cost to Complete Override Flag - A flag indicating whether the Contract Forecast - Cost to Complete amount has been overridden (\"Y\") or not (\"N\"). | TRUE | string | 1 | Y |\n| Exclude Cost Budget Work-in-Progress | JcatExclCostBudgWip | Exclude Cost Budget Work-in-Progress - 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. | TRUE | string | 1 | N |\n| Billing Amount | JcatBillAmt | Billing Amount - 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. | FALSE | BigDecimal | 18,2 | 0 |\n| Budget Amount | JcatBudgAmt | Budget Amount - The current cost budgeted amount. | FALSE | BigDecimal | 18,2 | 10000 |\n| Budget Revenue Amount | JcatBudgRevenueAmt | Budget Revenue Amount - The current revenue budgeted amount. | FALSE | BigDecimal | 18,2 | 150000 |\n| Budget Unit | JcatBudgUnit | Budget Unit - The current cost budgeted units. | FALSE | Number | | 500 |\n| Budget Unit Rate | JcatBudgUnitRate | Budget Unit Rate - The current cost budget unit rate. | FALSE | BigDecimal | 20,4 | 300 |\n| Method | JcatBudmethCode | Budget Method Code – The forecasting method for the given job code/cost code/category code combination: \"A\" = Amounts, \"P\" = Productivity, \"U\" = Units. | FALSE | string | 1 | P |\n| Category Hierarchy | JcatCatHier | Category Hierarchy - A string representing the hierarchical structure of the category code for the specific company and job. Not updatable. | FALSE | string | 500 | For example, \"ZZ ZZ-WMT 2000 \" indicates a hierarchical path where \"ZZ\" represents the company code, \"ZZ-WMT\" represents the job code and 2000 represents the category code. |\n| Change Order Amount | JcatChgOrdAmt | Change Order Amount - To date change order final amount posted via PCI. Not updatable. | FALSE | BigDecimal | 18,2 | |\n| Invoice Commission Amount | JcatInvCommAmt | Invoice Against Committed Amount – The total amount invoiced on posted commitments against a specific job code/cost code/category code combination. Not updatable. | FALSE | Number | 18,2 | 3000 |\n| Completion Percentage | JcatComplPc | Completion Percentage – Current percent complete. Refers to the percentage measure of total cost spent against the current cost budget for the given category assigned to the cost code in a job. Not updatable. | FALSE | Number | 16,13 | 68 |\n| Completion Unit | JcatComplUnit | Completion Unit – 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. Not updatable. | FALSE | Number | | 10 |\n| Cost Amount | JcatCostAmt | Cost Amount – 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. Not updatable. | FALSE | BigDecimal | 18,2 | 5560 |\n| Job Control Code | JcatJobCtrlCode | Job Control Code - A code to indicate whether the given job is a standalone job or controls one or more sub job. If the given job is a standalone job then the Control Job Code will be \"All\". Not updatable. | FALSE | string | 10 | ZZ0001 |\n| Original Budget Amount | JcatObudgAmt | Original Budget Amount – The original/ initial cost budget amount allocated to the job code/cost code/category code before any adjustments or revisions. | FALSE | Number | 18,2 | 337000 |\n| Original Budget Revenue Amount | JcatObudgRevenueAmt | Original Budget Revenue Amount - The original/ initial revenue budget amount allocated to the job code/cost code/category code before any adjustments or revisions. | FALSE | Number | 18,2 | 10000 |\n| Phase Control Code | JcatPhsCtrlCode | Phase Control Code - A code to indicate whether the given phase/cost code is a standalone code or controls one or more cost codes. If the given cost code is a standalone cost code, then the Control Cost Code will be \"All\". Not updatable. | FALSE | string | 16 | 02 |\n| Projected Amount | JcatProjAmt | Projected Final/ Cost Amount - The estimate of the total cost amount spent on the category assigned to the cost code in a job. This will initially equal the Current Cost Budget for the category and may change with posted costs in the future. | FALSE | Number | 18,2 | 2420 |\n| Projected Unit | JcatProjUnit | Projected Units - The estimate of the total quantity for the Phase/Cost Code containing the given category in a job. This will be non-zero, only if the phase budgeted quantity is defined. Not updatable. | FALSE | Number | | 44 |\n| Create Date | JcatIuCreateDate | Create Date - The timestamp indicating when the category record was created for the cost code in a job through an update. | FALSE | Date | | 2016-01-08T11:13:47-05:00 |\n| VUUID | JcatVUuid | VUUID - A unique identifier. An example of a VUUID is \"B508C0BE1A5181A0E0530100007F6EDF\" | FALSE | string | 64 | B508C0BE1A5181A0E0530100007F6EDF |\n\n## Other (Optional) Body Parameters\n\n| **CMiC UI Fieldname** | **Name** | **Description** | **Type** | **Data Length** | **Example** |\n| --- | --- | --- | --- | --- | --- |\n| Actual Labor Amount | 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 |\n| Added From Application | JcatAddedFromApp | Added From Application - Indicates the 3-character application code if the specific job code/cost code/category code record is created apart from the \"JC\" - Job Costing application. Not updatable. | string | 3 | |\n| Add-On Amount | JcatAddonAmt | Add-On Amount has been deprecated and should no longer be used. | BigDecimal | 18,2 | |\n| Anticipated Cost Amount | JcatAnticipatedCostAmt | Anticipated Cost Amount - The projected or expected cost associated with the specific job code/cost code/category code combination. This forecast helps in budgeting and financial planning by estimating future expenses.

Not updatable. | BigDecimal | 18,2 | 15000 |\n| Bid Item Remaining Amount | JcatBidItemRemainingAmt | Bid Item Remaining Amount - The remaining amount allocated for bid items under the job code/cost code/category code. Not updatable. | Number | | 250 |\n| Billing Code | JcatBillCode | Billing Code has been deprecated and should no longer be used. | string | 12 | |\n| Billing Name | JcatBillName | Billing Name - has been deprecated and should no longer be used. Not updatable. | string | 15 | |\n| Billing Type Code | JcatBillingTypeCode | Billing Type Code - A code that indicates the default billing type such cost or milestone-based billing. Not updatable. | string | 4 | |\n| Budget Adjustment Amount | JcatBudgAdjustmentAmt | Budget Adjustment Amount - The amount by which the original cost budget has been adjusted. Not updatable. | BigDecimal | 18,2 | 500 |\n| Budgeted Revenue Amount | JcatBudgRevAmt | Budgeted Revenue Amount has been deprecated and should no longer be used. | BigDecimal | 18,2 | |\n| Budgeted Revenue Quantity | JcatBudgRevQty | Budgeted Revenue Quantity has been deprecated and should no longer be used. | Number | 18,8 | |\n| Budgeted Revenue Revision Amount | JcatBudgRevRevAmt | Budgeted Revenue Revision Amount - The revised amount of budgeted revenue after adjustments or updates. Not updatable. | BigDecimal | 18,2 | 18000 |\n| Calculated Column Name | JcatCalculateColumnName | Calculated Column Name - The name of a column used for calculated values for the job code/cost code/category code combination. Not updatable. | string | 30 | |\n| Change Order Quantity | JcatChgOrdQty | Change Order Quantity – To date posted change order quantities.

Not updatable. | BigDecimal | 18,8 | 200 |\n| Change Order Revenue Amount | JcatChgOrdRevAmt | Change Order Revenue Amount - To date posted change order bill amount.

Not updatable. | BigDecimal | 18,2 | 10000 |\n| Committed Unit | JcatCommUnit | Committed Unit – To date posted committed quantity for the given job code/cost code/category code, such as hours, days, or material units.

Not updatable. | Number | | 150 |\n| Completion Percentage Date | JcatComplPcDate | Completion Percentage Date - The date when the completion percentage was recorded or updated.

Not updatable. | Date | | 2016-05-02T11:13:47-05:00 |\n| Cost Rate Override Amount | JcatCostRateOverrideAmt | Cost Rate Override Amount - An override value for the standard cost rate, allowing adjustments to the predetermined rates for specific circumstances. This can be used to accommodate changes in labor rates, material costs, or other variables.

Not updatable. | Number | 16,4 | 55 |\n| Cost Entry | JcatCstEntry | Cost Entry -

has been deprecated and should no longer be used. | string | 1 | |\n| Category Control Code | JcatCtrlCode | Control Code - A code to indicate whether the given category is a standalone category or controls one or more sub categories. If the given category is a standalone category then the Control Code will be \"All\".

Not updatable. | string | 16 | All |\n| Disbursement Amount | JcatDisbAmt | Disbursement Amount has been deprecated and should no longer be used. | BigDecimal | 18,2 | |\n| Delay Amount | JcatDlbAmt | Delay Amount - The monetary value associated with delays in the job category, such as penalties, additional costs, or extended resource allocations due to project delays.

Not updatable. | BigDecimal | 18,2 | 5000 |\n| Freeze Projected Amount flag - Checkbox | JcatFreezeProjAmtFlag | Freeze Projected Amount Flag - 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 |\n| Forward Loss Override Percentage | 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.

Not updatable. | Number | 18,4 | 5% |\n| Habitual Pay Amount | JcatHbPayAmt | Habitual Pay Amount - Refers to the standard or regular pay amount allocated for the job category.

Not updatable. | Number | 18,2 | 400 |\n| Ideal Revenue Amount | JcatIdealRevenueAmt | Ideal Revenue Amount - The optimal or target revenue expected from the job category under ideal conditions.

Not updatable. | Number | 18,2 | 10000 |\n| Invoice Committed Unit | JcatInvCommUnit | Invoice Committed Unit - The total units invoiced on posted commitments against a specific job code/cost code/category code combination.

Not updatable. | Number | | 6 |\n| Invoice Unit | JcatInvUnit | Invoice Unit - The number of units invoiced under the specific job code/cost code/category code, such as hours billed, materials delivered, or tasks completed.

Not updatable. | Number | | 4 |\n| Invoice Format Code | JcatInvoiceFormatCode | Invoice Format Code - A code that specifies the format or template used for generating invoices for the job.

Not updatable. | string | 4 | U17 |\n| Maximum Billing Amount | JcatMaxBillingAmt | Maximum Billing Amount - The upper limit for billing amounts within the job code/cost code/category code.

Not updatable. | Number | 18,2 | 16000 |\n| Maximum Billing Budget Amount | JcatMaxBillingBudgetAmt | Maximum Billing Budget Amount - The maximum budget allocated for billing activities the specific job code/cost code/category code combination. This ensures that billing does not surpass the defined budget limit.

Not updatable. | Number | 18,2 | 20000 |\n| Non-Committed Cost Amount | JcatNcommCostAmt | Non-Committed Cost Amount - The total costs incurred on non-commitments.

Not updatable. | Number | 18,2 | 5000 |\n| Non-Invoice Committed Amount | JcatNinvCommAmt | Non-Invoice Committed Amount - The total amount invoiced on non-commitments against a specific job code/cost code/category code combination.

Not updatable. | Number | 18,2 | 7500 |\n| Original Budget Change Order Amount | JcatObudgChgOrdAmt | Original Budget Change Order Amount - The original/ initial cost budget amount allocated to the WBS mapped code/cost code/category code combination in Contract Forecasting upon posting change orders before any adjustments or revisions.

Not updatable. | Number | 18,2 | 8000 |\n| Original Budget Change Order Revenue Amount | JcatObudgChgOrdRevAmt | Original Budget Change Order Revenue Amount - The original/ initial revenue budget amount allocated to the WBS mapped code/cost code/category code combination in Contract Forecasting upon posting change orders before any adjustments or revisions.

Not updatable. | Number | 18,2 | 12000 |\n| Original Budget Change Order Unit | JcatObudgChgOrdUnit | Original Budget Change Order Unit - The original/ initial quantity allocated to the WBS mapped code/cost code/category code combination in Contract Forecasting upon posting change orders before any adjustments or revisions.

Not updatable. | Number | 18,8 | 25 |\n| Original Budget Unit | JcatObudgUnit | Original Budget Unit - The original/ initial quantity allocated to the job code/cost code/category code before any adjustments or revisions.

Not updatable. | Number | | 100 |\n| Progress Billing Billing Code | JcatPbBillCode | Progress Billing Billing Code – the default bill code (the bill code without any WBS information). | string | 50 | |\n| Phase Hierarchy | JcatPhsHier | Phase Hierarchy - A string representing the hierarchical structure of a specific phase/ cost code and control cost code within the company and job.

Not updatable. | string | 127 | An example of Phase Hierarchy is \"ZZ ZZ-T&M 02 02-300\" which combines a Company code \"ZZ\", a Job Code \"ZZ-T&M, a Phase control code \"02\", and a Phase Code, \"02-300\". |\n| Prior Cost Amount | JcatPriorCostAmt | Prior Cost Amount – The total cost amount for the job before the date defined for its \"Ignore Costs Prior To Date\" field.

Not updatable. | Number | 18,2 | 1200 |\n| Prior Cost Quantity | JcatPriorCostQty | Prior Cost Quantity - The quantity of resources or units associated with the prior cost amounts. A null value indicates no prior cost quantities have been specified.

Not updatable. | Number | | 60 |\n| Productivity Override | JcatProductivityOverride | Productivity Override – A manual override to the specific job code/cost code/category code combination's Productivity in Contract Forecasting (Productivity is calculated as the ratio of Phase/Cost Code quantity completion to Category quantity completion). The overrides are only applicable if bill code method is either \"P\" – Productivity or \"U\" – Units.

Not updatable. | Number | 16,4 | 5 |\n| Revenue Adjustment Amount | JcatRevAdjustmentAmt | Revenue Adjustment Amount - The amount by which the original revenue budget has been adjusted.

Not updatable. | Number | 18,2 | 2500 |\n| Rule Code | JcatRuleCode | Rule Code – The budget spread rule code for the company/job code/cost code/category.

Not updatable. | string | 20 | Ex. MONTHLY, WEEKLY |\n| Time Phased – Checkbox | JcatTimePhasedFlag | Time Phased Flag - 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 | |\n| User | JcatUserEnteredProjAmt | User-Entered Projected Amount - The projected amount manually entered by the user, allowing for overrides or adjustments to the system-generated projected amounts.

Not updatable. | Number | 18,2 | 15000 |\n| User | JcatUserEnteredProjUnit | User-Entered Projected Unit - The projected unit manually entered by the user, allowing for overrides or adjustments to the system-generated projected units.

Not updatable. | Number | | 300 |\n| Variable Code | JcatVarCode | Variable Code - A code that categorizes variables or modifiers applicable to the job code/cost code/category code.

Not updatable. | string | 1 | |\n| WBS Budget Flag | JcatWbsBudgetFlag | WBS Budget Flag - A flag indicating whether the Work Breakdown Structure (WBS) budget is active (\"Y\") or not (\"N\") for the job code/cost code/category code.

Not updatable. | string | 1 | Y |\n| WBS Value Code 1 | JcatWbsvCode1 | WBS Value Code 1 – The user defined Work Breakdown Structure (WBS) codes provide a supplementary method to effectively track and summarize costs on a transaction to transaction basis. Normally the WBS 1 code is usually set to PCI. | string | 60 | Ex. PCI |\n| WBS ValueCode 2 | JcatWbsvCode2 | WBS Value Code 2 - The user defined Work Breakdown Structure (WBS) codes provide a supplementary method to effectively track and summarize costs on a transaction to transaction basis. | string | 60 | |\n| WBS Value Code 3 | JcatWbsvCode3 | WBS Value Code 3 - The user defined Work Breakdown Structure (WBS) codes provide a supplementary method to effectively track and summarize costs on a transaction to transaction basis. | string | 60 | |\n| WBS Value Code 4 | JcatWbsvCode4 | WBS Value Code 4 - The user defined Work Breakdown Structure (WBS) codes provide a supplementary method to effectively track and summarize costs on a transaction to transaction basis. | string | 60 | |\n| WBS ValueEditable Flag 1 | JcatWbsvEditableFlag1 | WBS Value Editable Flag 1 - A flag indicating whether the first WBS value code (WbsvCode1) is editable during transaction entry (\"Y\") or not (\"N\"). | string | 1 | Y |\n| WBS ValueEditable Flag 2 | JcatWbsvEditableFlag2 | WBS Value Editable Flag 2 - A flag indicating whether the second WBS value code (WbsvCode2) is editable during transaction entry (\"Y\") or not (\"N\"). | string | 1 | Y |\n| WBS ValueEditable Flag 3 | JcatWbsvEditableFlag3 | WBS Value Editable Flag 3 - A flag indicating whether the third WBS value code (WbsvCode3) is editable during transaction entry (\"Y\") or not (\"N\"). | string | 1 | Y |\n| WBS ValueEditable Flag 4 | JcatWbsvEditableFlag4 | WBS Value Editable Flag 4 - A flag indicating whether the fourth WBS value code (WbsvCode4) is editable during transaction entry (\"Y\") or not (\"N\"). | string | 1 | Y |\n| WBS Value Required Flag 1 | JcatWbsvRequiredFlag1 | WBS Value Required Flag 1 - A flag indicating whether the first WBS value code (WbsvCode1) is required (\"Y\") or not (\"N\"). | string | 1 | Y |\n| WBS Value Required Flag 2 | JcatWbsvRequiredFlag2 | WBS Value Required Flag 2 - A flag indicating whether the second WBS value code (WbsvCode2) is required (\"Y\") or not (\"N\"). | string | 1 | Y |\n| WBS Value Required Flag 3 | JcatWbsvRequiredFlag3 | WBS Value Required Flag 3 - A flag indicating whether the third WBS value code (WbsvCode3) is required (\"Y\") or not (\"N\"). | string | 1 | Y |\n| WBS Value Required Flag 4 | JcatWbsvRequiredFlag4 | WBS Value Required Flag 4 - A flag indicating whether the fourth WBS value code (WbsvCode4) is required (\"Y\") or not (\"N\"). | string | 1 | Y |\n| WCB Code | JcatWcbCode | WCB Code - The Workers compensation code defined for the company/job. | string | 4 | Ex. WC1 |\n| WM Code | JcatWmCode | WM Code - This code specifies the unit of measure for the category or subcategory being set up. | string | 2 | Ex. hours of labor - HR or Lumpsum – LS or NA – Not Applicable. |\n| Update Date | JcatIuUpdateDate | Update Date - The timestamp indicating the last time the job category record was updated. An example of an Integration Update is \"2024-10-23T10:49:35-04:00\" which shows the last update times. | Date | | 2024-10-23T10:49:35-04:00 |", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "JcatCompCode": "ZZ", "JcatJobCode": "PC-20246R", "JcatPhsCode": "02-100", "JcatPhaseActiveFlag": "Y", "JcatCode": "8000", "JcatCatActiveFlag": "Y", "JcatExclCostWip": "N", "JcatLabourForecastFlag": "N", "JcatCostToComplOvrdFlg": "N", "JcatExclCostBudgWip": "N", "JcatVUuid": "" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/vnd.oracle.adf.resourceitem+json" } ], "responses": { "201": { "description": "Created", "headers": { "Content-Type": { "schema": { "type": "string", "example": "application/vnd.oracle.adf.resourceitem+json" } } }, "content": { "text/plain": { "schema": { "type": "string" }, "example": "{\n \"JcatActLbAmt\": null,\n \"JcatAddedFromApp\": null,\n \"JcatAddonAmt\": null,\n \"JcatAnticipatedCostAmt\": null,\n \"JcatBidItemRemainingAmt\": null,\n \"JcatBillingTypeCode\": null,\n \"JcatBillAmt\": null,\n \"JcatBillCode\": null,\n \"JcatBillName\": null,\n \"JcatBudgAdjustmentAmt\": null,\n \"JcatBudgAmt\": null,\n \"JcatBudgRevenueAmt\": null,\n \"JcatBudgRevAmt\": null,\n \"JcatBudgRevQty\": null,\n \"JcatBudgRevRevAmt\": null,\n \"JcatBudgUnit\": null,\n \"JcatBudgUnitRate\": null,\n \"JcatBudmethCode\": null,\n \"JcatCalculateColumnName\": null,\n \"JcatCatActiveFlag\": \"Y\",\n \"JcatCatHier\": null,\n \"JcatChgOrdAmt\": null,\n \"JcatChgOrdQty\": null,\n \"JcatChgOrdRevAmt\": null,\n \"JcatCode\": \"4000\",\n \"JcatCommUnit\": null,\n \"JcatComplPc\": null,\n \"JcatComplPcDate\": null,\n \"JcatComplUnit\": null,\n \"JcatCompCode\": \"ZZ\",\n \"JcatCostAmt\": null,\n \"JcatCostRateOverrideAmt\": null,\n \"JcatCostToComplOvrdFlg\": \"N\",\n \"JcatCstEntry\": null,\n \"JcatCtrlCode\": \"ALL\",\n \"JcatDisbAmt\": null,\n \"JcatDlbAmt\": null,\n \"JcatExclCostBudgWip\": \"N\",\n \"JcatExclCostWip\": \"N\",\n \"JcatFreezeProjAmtFlag\": null,\n \"JcatFwdLossOvrhPct\": null,\n \"JcatHbPayAmt\": null,\n \"JcatIdealRevenueAmt\": null,\n \"JcatInvoiceFormatCode\": null,\n \"JcatInvCommAmt\": null,\n \"JcatInvCommUnit\": null,\n \"JcatInvUnit\": null,\n \"JcatJobCode\": \"PC-20246R\",\n \"JcatJobCtrlCode\": null,\n \"JcatLabourForecastFlag\": \"N\",\n \"JcatMaxBillingAmt\": null,\n \"JcatMaxBillingBudgetAmt\": null,\n \"JcatNcommCostAmt\": null,\n \"JcatNinvCommAmt\": null,\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\": \"01-200\",\n \"JcatPhsCtrlCode\": \"ALL\",\n \"JcatPhsHier\": null,\n \"JcatPriorCostAmt\": null,\n \"JcatPriorCostQty\": null,\n \"JcatProductivityOverride\": null,\n \"JcatProjAmt\": null,\n \"JcatProjUnit\": null,\n \"JcatRevAdjustmentAmt\": null,\n \"JcatRuleCode\": null,\n \"JcatTimePhasedFlag\": null,\n \"JcatUserEnteredProjAmt\": null,\n \"JcatUserEnteredProjUnit\": null,\n \"JcatVarCode\": null,\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\": null,\n \"JcatWbsvEditableFlag10\": null,\n \"JcatWbsvEditableFlag11\": null,\n \"JcatWbsvEditableFlag12\": null,\n \"JcatWbsvEditableFlag2\": null,\n \"JcatWbsvEditableFlag3\": null,\n \"JcatWbsvEditableFlag4\": null,\n \"JcatWbsvEditableFlag5\": null,\n \"JcatWbsvEditableFlag6\": null,\n \"JcatWbsvEditableFlag7\": null,\n \"JcatWbsvEditableFlag8\": null,\n \"JcatWbsvEditableFlag9\": null,\n \"JcatWbsvPciLineOraseq\": null,\n \"JcatWbsvRequiredFlag1\": null,\n \"JcatWbsvRequiredFlag10\": null,\n \"JcatWbsvRequiredFlag11\": null,\n \"JcatWbsvRequiredFlag12\": null,\n \"JcatWbsvRequiredFlag2\": null,\n \"JcatWbsvRequiredFlag3\": null,\n \"JcatWbsvRequiredFlag4\": null,\n \"JcatWbsvRequiredFlag5\": null,\n \"JcatWbsvRequiredFlag6\": null,\n \"JcatWbsvRequiredFlag7\": null,\n \"JcatWbsvRequiredFlag8\": null,\n \"JcatWbsvRequiredFlag9\": null,\n \"JcatWbsBudgetFlag\": null,\n \"JcatWcbCode\": null,\n \"JcatWmCode\": null,\n \"JcatIuCreateDate\": \"2026-03-27T16:00:53-04:00\",\n \"JcatIuUpdateDate\": null,\n \"JcatVUuid\": \"4E07EAF66AAF8AF4E0630B811DACDFE4\",\n \"links\": [\n {\n \"rel\": \"self\",\n \"href\": \"http://127.0.0.1:7101/jc-rest-api/rest/2/jcjobcategory/4E07EAF66AAF8AF4E0630B811DACDFE4\",\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/4E07EAF66AAF8AF4E0630B811DACDFE4\",\n \"name\": \"jcjobcategory\",\n \"kind\": \"item\"\n }\n ]\n}" } } } } } } }, "components": { "securitySchemes": { "cmicBasicAuth": { "type": "http", "scheme": "basic", "description": "Basic authentication" } } } } ````