Service Directory > v31.2 > Resource_Management > Add_Supplier_Contract_Line_Hold
 

Operation: Add_Supplier_Contract_Line_Hold

Web Service to Add the On Hold boolean to Supplier Contract Lines without going through an amendment.


@ - 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: Add_Supplier_Contract_Line_Hold_Request

Element containing Supplier Contract Reference and Lines which are being placed on Hold.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Supplier_Contract_Reference  Supplier_ContractObject  [0..1]  Reference to an existing Supplier Contract   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..*]  Contains data for business processing   
Add_Supplier_Contract_Line_Hold_Data  Add_Supplier_Contract_Line_Hold_Data  [0..*]  Add Supplier Contract Line Hold Data 
Validation Description
The Supplier Contract provided may not be used because it is related to an inactive Supplier.   
The Supplier Contract provided does not have any lines eligible for putting on Hold.   
The Supplier Contract provided must be in Approved Status and must not be changeable to be used by this Web Service task. You may use the Submit Supplier Contract Web Service task to set the lines on hold for this contract.   
[validation text]   
A valid Supplier Contract reference or ID is required.   
The Supplier Contract provided may not be used because it is Closed, Terminated or Locked in Workday.   
Supplier Contract Lines Hold status can't be changed for Financial or Operating Lease Contract Types.   
 
Validation Description
Add Supplier Contract Line Hold Data is Required.   
top
 

Response Element: Add_Supplier_Contract_Line_Hold_Response

Response Element to hold Supplier Contract Reference.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Supplier_Contract_Amendment_Reference  Supplier_Contract_AmendmentObject  [0..1]  The Reference of the new Supplier Contract Amendment created for putting Supplier Contract Lines On Hold.   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element containing Exceptions Data   
top
 

Supplier_ContractObject

part of: Add_Supplier_Contract_Line_Hold_Request
 
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: Add_Supplier_Contract_Line_Hold_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
 
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
 

Add_Supplier_Contract_Line_Hold_Data

part of: Add_Supplier_Contract_Line_Hold_Request
Add Supplier Contract Line Hold Data
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Contract_ID  string  [0..1]  Supplier Contract Reference   
Supplier_Contract_Line_Add_Hold_Data  Goods_Line_Add_Hold_Data  [0..*]  Goods Line Add Hold Data 
Validation Description
If there are any transactions or schedules against the contract line, that line cannot be placed On Hold   
A Line Number, representing the Supplier Contract Line to be put On Hold, is required.   
A valid Line Number for the provided Supplier Contract is required.   
The Line Number provided is already on Hold.   
You cannot enter duplication Line Numbers.   
 
Validation Description
The Supplier Contract provided may not be used because it is related to an inactive Supplier.   
The Supplier Contract provided does not have any lines eligible for putting on Hold.   
The Supplier Contract provided must be in Approved Status and must not be changeable to be used by this Web Service task. You may use the Submit Supplier Contract Web Service task to set the lines on hold for this contract.   
[validation text]   
A valid Supplier Contract reference or ID is required.   
The Supplier Contract provided may not be used because it is Closed, Terminated or Locked in Workday.   
Supplier Contract Lines Hold status can't be changed for Financial or Operating Lease Contract Types.   
top
 

Goods_Line_Add_Hold_Data

part of: Add_Supplier_Contract_Line_Hold_Data
Goods Line Add Hold Data
 
Parameter name Type/Value Cardinality Description Validations
Line_Number  string (20)   [0..1]  This is the Supplier Contract Line Number for the Supplier Contract Line you wish to put on Hold.   
Validation Description
If there are any transactions or schedules against the contract line, that line cannot be placed On Hold   
A Line Number, representing the Supplier Contract Line to be put On Hold, is required.   
A valid Line Number for the provided Supplier Contract is required.   
The Line Number provided is already on Hold.   
You cannot enter duplication Line Numbers.   
top
 

Supplier_Contract_AmendmentObject

part of: Add_Supplier_Contract_Line_Hold_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_Contract_AmendmentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Supplier_Contract_AmendmentObjectID

part of: Supplier_Contract_AmendmentObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Supplier_Contract_Amendment_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
 

Application_Instance_Related_Exceptions_Data

part of: Add_Supplier_Contract_Line_Hold_Response
Element containing Exceptions Data
 
Parameter name Type/Value Cardinality Description Validations
Exceptions_Data  Application_Instance_Exceptions_Data  [0..*]  Exceptions Data   
top
 

Application_Instance_Exceptions_Data

part of: Application_Instance_Related_Exceptions_Data
Element containing application related exceptions data
 
Parameter name Type/Value Cardinality Description Validations
Exception_Data  Exception_Data  [0..*]  Exception Data   
top
 

Exception_Data

part of: Application_Instance_Exceptions_Data
Exception (Errors and Warning) associated with the transaction.
 
Parameter name Type/Value Cardinality Description Validations
Classification  string  [0..1]  Exception Classification (Error or Warning)   
Message  string  [0..1]  Exception Detail   
top
 

Supplier_ContractReferenceEnumeration

part of: Supplier_ContractObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Supplier_Contract_AmendmentReferenceEnumeration

part of: Supplier_Contract_AmendmentObjectID
Base Type
string
top