Update a Specific JB Contract Detail

Updated on 29 May 2025
7 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Patch

/jb-rest-api/rest/1/jbcontdet/2D9110EE26E10235E06327261DAC886A

Overview

The jbcontdet API endpoint (PATCH) is used to update billing details for a Job Billing contract. It allows adding new billing codes, defining billing amounts, units, retainage percentages, tax applicability, and invoice grouping. This endpoint ensures accurate job billing setup.

Job Billing > Contracts > Enter Contract – Billing Items – Billing Codes tab

Reference Article

https://docs.cmicglobal.com/portal/Content/E_Reference_Material/JB_-_Job_Billing/Reference/Creating_a_Billing_Contract/Billing_Codes___Tab.htm

Commonly Used Body Parameters

CMiC UI Fieldname	Object	Name	Description	Type	Data Length	Example	Required	Updatable
Filter	jbcontdet	JbcdAmtBurdenFilter	Enter Burden Filter: Regular, Premium Labor, Regular Insured Labor	string	10	Regular	Yes	Yes
Cat	jbcontdet	JbcdBillCatCode	Enter Valid Category Code	string	16	C	Yes	Yes
Billing Code	jbcontdet	JbcdBillCode	Enter valid Billing Code	string	50	100.BI100	Yes	Yes
Job	jbcontdet	JbcdBillJobCode	Enter valid job code	string	10	LGJOB	Yes	Yes
Cost Code	jbcontdet	JbcdBillPhsCode	Enter the cost phase associated	string	16	PH101	Yes	Yes
Type	jbcontdet	JbcdBillingTypeCode	Billing Type Code	string	4	LSUM	Yes	Yes
Company	jbcontdet	JbcdCompCode	Enter valid company code	string	8	ZZ	Yes	Yes
Contract	jbcontdet	JbcdContCode	Enter contract code associated	string	10	CON123	Yes	Yes
Curr $	jbcontdet	JbcdCurrCode	Currency Code	string	3	CAD	Yes	Yes
Description	jbcontdet	JbcdDesc	Billing Code Description	string	60	Test	Yes	Yes
Inv Fmt	jbcontdet	JbcdInvoiceFormatCode	Specifies the format in which invoices are generated	string	4	FORMAT1	Yes	Yes
MultiSubContract	jbcontdet	JbcdMultiSubcontFlag	Indicates whether multiple subcontracts are used	string	1	Y	Yes	Yes
MultiSubcontract Vendor	jbcontdet	JbcdMultiSubcontVenFlag	Indicates whether multiple subcontract vendors are assigned	string	1	N	Yes	Yes
Sc RFP	jbcontdet	JbcdScRfpCostFlag	Determines if the bill code allows SC payment requests (Y = Yes, N = No)	string	1	N	Yes	Yes
Shared Savings	jbcontdet	JbcdSharedSavingFlag	Y: Shared savings bill code, N: LumpSum	string	1	Y	Yes	Yes
Lst Rel %	jbcontdet	JbcdUseScrfpHldbkRelFlag	Y: Calculate retainage release amount as the same percentage as used in the latest SC request for payment	string	1	N	Yes	Yes
Wm	jbcontdet	JbcdWmCode	Enter Weight/measure code for billing item	string	2	HR	Yes	Yes

Other (Optional) Body Parameters

