Service Directory > v32.1 > Revenue_Management > Get_Revenue_Recognition_Schedule_Templates
 

Operation: Get_Revenue_Recognition_Schedule_Templates

This service operation will add or update Revenue Recognition Schedule Templates


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

This element is the request element for the Revenue Recognition Schedule "Get" operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Revenue_Recognition_Schedule_Template_Request_References  [0..1]  Element containing Revenue Recognition Schedule Template reference for update   
Request_Criteria [Choice]   Revenue_Recognition_Schedule_Template_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the Revenue Recognition Schedule Template Request specific criteria needed to search for instances. All of the elements are "AND" conditions.   
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. 
 
top
 

Response Element: Get_Revenue_Recognition_Schedule_Templates_Response

Element containing Revenue Recognition Schedule Template 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  Revenue_Recognition_Schedule_Template_Request_References  [0..1]  Element containing Revenue Recognition Schedule Template reference for update   
Request_Criteria  Revenue_Recognition_Schedule_Template_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the Revenue Recognition Schedule Template Request specific criteria needed to search for instances. All of the elements are "AND" conditions.   
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_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  Revenue_Recognition_Schedule_Template_Response_Data  [0..1]  Wrapper element containing Revenue Recognition Schedule Template Response Data for requested references or criteria and for requested response group   
top
 

Revenue_Recognition_Schedule_Template_Request_References

part of: Get_Revenue_Recognition_Schedule_Templates_Request, Get_Revenue_Recognition_Schedule_Templates_Response
Element containing Revenue Recognition Schedule Template reference for update
 
Parameter name Type/Value Cardinality Description Validations
Revenue_Recognition_Schedule_Template_Reference  Revenue_Recognition_Schedule_TemplateObject  [1..*]  Reference element that must contain a unique Revenue Recognition Schedule Template instance.   
top
 

Revenue_Recognition_Schedule_TemplateObject

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

Revenue_Recognition_Schedule_TemplateObjectID

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

Revenue_Recognition_Schedule_Template_Request_Criteria

part of: Get_Revenue_Recognition_Schedule_Templates_Request, Get_Revenue_Recognition_Schedule_Templates_Response
This element is the wrapper around a list of elements representing the Revenue Recognition Schedule Template Request specific criteria needed to search for instances. All of the elements are "AND" conditions.
 
Parameter name Type/Value Cardinality Description Validations
Revenue_Recognition_Schedule_Template_Name  string  [0..1]  Name of the Revenue Recognition Schedule Template to be used as search criteria   
Schedule_Type_Reference  Schedule_TypeObject  [0..1]  Schedule Type for the Revenue Recognition Schedule Template to be used as search criteria   
top
 

Schedule_TypeObject

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

Schedule_TypeObjectID

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

Response_Results

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

Revenue_Recognition_Schedule_Template_Response_Data

part of: Get_Revenue_Recognition_Schedule_Templates_Response
Wrapper element containing Revenue Recognition Schedule Template Response Data for requested references or criteria and for requested response group
 
Parameter name Type/Value Cardinality Description Validations
Revenue_Recognition_Schedule_Template  Revenue_Recognition_Schedule_Template  [0..*]  Wrapper Element that includes Revenue Recognition Schedule Template Instance and Data   
top
 

Revenue_Recognition_Schedule_Template

part of: Revenue_Recognition_Schedule_Template_Response_Data
Wrapper Element that includes Revenue Recognition Schedule Template Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Revenue_Recognition_Schedule_Template_Reference  Revenue_Recognition_Schedule_TemplateObject  [0..1]  Reference to an existing Revenue Recognition Schedule Template   
Revenue_Recognition_Schedule_Template_Data  Revenue_Recognition_Schedule_Template_Data  [0..1]  Element containing Revenue Recognition Schedule Template data 
Validation Description
Only one of 'Number of Installments' or 'Use To Date on Contract' must be specified.   
Either 'Number of Installments' must be specified, or 'Use To Date on Contract' must be selected.   
If you select percent complete, you must enter a value in Percent Complete Method.   
If you select Percent Complete Method, the distribution method must be Percent Complete.   
In Order to enable Automatically Submit Schedule via Contract Amendment you must also enable Automatically Regenerate Installments.   
You can only use Automatically Regenerate Installments flag and Automatically Submit Schedule via Contract Amendment flag for Spread Even or Number of Days revenue recognition schedule types.   
If you select Independent Revenue Processing, the distribution method must be Transaction.   
 
