Service Directory > v31.2 > Revenue_Management > Get_Customer_Contract_Renewal_Terms
 

Operation: Get_Customer_Contract_Renewal_Terms

This service operation will get all contract line renewals for a request criteria.


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

This element is the top-level request element for all Customer Contract Renewals "Get" operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Contract_Line_Renewal_Request_References  [0..1]  This element content contains the Contract Line Renewal reference element used to return the Customer Contract Renewals by unique identifier.   
Request_Criteria [Choice]   Contract_Line_Renewal_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the Contract Line Renewal Request.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Contract_Line_Renewal_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Contract Line Renewal response. If this element is not included then ALL of the Response Groups are included in the response.   
top
 

Response Element: Get_Customer_Contract_Renewal_Terms_Response

Element containing Contract Line Renewal response elements including echoed request data and request result data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Contract_Line_Renewal_Request_References  [0..1]  This element content contains the Contract Line Renewal reference element used to return the Customer Contract Renewals by unique identifier.   
Request_Criteria  Contract_Line_Renewal_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the Contract Line Renewal Request.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Contract_Line_Renewal_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Contract Line Renewal response. If this element is not included then ALL of the Response Groups are included in the response.   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Contract_Line_Renewal_Response_Data  [0..1]  Wrapper element containing Contract Line Renewal Response Data for requested references or criteria and for requested response group.   
top
 

Contract_Line_Renewal_Request_References

part of: Get_Customer_Contract_Renewal_Terms_Request, Get_Customer_Contract_Renewal_Terms_Response
This element content contains the Contract Line Renewal reference element used to return the Customer Contract Renewals by unique identifier.
 
Parameter name Type/Value Cardinality Description Validations
Contract_Line_Renewal_Reference  Unique_IdentifierObject  [1..*]  Instance Set containing the Contract Line Renewal object.   
top
 

Unique_IdentifierObject

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

Contract_Line_Renewal_Request_Criteria

part of: Get_Customer_Contract_Renewal_Terms_Request, Get_Customer_Contract_Renewal_Terms_Response
This element is the wrapper around a list of elements representing the Contract Line Renewal Request.
 
Parameter name Type/Value Cardinality Description Validations
Customer_Reference  CustomerObject  [0..1]  Customer Criteria to Get Customer Contract Renewals.   
top
 

CustomerObject

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

CustomerObjectID

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

Response_Filter

part of: Get_Customer_Contract_Renewal_Terms_Request, Get_Customer_Contract_Renewal_Terms_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Contract_Line_Renewal_Response_Group

part of: Get_Customer_Contract_Renewal_Terms_Request, Get_Customer_Contract_Renewal_Terms_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Contract Line Renewal response. If this element is not included then ALL of the Response Groups are included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Contract Line Renewal Reference data is to be included in the response.   
top
 

Response_Results

part of: Get_Customer_Contract_Renewal_Terms_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Contract_Line_Renewal_Response_Data

part of: Get_Customer_Contract_Renewal_Terms_Response
Wrapper element containing Contract Line Renewal Response Data for requested references or criteria and for requested response group.
 
Parameter name Type/Value Cardinality Description Validations
Contract_Line_Renewal  Contract_Line_Renewal  [0..*]  Wrapper Element that includes Contract Line Renewal Instance and Data.   
top
 

Contract_Line_Renewal

part of: Contract_Line_Renewal_Response_Data
Wrapper Element that includes Contract Line Renewal Instance and Data.
 
Parameter name Type/Value Cardinality Description Validations
Contract_Line_Renewal_Data  Contract_Line_Renewal_Data  [0..*]  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
 

Contract_Line_Renewal_Data

part of: Contract_Line_Renewal
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
 
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_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
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