Create an SC Detail

Prev Next
Post
/pm-rest-api/rest/1/scsched

Overview

This endpoint is utilized to create and manage the Schedule of Values (SOVs) for Subcontracts within CMiC. The SOVs define the total financial value of a subcontract broken down by specific tasks or line items.

Notes

This functionality integrates with the Request for Payment (RFP), Subcontract Management and Release of Retainage features. For example, the Request for Payment interface enables users to generate Vouchers against these SOVs, directly linking financial management to subcontract payment management.

UI Navigation

Subcontract Management > Contracts > Enter Subcontract/Change Order

Reference Article

https://docs.cmicglobal.com/portal/Content/E_Reference_Material/CMiC_Field/Reference/Budget___Cost_Management/Subcontract_Schedule_of_Values.htm

https://docs.cmicglobal.com/portal/Content/E_Reference_Material/SC_-_Subcontract_Management/Reference/Contracts/SOV_Tab.htm

Commonly Used Body Parameters

CMiC UI Fieldname Object Name Description Type Data Length Example Required
Cat. - Category Code scsched ScschCatCode Enter the category code for the cost element being entered in this line. The category entered must have been previously set up in the Job Costing application and associated with the cost code entered in the Cost Code field. string 16 S Yes
Change Code scsched ScschChgCode Indicates whether the line item is part of a subcontract change order. Must match SCMST_CHG_CODE string 6 000 Yes
Company Code scsched ScschCompCode Identifies the internal company responsible for managing the subcontrac. Must be a valid CMiC Company. string 8 ZZ Yes
Contract Code scsched ScschContCode Associates the SOV line to a specific subcontract or subcontract change order within CMiC. Must match SCMST_CONT_CODE. string 20 03202023009 Yes
Job Code scsched ScschJobCode This is the specific Job Code that the subcontract line applies to. Must be either the SCMST_JOB_CODE or a sub-job string 10 ADFJOB01 Yes
Task Code scsched ScschTaskCode A user defined alphanumeric identifier. Enter the task code associated with Schedule of Values line item. string 16 TASK1 Yes
Vendor Code scsched ScschVenCode Represents the subcontractor vendor associated with the SOV line item. Must match SCMST_VEN_CODE. string 8 JEWELS Yes
Subcontract Item Master Job Code scsched ScschSiMastJobCode References the job code for subcontract items, if applicable. Must be either the SCMST_JOB_CODE or a sub-job string 10 BALMORAL01 No
Phase Code scsched ScschPhsCode Associates the SOV line with a specific cost code (phase) of the job or project. Must be a valid segment for the job structure. string 16 0110 No
Weight Measure (W/M) Code scsched ScschWmCode Specifies the weight measure for the amount of the SOV line. For example, cubic yards, dollars, or hours. Weight Measure, must be previously defined in CmiC. string 2 No
Amount scsched ScschAmt Represents the dollar value to date of the contract line. Enter the amount to complete the task (before VAT taxes). The total Subcontract amount will be the total amounts entered for each task. number 18 5074.6 No

Other (Optional) Body Parameters

CMiC UI Fieldname Object Name Description Type Data Length Example Required
Expense Code (Prepaid Insurance) scsched ScschApexpCode If the Prepaid Insurance/Expense feature is being used and this subcontract has prepaid insurance, then enter/select the expense code from the LOV. If entering an expense code, make sure that the Ret% (Retainage Percentage) field is set to zero, as prepaid insurance cannot have retainage applied to it.

