API Catalog

Retrieve SC Details By Code

13 Jun 2025
10 Minutes to read

Print
Dark
Light

Retrieve SC Details By Code

Updated on 13 Jun 2025
10 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Get

/pm-rest-api/rest/1/scsched

Overview

This endpoint is utilized to view 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.

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

Path Parameters

Parameter	Description	Example
/VUUID	The VUuid attribute is the Unique row ID	/pm-rest-api/rest/1/scsched/EB6C0C7B7A3F613CE05316821FAC75C2

Query Standards

Key	Recommended	Description
finder	Yes	Filters data based on attributes. See finder details below. Finders can be combined using a comma delimiter between parameters that implies an "and" statement. For more information on using the finder functionality please see Best Practice \| Data Filtering requirements
limit	Yes	A limit restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count, then the framework will return all available resources. For additional information on using the limit functionality please visit Best Practice \| Data Filtering requirements
offset	Yes	The offset skips a specified number of items in a data list before it starts showing results. For example, if you set an offset of 10, it skips the first 10 items and begins showing from the 11th item. For additional information on using Offset functionality please visit Best Practice \| Data Filtering requirements
orderBy	Yes	The orderBy attribute retrieves rows using an order ensuring the response payload displays data in the order supplied in the URL parameter using the GET method. For more information on using orderBy functionality please visit Best Practice \| Data Filtering requirements

scsched Finders

Finder	Parameter	Data Type	Description	Example
selectSOV	ChgCodeVar	string	Filter by Change Code	/pm-rest-api/rest/1/scsched?finder=selectSOV;ChgCodeVar=002
selectSOV	CompCodeVar	string	Filter by Company Code	/pm-rest-api/rest/1/scsched?finder=selectSOV;CompCodeVar=ZZ
selectSOV	ContCodeVar	string	Filter by contract code	/pm-rest-api/rest/1/scsched?finder=selectSOV;ContCodeVar=PCCT006
selectSOV	CreateDateGTEQ	datetime	Filter by SOV Creation date, Note that the date used in this filter will act as a minimum date filter not an exact date filter.	/pm-rest-api/rest/1/scsched?finder=selectSOV;CreateDateGTEQ=2025-01-01
selectSOV	JobCodeSOV	string	Filter by Job Code	/pm-rest-api/rest/1/scsched?finder=selectSOV;JobCodeSOV=00529521
selectSOV	VenCodeVar	string	Filter by the subcontractor vendor code associated with the SOV line item	/pm-rest-api/rest/1/scsched?finder=selectSOV;VenCodeVar=100

scsched Attributes

CMiC UI Fieldname	Object	Name	Description	Type	Data Length	Example
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
Change Code	scsched	ScschChgCode	Indicates whether the line item is part of a subcontract change order. Must match SCMST_CHG_CODE	string	6	0
Company Code	scsched	ScschCompCode	Identifies the internal company responsible for managing the subcontrac. Must be a valid CMiC Company.	string	8	ZZ
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	PCCT006
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
Task Code	scsched	ScschTaskCode	A user defined alphanumeric identifier. Enter the task code associated with Schedule of Values line item.	string	16	TASK1
Vendor Code	scsched	ScschVenCode	Represents the subcontractor vendor associated with the SOV line item. Must match SCMST_VEN_CODE.	string	8	JEWELS
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
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	110
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
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
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
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
Completed Amount	scsched	ScschComplAmt	Indicates the total amount certified or completed to date for this SOV line item.	number	18	1000
Completed Percentage	scsched	ScschComplPct	Shows the percentage of work completed for this SOV line item.	number	7	0.1
Completed Quantity	scsched	ScschComplQty	Represents the quantity of work completed to date for this SOV line item.	number	16	100
Current Holdback Amount	scsched	ScschCurrHldbkAmt	The retention amount is currently withheld for this SOV line item.	number	18	100
Current Holdback Release	scsched	ScschCurrHldbkRlsAmt	Amount of holdback released in the current period for this SOV line item.	number	18	0
Fully Purchased Flag	scsched	ScschFullyPurchasedFlag	Indicates whether the SOV line item is fully purchased (Y) or not (N).	string	1	“Y” / “N”
Holdback Percentage	scsched	ScschHldbkPct	Specifies the retention percentage applied to this SOV line item.	number	6	10
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
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
Job Billing Code	scsched	ScschJbBillCode	Used for billing references related to the job, facilitating accurate billing processes.	string	50	JBILL01
Job Contract Code	scsched	ScschJbContCode	Links the SOV line item to a specific job contract record within CMiC, if applicable.	string	10	JCONT01
Line Changed Flag	scsched	ScschLineChangedFlag	Indicates whether the SOV line item has been modified after its initial creation (Y/N).	string	1	“Y” / “N”
Line Number	scsched	ScschLineNum	Provides a numeric sequence or reference number for the SOV line item within the subcontract.	integer	3	10
Long Description	scsched	ScschLongDesc	User-text field, if the SOV line requires further description, enter it here.	string	4000	Installation of lighting fixtures
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
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
Order Number	scsched	ScschOrderNum	Represents the display or sequence order of the SOV line item within the subcontract.	number		1
Previous Certified Amount	scsched	ScschPrevCertAmt	Reflects the amount previously certified for this SOV line item, aiding in financial tracking.	number	18	500
Previous Certified Quantity	scsched	ScschPrevCertQty	Shows the quantity previously certified for this SOV line item, assisting in progress tracking.	number	16	50
Previous Holdback Amount	scsched	ScschPrevHldbkAmt	Represents the retention amount previously withheld for this SOV line item.	number	18	50
Previous Holdback Release	scsched	ScschPrevHldbkRlsAmt	Indicates the amount of holdback released previously for this SOV line item.	number	18	0
SI Line Number	scsched	ScschSiLineNum	References the specific Subcontract Item (SI) detail line number associated with this SOV line.	integer	3	5
SI Number	scsched	ScschSiNum	Represents the Subcontract Item reference number linked to this SOV line item, facilitating detailed subcontract tracking.	integer	5	102
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
Subcontract Code	scsched	ScschSubcontrCode	Used for alternate or secondary referencing of the subcontract. Commonly set to "NONE" if not applicable.	string	20	NONE
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
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	1
Tax1 Taxable Flag	scsched	ScschTax1TaxableFlag	Indicates whether the first tax code is applicable to this SOV line item (Y/N).	string	1	“Y” / “N”
Tax2 Code	scsched	ScschTax2Code	Specifies the second applicable tax code for the SOV line item.	string	10	2
Tax2 Taxable Flag	scsched	ScschTax2TaxableFlag	Indicates whether the second tax code is applicable to this SOV line item (Y/N).	string	1	“Y” / “N”
Tax3 Code	scsched	ScschTax3Code	Specifies the third applicable tax code for the SOV line item.	string	10	3
Tax3 Taxable Flag	scsched	ScschTax3TaxableFlag	Indicates whether the third tax code is applicable to this SOV line item (Y/N).	string	1	“Y” / “N”
Tender Package Line Number	scsched	ScschTendpackLineNum	References the line number from an external tender package, if applicable.	integer	3	12
Units	scsched	ScschUnit	Represents the total quantity of units for this SOV line item.	number	16	300.45
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
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
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
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
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
Unique Sequence By SC	scsched	ScschSeqNumUniqueBySc	Ensures each SOV line item is uniquely identified within the subcontract to prevent duplication.	number		1
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
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

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExampleselectSOV; CreateDateGTEQ=2015-08-17T16:45:22-04:00, VenCodeVar=10TILE, JobCodeSOV=15-001, ContCodeVar=15-001.001, CompCodeVar=001

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