CMiC UI Fieldname	Object	Name	Description	Type	Data Length	Example	Required	Updatable
Active	jbcontdet	JbcdActiveFlag	Is Active or Not	string	1	Y	No	Yes
Bill Exists	jbcontdet	JbcdBillExists	Flag indicating if a bill code exists (Y/ N)	string	1	Y	No	Yes
Billing Rate	jbcontdet	JbcdBillingRate	A unit Rate for the billing item	number	18	10	No	Yes
Billing	jbcontdet	JbcdBillingTypeName	Billing Type Name associated	string	60	LUMPSUM	No	Yes
Bill td Amount	jbcontdet	JbcdBilltdAmt	Total Amount billed to date	number	18	25000	No	Yes
Budg. Billing Amount	jbcontdet	JbcdBudgBillingAmt	Contract Amount for billing amount	number	18	10000	No	Yes
Budg. Qty	jbcontdet	JbcdBudgBillingQty	Number of units	number	16	80	No	Yes
Budget Enabled	jbcontdet	JbcdBudgetEnableFlag	Indicates if Budget tracking is enabled (Y/ N)	string	4000	N	No	Yes
Burden Stored Material	jbcontdet	JbcdBurStoredMaterialFlag	Flag indicating whether burden is applied to stored materials (Y / N)	string	1	N	No	Yes
Burden Level	jbcontdet	JbcdBurdenLevel	Burden Level	integer	18	2	No	Yes
Construction Value	jbcontdet	JbcdConstructionValue	Construction value for this bill code. Leave empty to use job construction value	number	18	5000	No	Yes
% of Constr	jbcontdet	JbcdConstructionValuePct	Percentage of construction value for this bill code. Leave black to use job percentage of construction value	number	18	10	No	Yes
Group 1	jbcontdet	JbcdGroupCode1	Invoice Grouping: Used To Summarize Billing Lines On Invoice	string	50	GRP1	No	Yes
Group 2	jbcontdet	JbcdGroupCode2	Invoice Grouping: Used To Summarize Billing Lines On Invoice	string	50	GRP2	No	Yes
Group 3	jbcontdet	JbcdGroupCode3	Invoice Grouping: Used To Summarize Billing Lines On Invoice	string	50	GRP3	No	Yes
Group 4	jbcontdet	JbcdGroupCode4	Invoice Grouping: Used To Summarize Billing Lines On Invoice	string	50	GRP4	No	Yes
Group 5	jbcontdet	JbcdGroupCode5	Invoice Grouping: Used To Summarize Billing Lines On Invoice	string	50	GRP5	No	Yes
Performance Obligations	jbcontdet	JbcdGroupCode6	Identifies the Bill Code as belonging to the 6th JB Group.	string	50	PERF1	No	Yes
Group Name 1	jbcontdet	JbcdGroupName1	Group Name 1	string	80	TEST	No	Yes
Group Name 2	jbcontdet	JbcdGroupName2	Group Name 2	string	80	TEST	No	Yes
Group Name 3	jbcontdet	JbcdGroupName3	Group Name 3	string	80	TEST	No	Yes
Group Name 4	jbcontdet	JbcdGroupName4	Group Name 4	string	80	TEST	No	Yes
Group Name 5	jbcontdet	JbcdGroupName5	Group Name 5	string	80	TEST	No	Yes
Sc Ret	jbcontdet	JbcdHldbkMethod	Defines the retainage method: S (Subcontract) or P (Percentage)	string	1	P	No	Yes
Holdback Pct	jbcontdet	JbcdHldbkPct	Percentage of the invoice amount held as retainage	number	6	10	No	Yes
Inv Level	jbcontdet	JbcdInvLevelCode	Defines the invoice level	string	35	LEVEL1	No	Yes
Create Date	jbcontdet	JbcdIuCreateDate	The date the record was created	datetime		2023-10-19T13:20:58-04:00	No	Yes
Update Date	jbcontdet	JbcdIuUpdateDate	Last modification date of the record	datetime		2023-10-20T13:20:58-04:00	No	Yes
Labour Forecast	jbcontdet	JbcdLabourForecastFlag	Indicates if labor forecasting is enabled	string	1	Y	No	Yes
Max Billing Amt	jbcontdet	JbcdMaxBillingAmt	The maximum allowable billing amount	number	18	500.00	No	Yes
Max Qty	jbcontdet	JbcdMaxBillingQty	Maximum Billing Quantity	number	16	100	No	Yes
Ret. Code	jbcontdet	JbcdRetCode	Retainage code	string	10	RET10	No	Yes
Row ID	jbcontdet	JbcdRowid	Unique row identifier	string	18	1234	No	Yes
Self-Perf	jbcontdet	JbcdSelfPerformedInvFlag	Indicates whether the billing code applies to self-performed work (Y) or subcontract work (N)	string	1	Y	No	Yes
Billing Ref Code	jbcontdet	JbcdSeparateBillingRefCode	Separate Billing Reference Code	string	60	N	No	Yes
Shared Savings	jbcontdet	JbcdSharedSavingPct	Y: shared savings bill code, N: lump sum bill code	number	7	N	No	Yes
Subcontract	jbcontdet	JbcdSubcontCode	Subcontract Code	string	20	SC-2023	No	Yes
System Gen	jbcontdet	JbcdSysGeneratedFlag	System Generated	string	1	Y	No	Yes
Tax 1 Amount	jbcontdet	JbcdTax1Amt	Amount of tax applied	number		500	No	Yes
Tax 1	jbcontdet	JbcdTax1Code	Level 1 Tax Code Applicable To This Line	string	11	TX01	No	Yes
Taxable	jbcontdet	JbcdTax1TaxableFlag	Indicates whether tax is applicable (Y) or not (N)	string	1	Y	No	Yes
Tax 1 %	jbcontdet	JbcdTax1TaxablePct	Portion Of Billed Amount That Is Taxable Using Tax Code 1 (Leave Blank For 100%)	number	18	8.25	No	Yes
Tax 2 Amount	jbcontdet	JbcdTax2Amt	Amount of tax applied	number		500	No	Yes
Tax 2	jbcontdet	JbcdTax2Code	Level 2 Tax Code Applicable To This Line	string	11	TX02	No	Yes
Taxable	jbcontdet	JbcdTax2TaxableFlag	Checked: Taxable Unchecked: Non Taxable. Tax Amount Will Be Calculated As Zero.	string	1	Y	No	Yes
Tax 2 %	jbcontdet	JbcdTax2TaxablePct	Portion Of Billed Amount That Is Taxable Using Tax Code 2 (Leave Blank For 100%)	number	18	6.75	No	Yes
Tax 3 Amount	jbcontdet	JbcdTax3Amt	Amount of tax applied	number		500	No	Yes
Tax 3	jbcontdet	JbcdTax3Code	Level 1 Tax Code Applicable To This Line	string	11	TX03	No	Yes
Taxable	jbcontdet	JbcdTax3TaxableFlag	Checked: Taxable Unchecked: Non Taxable. Tax Amount Will Be Calculated As Zero.	string	1	Y	No	Yes
Tax 3 %	jbcontdet	JbcdTax3TaxablePct	Portion Of Billed Amount That Is Taxable Using Tax Code 3 (Leave Blank For 100%)	number	18	8.75	No	Yes
Total Budget Billing Amount	jbcontdet	JbcdTotalBudgAmt	Total Budget Billing Amount	number		1000	No	Yes
VUuid	jbcontdet	JbcdVUuid	Unique Identifier	string	64	Changes to Date	No	Yes
Vendor	jbcontdet	JbcdVenCode	Enter Vendor Who Did The Work. Leave Blank For Internal Work.	string	8	VEN01	No	Yes
Vendor Name	jbcontdet	JbcdVenName	Enter Vendor Name	string	50	Test	No	Yes

Security

HTTP

Type basic

Basic authentication

Header parameters

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourceitem+json

Body parameters

object

Example{ "JbcdDesc": "JBCONTDET TEST PATCH 1" }

Responses

200

Headers