top
 

Revenue_Recognition_Schedule_Template_Data

part of: Revenue_Recognition_Schedule_Template
Element containing Revenue Recognition Schedule Template data
 
Parameter name Type/Value Cardinality Description Validations
Revenue_Recognition_Schedule_Template_ID  string  [0..1]  ID for the template   
Revenue_Recognition_Schedule_Template_Name  string  [1..1]  Name of the template 
Validation Description
The revenue recognition schedule template you entered already exists. Enter a unique template name.   
 
Schedule_Description  string  [0..1]  Description for the Revenue Recognition Schedule Template   
Revenue_Recognition_Method_Reference  Schedule_Distribution_MethodObject  [1..1]  The Revenue Recognition Method to be used by the Revenue Recognition Schedule   
Frequency_Reference  Frequency_BehaviorObject  [0..1]  Should be defaulted to monthly 
Validation Description
The Frequency type has to be Monthly   
 
Percent_Complete_Method_Reference  Percent_Complete_MethodObject  [0..1]  Percent Complete Method   
Schedule_Type_Reference  Schedule_TypeObject  [1..1]  Schedule Type for the Template   
Sales_Item_Reference  Sales_ItemObject  [0..*]  Sales Items that will use the Revenue Recognition Schedule Template   
Number_of_Installments  decimal (12, 0) >0   [0..1]  The number of installments to be generated by the Revenue Recognition Schedule   
Use_To_Date_on_Contract  boolean  [0..1]  If true, the Revenue Recognition Schedule will generate installments until the specified date   
Automatically_Generate_Installments  boolean  [0..1]  If true, the Revenue Recognition Schedule will automatically generate installments after contract approval   
Automatically_Submit_Schedule_for_Approval  boolean  [0..1]  Can only be true, if auto generate is true, then the installments will be automatically submitted for approval 
Validation Description
Automatically Generate Installments must be True in order to mark Automatically Submit Schedule for Approval True   
 
Automatically_Regenerate_Installments  boolean  [0..1]  Automatically Regenerate Installments flag. Use this flag to automatically regenerate installments when Customer Contract Amendments are completed.   
Automatically_Submit_Schedule_via_Contract_Amendment  boolean  [0..1]  Automatically Submit Schedule via Contract Amendment flag. Use this flag to automatically submit the Revenue Recognition Schedule on Customer Contract Amendment completion after installments are automatically regenerated.   
Independent_Revenue_Processing  boolean  [0..1]  Independent Revenue Processing allows recognize revenue without depending on the Billing status of a billable transaction.   
Validation Description
Only one of 'Number of Installments' or 'Use To Date on Contract' must be specified.   
Either 'Number of Installments' must be specified, or 'Use To Date on Contract' must be selected.   
If you select percent complete, you must enter a value in Percent Complete Method.   
If you select Percent Complete Method, the distribution method must be Percent Complete.   
In Order to enable Automatically Submit Schedule via Contract Amendment you must also enable Automatically Regenerate Installments.   
You can only use Automatically Regenerate Installments flag and Automatically Submit Schedule via Contract Amendment flag for Spread Even or Number of Days revenue recognition schedule types.   
If you select Independent Revenue Processing, the distribution method must be Transaction.   
top
 

Schedule_Distribution_MethodObject

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

Schedule_Distribution_MethodObjectID

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

Frequency_BehaviorObject

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

Frequency_BehaviorObjectID

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

Percent_Complete_MethodObject

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

Percent_Complete_MethodObjectID

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

Sales_ItemObject

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

Sales_ItemObjectID

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

Revenue_Recognition_Schedule_TemplateReferenceEnumeration

part of: Revenue_Recognition_Schedule_TemplateObjectID
Base Type
string
top
 

Schedule_TypeReferenceEnumeration

part of: Schedule_TypeObjectID
Base Type
string
top
 

Schedule_Distribution_MethodReferenceEnumeration

part of: Schedule_Distribution_MethodObjectID
Base Type
string
top
 

Frequency_BehaviorReferenceEnumeration

part of: Frequency_BehaviorObjectID
Base Type
string
top
 

Percent_Complete_MethodReferenceEnumeration

part of: Percent_Complete_MethodObjectID
Base Type
string
top
 

Sales_ItemReferenceEnumeration

part of: Sales_ItemObjectID
Base Type
string
top