Service Directory > v31.2 > Revenue_Management > Submit_Customer_Contract_Change_Order
 

Operation: Submit_Customer_Contract_Change_Order

This service operation will add Customer Contract Change Order. Customer Contract Change Order data includes Customer Contract, Amendment Type, Amendment Effective Date, Customer Contract Lines, Quantity, Quantity2, Change Order Amount, Notes and attachment.


@ - 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_Customer_Contract_Change_Order_Request

Element for Customer Contract Change Order request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Customer_Contract_Reference  Customer_ContractObject  [1..1]  Customer Contract reference for which the Change Order is requested.   
Customer_Contract_Change_Order_Data  Customer_Contract_Change_Order_Data  [1..1]  Element containing Customer Contract Change Order details.   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..1]  Contains data for business processing   
Validation Description
You can't create change orders for contracts that are still in progress.  You can't create change orders for contracts that are still in progress. 
top
 

Response Element: Submit_Customer_Contract_Change_Order_Response

Element for Customer Change Order response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Customer_Contract_Reference  Customer_Contract_AbstractObject  [0..1]  Customer Contract reference for which Change Order is submitted.   
top
 

Customer_ContractObject

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

Customer_ContractObjectID

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

Customer_Contract_Change_Order_Data

part of: Submit_Customer_Contract_Change_Order_Request
Element containing Customer Contract Change Order details.
 
Parameter name Type/Value Cardinality Description Validations
Active_Amendment_Type_Reference  Contract_Amendment_TypeObject  [1..1]  Active Amendment Type reference for the Customer Contract.   
Amendment_Effective_Date  date  [1..1]  Amendment Effective Date for the Customer Contract.   
Amendment_Number  string  [0..1]  Customer Contract Amendment Number for the Customer Contract.   
Amendment_Signed_Date  date  [0..1]  Amendment Signed Date for the Customer Contract.   
Amendment_Description  string  [0..1]  Amendment Description for the Customer Contract.   
Customer_Contract_Line_Change_Order_Data  Customer_Contract_Line_Change_Order_Data  [0..*]  Element containing details for Customer Contract Line for the Change Order request. 
Validation Description
Quantity 2 can only be entered if the Contract Line Type is Fixed Amount or Subscription.  Quantity 2 can only be entered if the Contract Line Type is Fixed Amount or Subscription. 
Quantity cannot be entered for contract line types of: Prepaid, Recurring, Revenue Only, or Project based.  Quantity cannot be entered for contract line types of: Prepaid, Recurring, Revenue Only, or Project based. 
You have duplicate contract line: [contract line]   
You can't enter a value in the Quantity 2 field on a contract line where the sales item requires fulfillment.  You can't enter a value in the Quantity 2 field on a contract line where the sales item requires fulfillment. 
Change Order Amount cannot be entered for Prepaid or Revenue Only contract lines.  Change Order Amount cannot be entered for Prepaid or Revenue Only contract lines. 
 
Attachment_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.   
 
Total_Customer_Contract_Amount  decimal (26, 6)   [0..1]  Total Contract Amount   
top
 

Contract_Amendment_TypeObject

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

Contract_Amendment_TypeObjectID

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

Customer_Contract_Line_Change_Order_Data

part of: Customer_Contract_Change_Order_Data
Element containing details for Customer Contract Line for the Change Order request.
 
Parameter name Type/Value Cardinality Description Validations
Receivable_Contract_Line_Reference  Receivable_Contract_Line_AbstractObject  [1..1]  Customer Contract Line reference for the Change Order request. 
Validation Description
Contract Line: [contract line] doesn't belong to Contract: [contract]   
 
Change_Order_Effective_Date  date  [0..1]  Change Order Effective Date for the Customer Contract line.   
Change_Order_Type_Reference  Contract_Amendment_TypeObject  [0..*]  Change Order Type reference for the Customer Contract line.   
Quantity  decimal (22, 2)   [0..1]  Quantity for the Customer Contract line.   
Quantity_2  decimal (22, 2)   [0..1]  Quantity 2 for the Customer Contract line.   
Change_Order_Amount  decimal (18, 3)   [0..1]  Change Order Amount for the Customer Contract line.   
Notes  string  [0..1]  Notes for the Customer Contract line.   
Validation Description
Quantity 2 can only be entered if the Contract Line Type is Fixed Amount or Subscription.  Quantity 2 can only be entered if the Contract Line Type is Fixed Amount or Subscription. 
Quantity cannot be entered for contract line types of: Prepaid, Recurring, Revenue Only, or Project based.  Quantity cannot be entered for contract line types of: Prepaid, Recurring, Revenue Only, or Project based. 
You have duplicate contract line: [contract line]   
You can't enter a value in the Quantity 2 field on a contract line where the sales item requires fulfillment.  You can't enter a value in the Quantity 2 field on a contract line where the sales item requires fulfillment. 
Change Order Amount cannot be entered for Prepaid or Revenue Only contract lines.  Change Order Amount cannot be entered for Prepaid or Revenue Only contract lines. 
top
 

Receivable_Contract_Line_AbstractObject

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

Receivable_Contract_Line_AbstractObjectID

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

part of: Customer_Contract_Change_Order_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
 

Financials_Business_Process_Parameters

part of: Submit_Customer_Contract_Change_Order_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
 

Customer_Contract_AbstractObject

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

Customer_Contract_AbstractObjectID

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

Customer_ContractReferenceEnumeration

part of: Customer_ContractObjectID
Base Type
string
top
 

Contract_Amendment_TypeReferenceEnumeration

part of: Contract_Amendment_TypeObjectID
Base Type
string
top
 

Receivable_Contract_Line_AbstractReferenceEnumeration

part of: Receivable_Contract_Line_AbstractObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Customer_Contract_AbstractReferenceEnumeration

part of: Customer_Contract_AbstractObjectID
Base Type
string
top