For details about the Prepaid Insurance/Expense feature, please refer to Prepaid Insurance (Contractor Controlled Insurance Program).
string 10 AP001 No
JB Bill Code scsched ScschBillCode Used for Job Billing or referencing specific bill item related to the SOV line. For details about the functionality for which this field is relevant, please refer to Create Separate Invoices for Each Customer on Single JB Contract and Allow SC Request For Payment Creation From Billing Invoice. string 50 BILL01 No
Completed Amount scsched ScschComplAmt Indicates the total amount certified or completed to date for this SOV line item. number 18 1000 No
Completed Percentage scsched ScschComplPct Shows the percentage of work completed for this SOV line item. number 7 0.1 No
Completed Quantity scsched ScschComplQty Represents the quantity of work completed to date for this SOV line item. number 16 100 No
Current Holdback Amount scsched ScschCurrHldbkAmt The retention amount is currently withheld for this SOV line item. number 18 100 No
Current Holdback Release scsched ScschCurrHldbkRlsAmt Amount of holdback released in the current period for this SOV line item. number 18 0 No
Fully Purchased Flag scsched ScschFullyPurchasedFlag Indicates whether the SOV line item is fully purchased (Y) or not (N). string 1 “Y” / “N” No
Holdback Percentage scsched ScschHldbkPct Specifies the retention percentage applied to this SOV line item. number 6 10 No
Create Date scsched ScschIuCreateDate The date and time when the SOV line item was initially created in CMiC. datetime 2024-12-30T09:40:37-05:00 No
Update Date scsched ScschIuUpdateDate The date and time when the SOV line item was last updated in CMiC. datetime 2024-12-30T09:40:43-05:00 No
Job Billing Code scsched ScschJbBillCode Used for billing references related to the job, facilitating accurate billing processes. string 50 JBILL01 No
Job Contract Code scsched ScschJbContCode Links the SOV line item to a specific job contract record within CMiC, if applicable. string 10 JCONT01 No
Line Changed Flag scsched ScschLineChangedFlag Indicates whether the SOV line item has been modified after its initial creation (Y/N). string 1 “Y” / “N” No
Line Number scsched ScschLineNum Provides a numeric sequence or reference number for the SOV line item within the subcontract. integer 3 10 No
Long Description scsched ScschLongDesc User-text field, if the SOV line requires further description, enter it here. string 4000 Installation of lighting fixtures No
Last Amount scsched ScschLstAmt Indicates the previous or last recorded amount for this SOV line item, useful for tracking changes over time. number 18 1000 No
Oracle Sequence scsched ScschOraseq An Oracle-based sequence number used for internal referencing within CMiC’s database system. Used for requesting payments via AP Vouchers (RFPs) for SOV. number 58797757 No
Order Number scsched ScschOrderNum Represents the display or sequence order of the SOV line item within the subcontract. number 1 No
Previous Certified Amount scsched ScschPrevCertAmt Reflects the amount previously certified for this SOV line item, aiding in financial tracking. number 18 500 No
Previous Certified Quantity scsched ScschPrevCertQty Shows the quantity previously certified for this SOV line item, assisting in progress tracking. number 16 50 No
Previous Holdback Amount scsched ScschPrevHldbkAmt Represents the retention amount previously withheld for this SOV line item. number 18 50 No
Previous Holdback Release scsched ScschPrevHldbkRlsAmt Indicates the amount of holdback released previously for this SOV line item. number 18 0 No
SI Line Number scsched ScschSiLineNum References the specific Subcontract Item (SI) detail line number associated with this SOV line. integer 3 5 No
SI Number scsched ScschSiNum Represents the Subcontract Item reference number linked to this SOV line item, facilitating detailed subcontract tracking. integer 5 102 No
SI Revision Number scsched ScschSiRevisNum Indicates the revision number for changes made to the Subcontract Item associated with this SOV line item. integer 3 2 No
Subcontract Code scsched ScschSubcontrCode Used for alternate or secondary referencing of the subcontract. Commonly set to "NONE" if not applicable. string 20 NONE No
Task Description scsched ScschTaskName Provides a readable name or description for the task or line item within the SOV, enhancing clarity and understanding. string 200 SCCOTASK No
Tax1 Code scsched ScschTax1Code Specifies the first applicable tax code for the SOV line item, facilitating accurate tax calculations and reporting. Each SOV line can have taxes applied. The system may have defaulted values from either the job or the vendor into these fields if the ‘Default Taxes’ checkbox is checked in the General tab of this screen. These are defaults and can be changed on a line-by-line basis. There is a maximum of five unique tax codes per contract. string 10 01 No
Tax1 Taxable Flag scsched ScschTax1TaxableFlag Indicates whether the first tax code is applicable to this SOV line item (Y/N). string 1 “Y” / “N” No
Tax2 Code scsched ScschTax2Code Specifies the second applicable tax code for the SOV line item. string 10 02 No
Tax2 Taxable Flag scsched ScschTax2TaxableFlag Indicates whether the second tax code is applicable to this SOV line item (Y/N). string 1 “Y” / “N” No
Tax3 Code scsched ScschTax3Code Specifies the third applicable tax code for the SOV line item. string 10 03 No
Tax3 Taxable Flag scsched ScschTax3TaxableFlag Indicates whether the third tax code is applicable to this SOV line item (Y/N). string 1 “Y” / “N” No
Tender Package Line Number scsched ScschTendpackLineNum References the line number from an external tender package, if applicable. integer 3 12 No
Units scsched ScschUnit Represents the total quantity of units for this SOV line item. number 16 300.45 No
Unit Rate scsched ScschUnitRate Either enter the amount of the SOV line or the unit and rate, from which the amount can be calculated. number 19 16.89 No
WBS (Work Breakdown Structure) Value Code 1 scsched ScschWbsvCode1 The Work Breakdown Structure (WBS) codes provide a supplementary method to effectively track and summarize costs on a transaction-to-transaction basis beyond the cost structure of job, cost code category native to CMiC. Enter any WBS codes and values in these fields. These can be created in the WBS Codes and WBS Values screens. string 60 WBS001 No
WBS (Work Breakdown Structure) Value Code 2 scsched ScschWbsvCode2 The Work Breakdown Structure (WBS) codes provide a supplementary method to effectively track and summarize costs on a transaction-to-transaction basis beyond the cost structure of job, cost code category native to CMiC. Enter any WBS codes and values in these fields. These can be created in the WBS Codes and WBS Values screens. string 60 WBS002 No
WBS (Work Breakdown Structure) Value Code 3 scsched ScschWbsvCode3 The Work Breakdown Structure (WBS) codes provide a supplementary method to effectively track and summarize costs on a transaction-to-transaction basis beyond the cost structure of job, cost code category native to CMiC. Enter any WBS codes and values in these fields. These can be created in the WBS Codes and WBS Values screens. string 60 WBS003 No
WBS (Work Breakdown Structure) Value Code 4 scsched ScschWbsvCode4 The Work Breakdown Structure (WBS) codes provide a supplementary method to effectively track and summarize costs on a transaction-to-transaction basis beyond the cost structure of job, cost code category native to CMiC. Enter any WBS codes and values in these fields. These can be created in the WBS Codes and WBS Values screens. string 60 WBS004 No
Unique Sequence By SC scsched ScschSeqNumUniqueBySc Ensures each SOV line item is uniquely identified within the subcontract to prevent duplication. number 1 No
Date/Time Posted scsched ScschDateTimePost Indicates when the SOV line item was posted to the system, marking it as active and visible within CMiC. datetime 2024-12-30T09:40:43-05:00 No
UUID scsched ScschVUuid A unique identifier ensuring each SOV line item is distinctly recognized within CMiC. In a post request, leave this line empty. string 64 2A7ECBB332A21A20E06327261DAC0767 No
Previous Material Stored Amount scsched ScschPrevMatStoredAmt Previous Material Amount on the current RFP. number 18 200
Current Material Stored Amount scsched ScschCurrMatStoredAmt Material Stored Amount on the current RFP number 18 800
Security
HTTP
Type basic