Exampletrue

orderBy

string

ExampleScschVUuid:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

{
  "items": [
    {
      "ScschAmt": 1500,
      "ScschApexpCode": null,
      "ScschBillCode": null,
      "ScschCatCode": "S",
      "ScschChgCode": "000",
      "ScschCompCode": "001",
      "ScschComplAmt": null,
      "ScschComplPct": null,
      "ScschComplQty": null,
      "ScschContCode": "15-001.001",
      "ScschCurrHldbkAmt": null,
      "ScschCurrHldbkRlsAmt": null,
      "ScschFullyPurchasedFlag": "N",
      "ScschHldbkPct": 0,
      "ScschIuCreateDate": "2015-08-17T20:45:22Z",
      "ScschIuUpdateDate": "2015-08-17T20:46:17Z",
      "ScschJbBillCode": null,
      "ScschJbContCode": null,
      "ScschJobCode": "15-001",
      "ScschLineChangedFlag": null,
      "ScschLineNum": null,
      "ScschLongDesc": null,
      "ScschLstAmt": null,
      "ScschOraseq": 62678,
      "ScschOrderNum": null,
      "ScschPhsCode": "99999",
      "ScschPrevCertAmt": null,
      "ScschPrevCertQty": null,
      "ScschPrevHldbkAmt": null,
      "ScschPrevHldbkRlsAmt": null,
      "ScschSiLineNum": null,
      "ScschSiMastJobCode": null,
      "ScschSiNum": null,
      "ScschSiRevisNum": null,
      "ScschSubcontrCode": "NONE",
      "ScschTaskCode": "1",
      "ScschTaskName": "Subcontract",
      "ScschTax1Code": null,
      "ScschTax1TaxableFlag": "Y",
      "ScschTax2Code": null,
      "ScschTax2TaxableFlag": "Y",
      "ScschTax3Code": null,
      "ScschTax3TaxableFlag": "Y",
      "ScschTax4Code": null,
      "ScschTax4TaxableFlag": null,
      "ScschTax5Code": null,
      "ScschTax5TaxableFlag": null,
      "ScschTendpackLineNum": null,
      "ScschUnit": null,
      "ScschUnitRate": 0,
      "ScschVenCode": "10TILE",
      "ScschWbsvCode1": null,
      "ScschWbsvCode2": null,
      "ScschWbsvCode3": null,
      "ScschWbsvCode4": null,
      "ScschWmCode": "$",
      "ScschVUuid": "BD8E170D5BBC2691E05316821FAC4947",
      "ScschSeqNumUniqueBySc": 1,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/pm-rest-api/rest/1/scsched/BD8E170D5BBC2691E05316821FAC4947",
          "name": "scsched",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/pm-rest-api/rest/1/scsched/BD8E170D5BBC2691E05316821FAC4947",
          "name": "scsched",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 50,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/pm-rest-api/rest/1/scsched",
      "name": "scsched",
      "kind": "collection"
    }
  ]
}

object

What's Next

Retrieve a Specific SC Detail By VUUID

Retrieve SC Details By Code

Overview

Notes

UI Navigation

Reference Article

Path Parameters

Query Standards

scsched Finders

scsched Attributes

What's Next

Contact Us