Service Directory > v31.2 > Resource_Management > Submit_Supplier_Order_Contract
 

Operation: Submit_Supplier_Order_Contract DEPRECATED

This operation is being deprecated in favor of the Submit Supplier Contract web service in W16. This service operation will add Supplier Order Contracts and submit to the Supplier Order Contract business process. . Supplier Order Contract data includes Supplier Contract ID, Supplier Contract Name, Resource Provider, Supplier Contract Reference Number, Company, Buyer, Contract Start Date, Contract End Date, Currency, Total Contract Amount, Currency, Contract Overview, Locked in Workday Flag and Attachment data.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Submit_Supplier_Order_Contract_Request

Element encapsulating Submit Supplier Contract Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Supplier_Order_Contract_Reference  Supplier_ContractObject  [0..1]  Supplier Order Contract Reference   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..1]  Business Process Parameters   
Supplier_Order_Contract_Data  Supplier_Order_Contract_Data  [0..1]  Supplier Order Contract Data 
Validation Description
The End Date must be greater than the Start Date.  The End Date must be greater than the Start Date. 
Resource Provider must be a Supplier or an Independent Contingent Worker.  Resource Provider must be a Supplier or an Independent Contingent Worker. 
Resource Provider must be active or on hold.  Resource Provider must be active or on hold. 
Resource Provider reference is for a supplier that can be used as a basic worktag only.  Resource Provider reference is for a supplier that can be used as a basic worktag only. 
 
Validation Description
The Web Service is set to Add Only; documents cannot be resubmitted. This may happen if you have a Contract ID field that conflicts with an existing Contract, or if you have both the Add Only flag on and pass in a Supplier Order Contract Reference.  The Web Service is set to Add Only; documents cannot be resubmitted. This may happen if you have a Contract ID field that conflicts with an existing Contract, or if you have both the Add Only flag on and pass in a Supplier Order Contract Reference. 
Supplier Order Contract is not in draft status and cannot be submitted.  Supplier Order Contract is not in draft status and cannot be submitted. 
Supplier Contract must have a Supplier Contract Type that allows Manual POs, Manual Invoices and Supplier Catalogs to use this web service task. If you need to update a Supplier Contract with a different Supplier Contract Type, please use the new Submit Supplier Contract web service task.   
top
 

Response Element: Submit_Supplier_Order_Contract_Response

Element containing Submit Supplier Order Contract Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Supplier_Order_Contract_Reference  Supplier_ContractObject  [0..1]  Supplier Order Contract Reference   
top
 

Supplier_ContractObject

part of: Submit_Supplier_Order_Contract_Request, Submit_Supplier_Order_Contract_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Supplier_ContractObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Supplier_ContractObjectID

part of: Supplier_ContractObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Supplier_Contract_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Financials_Business_Process_Parameters

part of: Submit_Supplier_Order_Contract_Request
Contains data for business processing
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures the Comment for the Business Process.   
top
 

Business_Process_Comment_Data

part of: Financials_Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

part of: Business_Process_Comment_Data, Supplier_Order_Contract_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  WorkerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

WorkerObjectID

part of: WorkerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Employee_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Supplier_Order_Contract_Data

part of: Submit_Supplier_Order_Contract_Request
Supplier Order Contract details
 
Parameter name Type/Value Cardinality Description Validations
Contract_ID  string  [0..1]  Contract ID. This is the unique identifier for supplier order contract.   
Contract_Name  string  [1..1]  Supplier Order Contract Name   
Resource_Provider_Reference  Resource_ProviderObject  [1..1]  Resource Provider Reference   
Supplier_Contract_Reference_Number  string  [0..1]  Supplier Contract Reference Number   
Company_Reference [Choice]   CompanyObject  [1..1]  Company Reference   
Company_Hierarchy_Reference [Choice]   OrganizationObject  [1..1]  Company Hierarchy Reference. Can only specify either a Company Reference or a Company Hierarchy Reference, not both   
Buyer_Reference  WorkerObject  [1..1]  Reference to the named Buyer for the Supplier Order Contract   
Contract_Start_Date  date  [1..1]  Contract Start Date   
Contract_End_Date  date  [1..1]  Contract End Date   
Total_Contract_Amount  decimal (26, 6) >0   [0..1]  Total Contract Amount   
Currency_Reference  CurrencyObject  [1..1]  Currency Reference 
Validation Description
Currency Conversion Rates between currency and company's default currency are not defined.   
Currency entered is not listed as an Accepted Currency by Supplier.   
 
Contract_Overview  RichText  [0..1]  Contract Overview   
Locked_in_Workday  boolean  [0..1]  Set to True to disable editing of supplier order contract inside the Workday application. Supplier order contract can only be updated from the web service.   
Attachment_Replacement_Data  Financials_Attachment_Data  [0..*]  Encapsulating element containing all Business Document Attachment data. 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Validation Description
The End Date must be greater than the Start Date.  The End Date must be greater than the Start Date. 
Resource Provider must be a Supplier or an Independent Contingent Worker.  Resource Provider must be a Supplier or an Independent Contingent Worker. 
Resource Provider must be active or on hold.  Resource Provider must be active or on hold. 
Resource Provider reference is for a supplier that can be used as a basic worktag only.  Resource Provider reference is for a supplier that can be used as a basic worktag only. 
top
 

Resource_ProviderObject

part of: Supplier_Order_Contract_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Resource_ProviderObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Resource_ProviderObjectID

part of: Resource_ProviderObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Supplier_ID, Supplier_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

CompanyObject

part of: Supplier_Order_Contract_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  CompanyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CompanyObjectID

part of: CompanyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

OrganizationObject

part of: Supplier_Order_Contract_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  OrganizationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

OrganizationObjectID

part of: OrganizationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Organization_Reference_ID, Region_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

CurrencyObject

part of: Supplier_Order_Contract_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  CurrencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CurrencyObjectID

part of: CurrencyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Currency_ID, Currency_Numeric_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Financials_Attachment_Data

part of: Supplier_Order_Contract_Data
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

Supplier_ContractReferenceEnumeration

part of: Supplier_ContractObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Resource_ProviderReferenceEnumeration

part of: Resource_ProviderObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

RichText

part of: Supplier_Order_Contract_Data
Base Type
string
top