Basic authentication

Header parameters
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourceitem+json
Body parameters
object
Example{ "ScschCompCode": "001", "ScschJobCode": "15-001", "ScschVenCode": "10TILE", "ScschContCode": "15-001.001", "ScschChgCode": "001", "ScschTaskCode": "1", "ScschPhsCode": "99999", "ScschCatCode": "S", "ScschWmCode": "$", "ScschAmt": 10, "ScschVUuid": "" }
Responses
201

Created

Headers
Content-Type
string
Exampleapplication/json
{
  "ScschAmt": 60,
  "ScschApexpCode": null,
  "ScschBillCode": null,
  "ScschCatCode": "2000",
  "ScschChgCode": "000",
  "ScschCompCode": "ZZ",
  "ScschComplAmt": 10,
  "ScschComplPct": 16.667,
  "ScschComplQty": 0.33333333,
  "ScschContCode": "VAITESTR",
  "ScschCurrHldbkAmt": 0,
  "ScschCurrHldbkRlsAmt": 0,
  "ScschFullyPurchasedFlag": "N",
  "ScschHldbkPct": 10,
  "ScschIuCreateDate": "2025-03-04T20:05:39Z",
  "ScschIuUpdateDate": "2025-03-04T20:16:47Z",
  "ScschJbBillCode": null,
  "ScschJbContCode": null,
  "ScschJobCode": "VAI",
  "ScschLineChangedFlag": null,
  "ScschLineNum": null,
  "ScschLongDesc": null,
  "ScschLstAmt": 0,
  "ScschOraseq": 2147491498,
  "ScschOrderNum": 1,
  "ScschPhsCode": "00",
  "ScschPrevCertAmt": 10,
  "ScschPrevCertQty": 0.33333333,
  "ScschPrevHldbkAmt": 0,
  "ScschPrevHldbkRlsAmt": 0,
  "ScschSiLineNum": null,
  "ScschSiMastJobCode": null,
  "ScschSiNum": null,
  "ScschSiRevisNum": null,
  "ScschSubcontrCode": "NONE",
  "ScschTaskCode": "1",
  "ScschTaskName": "1",
  "ScschTax1Code": null,
  "ScschTax1TaxableFlag": "Y",
  "ScschTax2Code": null,
  "ScschTax2TaxableFlag": "Y",
  "ScschTax3Code": null,
  "ScschTax3TaxableFlag": "Y",
  "ScschTax4Code": null,
  "ScschTax4TaxableFlag": "Y",
  "ScschTax5Code": null,
  "ScschTax5TaxableFlag": "Y",
  "ScschTendpackLineNum": null,
  "ScschUnit": 2,
  "ScschUnitRate": 30,
  "ScschVenCode": "1-URBAN",
  "ScschWbsvCode1": null,
  "ScschWbsvCode2": null,
  "ScschWbsvCode3": null,
  "ScschWbsvCode4": null,
  "ScschWmCode": "NA",
  "ScschVUuid": "2F8ACB679B60988EE0630B811DAC4078",
  "ScschSeqNumUniqueBySc": 1,
  "ScschDateTimePost": "2025-03-04T20:05:42Z",
  "ScschPrevMatStoredAmt": 5,
  "ScschCurrMatStoredAmt": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/pm-rest-api/rest/1/scsched/2F8ACB679B60988EE0630B811DAC4078",
      "name": "scsched",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/pm-rest-api/rest/1/scsched/2F8ACB679B60988EE0630B811DAC4078",
      "name": "scsched",
      "kind": "item"
    }
  ]
}
object
Copyright © 2024 CMiC All Rights Reserved