Service Directory > v31.2 > Revenue_Management > Put_Customer_Contract_Renewal_Terms
 

Operation: Put_Customer_Contract_Renewal_Terms

This service operation will add or update contract line renewals for contract lines. Renewal data includes Contract Line Reference, Renewal Rate Amount, Renewal Percent, Unit Cost, Quantity, Quantity2, Renewal Start Date, Renewal End Date, Co-Terminate, Auto Renewal, Opt-Out Period and Renewal Comment. The request criteria can be for a one or more renewals based contract line reference.


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

Element containing Customer Contract Line references for update and all Contract Line Renewal data items.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Contract_Line_Renewal_Data  Contract_Line_Renewal_Data  [1..1]  Element includes Contract Line Renewal Reference and Data. 
Validation Description
Enter a To Date that is after the From Date.   
You can't add or update renewal terms for this contract line because the sales item isn't renewable.   
You can't add or update renewal terms for this contract line because it is canceled or terminated.   
 
top
 

Response Element: Put_Customer_Contract_Renewal_Terms_Response

Element containing Put Contract Line Renewal Response Data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Customer_Contract_Line_Reference  Customer_Contract_LineObject  [0..1]  Reference to an existing Customer Contract Line.   
Contract_Line_Renewal_Reference  Unique_IdentifierObject  [0..1]  Reference to an existing Contract Line Renewal.   
top
 

Contract_Line_Renewal_Data

part of: Put_Customer_Contract_Renewal_Terms_Request
Element includes Contract Line Renewal Reference and Data.
 
Parameter name Type/Value Cardinality Description Validations
Customer_Contract_Line_Reference  Customer_Contract_LineObject  [0..1]  Reference to an existing Customer Contract Line for update only purposes.   
Renewal_Quantity  decimal (22, 2)   [0..1]  Contract Line Renewal Quantity   
Renewal_Quantity_2  decimal (22, 2)   [0..1]  Contract Line Renewal Quantity2   
Renewal_Rate  decimal (26, 6)   [0..1]  Contract Line Renewal Unit Cost   
Renewal_Amount  decimal (26, 6)   [0..1]  Contract Line Renewal Rate Amount   
Renewal_Percent  decimal (11, 4)   [0..1]  Contract Line Renewal Percent   
From_Date  date  [0..1]  Contract Line Renewal Start Date   
To_Date  date  [0..1]  Contract Line Renewal End Date   
CoTerm  boolean  [0..1]  Contract Line Renewal Co-Terminate Flag   
Auto_Renew  boolean  [0..1]  Auto Renewal Flag for Contract Line Renewal Terms   
Customer_Bill_To_Contact_Reference  Business_Entity_ContactObject  [0..1]  Bill To Contact for Renewal Terms   
OptOut_Period  string  [0..1]  Contract Line Renewal Opt-Out Period   
Notes  RichText  [0..1]  Contract Line Renewal Comment   
Validation Description
Enter a To Date that is after the From Date.   
You can't add or update renewal terms for this contract line because the sales item isn't renewable.   
You can't add or update renewal terms for this contract line because it is canceled or terminated.   
top
 

Customer_Contract_LineObject

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

Customer_Contract_LineObjectID

part of: Customer_Contract_LineObject
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  [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
 

Business_Entity_ContactObject

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

Business_Entity_ContactObjectID

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

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

part of: Customer_Contract_LineObjectID
Base Type
string
top
 

Business_Entity_ContactReferenceEnumeration

part of: Business_Entity_ContactObjectID
Base Type
string
top
 

RichText

part of: Contract_Line_Renewal_Data
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top