Create an SC Header

Updated on 27 Feb 2025
14 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Post

/pm-rest-api/rest/1/scmast

Overview

This endpoint allows you to create Subcontract details and directly enter Subcontract Change Orders. Use it to name the Subcontract, assign a vendor, and link it to an existing Project or Job in CMiC.

Field > Budget & Cost Management > Subcontract

Reference Article

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

Commonly Used Body Parameters

CMiC UI Fieldname	Name	Description	Type	Data Length	Example	Required
Change Code	ScmstChgCode	A change order number is a unique identifier for tracking changes in a subcontract. If the contract being entered is the original contract, otherwise called as a base contract then this number is set by the system as ‘000’ Any further change order is assigned with system generated incremental numbers as ‘001’,’002’…) and so on.	string	6	“000”	Yes
Company Code	ScmstCompCode	The CMiC company code to which the subcontract belongs. This is the same company as the Job the Contract was awarded on. This must be a VALID CMiC company code.	string	8	ZZ	Yes
Currency Code	ScmstCurrCode	This field is the currency code of the subcontract. This must be a VALID CMiC Currency Code.	string	3	USD	Yes
Job/Project Code	ScmstJobCode	Associates the Subcontract with the corresponding Job or Project in CmiC.	string	10	03202023	Yes
Override Flag	ScmstOverrideFlag	Override contract Number. Set this field to Y if you intend to hard code a Subcontract Number with your request, otherwise set it to N and our system will follow the auto-number masking rule set up on the Subcontract Control file.	string	80	“Y” / “N”	Yes
Subcontract Code	ScmstSubcontrCode	System populated value, set to ‘NONE’. This is the subcontract code that identifies this Subcontract. which must be unique by company/vendor. In other words, two jobs cannot utilize the same contract code for the same vendor. Once the record has been saved, the Contract field can no longer be edited.	string	20	NONE	Yes
Vendor Code	ScmstVenCode	This is the code used for the vendor the contract was awarded to. This must be a valid CMiC Vendor Code for the Company entered in SCMST_COMP_CODE. Click here to learn more about updating and creating vendors .	string	8	A1SPEEDY	Yes
Contract no.	ScmstContCode	Enter the ID code for this subcontract. Once the record has been saved this field can no longer be edited. The code may be automatically generated, if Autonumbering is turned ON in SC Control. The code may also overridden manually, if the control flag for overriding the autogenerated code number is set.	string	20	CCC-123456	No
Description	ScmstName	A descriptive name or title for this Subcontract.	string	200	“Install all interior lights”	No
Bank Department	ScmstBankDept	Specifies the bank Department information for the account being used for the subcontract.	string	6	00	No
Bank Account	ScmstBankAccount	Specifies the bank account number for the subcontract.	string	16	10001	No
Vendor UUID	ScmstVUuid	Unique Row ID. When creating a new subcontract, this field should be included in the body of the request but left empty. Including this parameter allows you to preview the posting after submission.	string	64		No

Other (Optional) Body Parameters

CMiC UI Fieldname	Name	Description	Type	Data Length	Example
Partner Type Code	PartnTypeCode	Displays the Partner type code. When creating a new subcontract header. This value by default is set to ‘P’	string	2	P
Post Override Flag	PostOverrideFlag	Post Override flag, when a new record is created this value is set to 1 by default.	string	4000	1
Abbreviated Partner Code	ScmstAbbrevPartnCode	A shortened unique identifier used to designate a business partner within the system. Click here to learn more about Business Partners..	string	4000	00PT
Account Description	ScmstAcctDescription	A descriptive label for the account used by this Subcontract (if any).	string	500	Subcontract expense acct
Action Code	ScmstActionCode	This is the Action Code Created by the system. Action items are used to schedule and coordinate phone calls, delivery dates, meetings and other action types relevant to the Opportunity Management module. The Action Code is used to identify the action item type. Click here to learn more about Action Item Codes.	string	1
Alternate Vendor Address Code	ScmstAltVenAddCode	Stores an alternate vendor address code for the vendor.	string	5	ADD1
App Code	ScmstAppCode	App Code, when a new record is created, this value is set to null by default.	string	20
Contractor Default Insurance (CDI) Flag	ScmstCdiFlag	When the 'CDI' flag is checked on the subcontract header, CDI will be calculated based on the rate that has been set for the CDI Risk Management codes that are on the job. ‘Y’ indicates CDI Flag checked. ‘N’ indicates CDI Flag is not checked	string	1	“Y” / “N”
Cheque Handling Code	ScmstChqHandleCode	Cheque Handling Codes codes can be applied to vouchers so that when their checks are printed, the company names and addresses are derived from the check handling codes instead of the company record. To learn more about check handling codes click here.	string	8	“CENTRAL”
Close Date	ScmstCloseDate	Date on which the Subcontract is considered closed/completed.	datetime		2024-02-22T00:00:00-05:00
Classifier column 1	ScmstClvValueCode1	PCI Classifier 1 Value. For more details on how to create classifiers on PM objects, please refer to this article: Classifiers	string	16	“14AC”
Classifier column 2	ScmstClvValueCode2	PCI Classifier 2 Value	string	16
Classifier column 3	ScmstClvValueCode3	PCI Classifier 3 Value	string	16
Classifier column 4	ScmstClvValueCode4	PCI Classifier 4 Value	string	16
Classifier column 5	ScmstClvValueCode5	PCI Classifier 5 Value	string	16
Classifier column 6	ScmstClvValueCode6	PCI Classifier 6 Value	string	16
Change Order Code	ScmstCmChgCode	The PCI Code that is linked to the SC	string	11
(PCI) Company Code	ScmstCmCompCode	The Company Code of the PCI that is linked to the SC	string	8
Job Code	ScmstCmJobCode	The Job Code of the PCI that is linked to the SC	string	10
(PM Bid Package) Comment	ScmstCommentLong	Used to Store the PMBidpackage Comment When Processing the SC.	attachment
Completed Flag	ScmstComplFlag	Indicates whether the Subcontract is marked complete (‘Y’ or ‘N’).	string	1	“Y” / “N”
Contract Amount	ScmstContAmt	The monetary value of the Subcontract or Change Order	number		12575.99
Contract Type Code	ScmstContType	When creating a subcontract, a contract type can be selected in the Contract Type field to assign the type of contract being sent to the vendor. Click here for more information on Contract Type Maintenance.	string	30	“Lump Sum”
Contact Code	ScmstContactCode	Code referencing the main contact or individual for this Subcontract.	string	10	GA
Contact Name	ScmstContactName	Name of the contact person associated with this Subcontract.	string	4000	George Allen
Correspondence Address Code	ScmstCorrespAddCode	Address code used for official correspondence under this Subcontract.	string	5
Contract On-the-Fly Flag	ScmstCreateContOnFlyFlag	Used to create one-time contacts directly on a specific project. It is used to help control the population of system contacts, as these contacts will not appear in the system contact list and cannot be added to other projects. ‘Y’ or ‘N’.	string	4000	“Y” / “N”
Factor Number	ScmstCurcFactorNum	This is populated by the system by selecting a value from exchange rate table by comparing the subcontract currency with the Company currency	number	16	1.00000
Currency Name	ScmstCurrName	Descriptive name of the currency used (e.g. “US Dollar”).	string	30	US Dollar
Subcontract Date	ScmstDate	Date when the Subcontract record was created or became effective.	datetime		2023-10-19
Default Taxes Flag	ScmstDefaultTaxesFlag	Taxes applicable to the Subcontract will default from the job, if they exist; otherwise, they default from the vendor. In either case, the taxes can be updated at any time until the Subcontract is posted.	string	1	“Y” / “N”
Change Order Default Amount	ScmstDfltAmt	When creating single line Subcontract Change Orders a default Amount can be entered.	number	18	“10,000.00”
Change Order Default Category Code	ScmstDfltCatCode	When creating single line Subcontract Change Orders a default Category can be entered.	string	16	“S”
Change Order Default Phase Code	ScmstDfltPhsCode	When creating single line Subcontract Change Orders a default Cost Code can be entered.	string	16	“01-1300”
Do Not Exceed Amount	ScmstDoNotExceedAmt	Amount that the subcontractor is allowed to submit Payment Requests against Instructed SC or Change Order	number	18	125,000.00
End Date	ScmstEndDate	Scheduled end or completion date for this Subcontract.	datetime		2023-10-19
Executed Date	ScmstExecutedDate	Date when general contractor and subcontractor both signed the Subcontract	datetime		2023-10-22
GCS Pay Request Flag	ScmstGcsPayRequestFlag	This checkbox links the Subcontract change Orders to the GCS Pay Request module.	string	1	“Y” / “N”
GST Amount	ScmstGstAmt	GST (Goods and Services Tax) amount applied to this Subcontract, if applicable.	number	18	6000
GST Percentage	ScmstGstPc	GST (Goods and Services Tax) rate used, if applicable	number	15	5
Holdback Percentage	ScmstHldbkPc	Retention or holdback percentage applied to Subcontract billings. Enter ‘0’ if no Holdback applies	number	16	5.75
Holdback Percentage Rule	ScmstHldbkPcRule	Rule or code determining how holdback is calculated or released.	string	10
Holdback Release From Schedule	ScmstHldbkRlsFromSc	Flag to indicate whether holdback (retainage) amount release will occur on the schedule level or voucher level.	string	1	“Y” / “N”
Hold Payment for ____ Days	ScmstHoldPaymentDays	The Hold payment for another x day(s) field is used to set how many days to hold payment to a subcontractor after the owner has paid.	integer	4	2
Hold Payment Flag	ScmstHoldPaymentFlag	If “Y,” payment to the vendor is currently on hold.	string	1	“Y” / “N”
Impact Days	ScmstImpactDays	Number of Impact Days for this SC.	integer	4	25
Invoice Entry State	ScmstInvEntryState	When a Subcontract is created, users can choose whether invoices via SC or AP	string	2	‘SC” / “AP”
Invoice Holdback Tax Flag	ScmstInvHldbkTaxFlag	If “Y,” tax is applied to holdback amounts on this Subcontract’s invoices. ‘N’ otherwise.	string	1	“Y” / “N”
Issued Date	ScmstIssuedDate	The date the subcontract is issued to the vendor.	datetime		2023-10-19T13:18:32-04:00
Create Date	ScmstIuCreateDate	The date on which the subcontract was created. (System Date)	datetime		2023-10-19T13:18:32-04:00
Update Date	ScmstIuUpdateDate	Date/time stamp of the last update to this Subcontract. (System Date)	datetime		2023-10-19T13:20:58-04:00
Controlling Job Code	ScmstJobCtrlCode	The Controlling Job Code associated with the Project. This is a fixed string ‘ALL’	string	10	ALL
Description	ScmstName	A descriptive name or title for this Subcontract.	string	200	“Install all interior lights”
Tax Included in the Voucher Amount	ScmstNonCreditInclTaxAmt	Tax Included in the Voucher Amount	number	18	12345.67
Non Credit Tax Amount	ScmstNonCreditTaxAmt	Amount of taxes applied to the contract, not including Credit Taxes.	number	18	123456.78
Original Bid Amount	ScmstOrigBidpAmt	The original bid amount if this Subcontract originated in a bidding process.	number	18	25,750.00
Original Bid Oraseq	ScmstOrigBidpOraseq	Oraseq Number associated with the Original Bid amount if the Subcontract originated in the bidding process.	number
Override Do Not Exceed Amount – Checkbox	ScmstOvrrideNotExceedFlag	Indicates if the ‘do not exceed amount’ can be overridden at the time of payment request	string	1	“Y” / “N”
Post Batch Number	ScmstPostBatch	Batch Number used by the system when posting	number		63656
Posting Date	ScmstPostDate	The posting date of the subcontract. Automatically populated by the system	datetime		2023-10-19
Preferred Quote Flag	ScmstPreferedQuoteFlag	If “Y,” indicates this Subcontract or quote was chosen as the preferred quote among multiple. System normally populates as ‘Y’	string	1	“Y” / “N”
Printed Change Order Flag	ScmstPrintedCoFlag	Indicates whether the change order has been printed. ‘Y’ or ‘N’.	string	1	“Y” / “N”
Project Code Oraseq	ScmstProjOraseq	Oraseq Number associated with the Project Code	number		162739
Subcontractor Rating	ScmstRating	Numeric rating or evaluation metric for the subcontractor’s performance.	number	5	1
RCT Reference Number	ScmstRctReferenceNum	Used for UK systems	string	30
Received Date	ScmstReceivedDate	Date when Subcontract is received and signed by the subcontractor.	datetime		2019-12-05
Recipient Email	ScmstRecipientEmail	Email address of the recipient for this Subcontract.	string	100
Void Batch	ScmstRevBatch	Represents the batch number associated with the void for a subcontract. This field updates when a subcontract is voided.	number		129
Void Date	ScmstRevDate	Represents the date when the subcontract was voided or revised. This field updates automatically when a subcontract is voided.	datetime		2019-12-05
Subcontract Control Amount	ScmstScControlAmt	The Control Contract Amount field in the header section is used to validate that the Total SOV (Schedule of Values) Amount (field in the Subcontract Summary section) and this value, entered by the user, are equal upon posting of the Subcontract.	number	18	55353.18
Schedule Exists Flag	ScmstSchedExistsFlag	Indicates if this subcontract has Schedule of Values associated with it (Y) or not (N)	string	1	“Y” / “N”
	ScmstScheduleFlag	System Populated Value ‘N’	string	1	“Y” / “N”
Scope Description	ScmstScopeDesc	A longer text description of the Subcontract’s scope of work, deliverables, or additional notes.	string	4000
Schedule Last Seq Num Used	ScmstScschLastSeqNumUsed	The last sequence number used for SOV records, for uniqueness within a Subcontract for tasks. System Generated.	number		1
Self-Billed Flag	ScmstSelfBilledFlag	Indicates if the contract is to be Self Billed. Applicable to UK/Singapore etc. Vendor will be allowed to enter Payment Application, which can further be approved and posted	string	1	“Y” / “N”
Sender Email	ScmstSenderEmail	This field is the email address that will be used when sending email messages.	string	100
Separate Voucher Per Job Flag	ScmstSepVouPerJobFlag	If “Y,” the system will create separate vouchers for each job under this Subcontract.	string	1	“Y” / “N”
Source Code	ScmstSrcCode	Indicates the source system or module (e.g., JSP) from which this Subcontract was created.	string	10	JSP
Start Date	ScmstStartDate	The planned start date for work under this Subcontract.	datetime		2019-12-05
Status Code	ScmstStatCode	System status code to determine the current status of the subcontract. (Pending, In-Progress etc.)	string	1	I
Extended Status Code	ScmstStatusCode	Status code of the Subcontract or Change Order	string	16	POSTED
Tax 1 Code	ScmstTax1Code	Enter Tax Code 1	string	11	U1
Tax 2 Code	ScmstTax2Code	Enter Tax Code 2	string	11	U2
Tax 3 Code	ScmstTax3Code	Enter Tax Code 3	string	11	U4
Term Code	ScmstTermCode	Enter the Payment Terms setup in System Data > Global Tables. The code setup at vendor maintenance is defaulted.	string	6	NET30
Term Name	ScmstTermName	Descriptive name of the payment term. Enter a description of this payment term. This name will appear on most screens that require the entry of a payment term.	string	30	Net 30
Textura Integration Flag	ScmstTexturaFlag	Indicates if the Subcontract is integrated with Textura for construction payment management.	string	1	“Y” / “N”
User	ScmstUser	User who created the SC (System Populated)	string	30	SHAMROCK
User Privilege Flag	ScmstUserPrvlgFlag	Indicates whether the user has the privilege to post a subcontract	string	4000	“Y” / “N”
Vendor Name	ScmstVenName	Full name of the vendor or subcontractor.	string	4000	Pentagon Services
Deposit Amount	ScmstDepositAmt	Enter the deposit amount. See Down Payment and Amortization for more information.	number	18	172839.55
Deposit Approval Date	ScmstDepositApprovalDate	Date on which the deposit was approved.	datetime		2024-02-22T00:00:00-05:00
Down Payment Percentage	ScmstDepositPct	Down Payment Percentage – This is defaulted from the header, but users may override if required. Click here for more information about Down Payment and Amortization.	number	6	5
Workflow Status	ScmstWorkflowStatus	Tracks the Subcontract’s status in a workflow or approval process. Click here to learn more about Subcontract workflows	string	100	Not Submitted
Posting DateTime	ScmstDateTimePost	Timestamp for when the Subcontract or changes were posted, for audit and tracking.	datetime		2023-10-19T13:20:58-04:00
Changes Description	CChangeDesc	A description field to track changes to the subcontract.	string	15	Changes To Date

Security

HTTP

Type basic

Basic authentication

Header parameters

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourceitem+json

Body parameters

object

Example{ "ScmstCompCode": "001", "ScmstJobCode": "16-001", "ScmstVenCode": "0415", "ScmstContCode": "16-001.001", "ScmstChgCode": "000", "ScmstCurrCode": "USD", "ScmstSubcontrCode": "NONE", "ScmstName": "test", "ScmstBankDept": "00", "ScmstBankAccount": "10001", "ScmstVUuid": "" }

Responses

201

Created

Headers