Service Directory > v31.2 > Revenue_Management > Get_Revenue_Allocation_Configurations
 

Operation: Get_Revenue_Allocation_Configurations

This service operation will retrieve the Tenant's Revenue Allocation Configuration. Revenue Allocation Configuration Data includes Allocation in Summary, efault Revenue Allocation Configuration Line Data, and Override Revenue Allocation Configuration Line Data. Default Revenue Allocation Configuration Line Data includes Lower Range Percentage, Upper Range Percentage, Revenue Allocation Calculation Basis, and Fair Value Price List. Override Revenue Allocation Configuration Line Data contains Override Revenue Allocation Configuration Line ID, Override Revenue Allocation Configuration Line, Company, Fair Value Price List, Lower Range Percentage, Upper Range Percentage, Revenue Allocation Calculation Basis, and Override Revenue Allocation Configuration Line Details Data. Override Revenue Allocation Configuration Line Details Data contains Override Revenue Allocation Configuration Line Details ID, Override Revenue Allocation Configuration Line Details, Sales Item Group for FV Price List, Sales Item, Lower Range Percentage, Upper Range Percentage, and Revenue Allocation Calculation Basis.


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

Web Service Element for Get Revenue Allocation Configurations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Revenue_Allocation_Configuration_Request_References  [0..1]  Revenue Allocation Configuration Reference element contains the specific instance set containing the requested Revenue Allocation Configuration. The ID is the value and the Type attribute is either the Lookup ID or the Workday ID (GUID) for the instance of Revenue Allocation Configuration.   
Request_Criteria [Choice]   Revenue_Allocation_Configuration_Request_Criteria  [0..1]  This element is the wrapper around a list of element content representing the specific criteria needed to search for Revenue Allocation Configuration 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_Allocation_Configurations_Response

Element contains Revenue Allocation Configuration response elements including the request data along with the results.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Revenue_Allocation_Configuration_Request_References  [0..1]  Revenue Allocation Configuration Reference element contains the specific instance set containing the requested Revenue Allocation Configuration. The ID is the value and the Type attribute is either the Lookup ID or the Workday ID (GUID) for the instance of Revenue Allocation Configuration.   
Request_Criteria  Revenue_Allocation_Configuration_Request_Criteria  [0..1]  This element is the wrapper around a list of element content representing the specific criteria needed to search for Revenue Allocation Configuration 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_Allocation_Configuration_Response_Data  [0..1]  All Revenue Allocation System Configurations matching the Get Revenue Allocation Configuration request criteria.   
top
 

Revenue_Allocation_Configuration_Request_References

part of: Get_Revenue_Allocation_Configurations_Response, Get_Revenue_Allocation_Configurations_Request
Revenue Allocation Configuration Reference element contains the specific instance set containing the requested Revenue Allocation Configuration. The ID is the value and the Type attribute is either the Lookup ID or the Workday ID (GUID) for the instance of Revenue Allocation Configuration.
 
Parameter name Type/Value Cardinality Description Validations
Revenue_Allocation_Configuration_Reference  Revenue_Allocation_System_ConfigurationObject  [1..*]  Revenue Allocation Configuration Reference   
top
 

Revenue_Allocation_System_ConfigurationObject

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

Revenue_Allocation_System_ConfigurationObjectID

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

part of: Get_Revenue_Allocation_Configurations_Response, Get_Revenue_Allocation_Configurations_Request
This element is the wrapper around a list of element content representing the specific criteria needed to search for Revenue Allocation Configuration instances. All of the elements are "AND" conditions.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Revenue_Allocation_Configurations_Response, Get_Revenue_Allocation_Configurations_Request
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_Allocation_Configurations_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_Allocation_Configuration_Response_Data

part of: Get_Revenue_Allocation_Configurations_Response
All Revenue Allocation System Configurations matching the Get Revenue Allocation Configuration request criteria.
 
Parameter name Type/Value Cardinality Description Validations
Revenue_Allocation_Configuration  Revenue_Allocation_Configuration  [0..*]  All Revenue Allocation System Configurations matching the Get Revenue Allocation Configuration request criteria.   
top
 

Revenue_Allocation_Configuration

part of: Revenue_Allocation_Configuration_Response_Data
All Revenue Allocation System Configurations matching the Get Revenue Allocation Configuration request criteria.
 
Parameter name Type/Value Cardinality Description Validations
Revenue_Allocation_Configuration_Reference  Revenue_Allocation_System_ConfigurationObject  [0..1]  Reference to the Revenue Allocation Configuration returned.   
Revenue_Allocation_Configuration_Data  Revenue_Allocation_Configuration_Data  [0..1]  Revenue Allocation Configuration Data.   
top
 

Revenue_Allocation_Configuration_Data

part of: Revenue_Allocation_Configuration
Element contains all data necessary to create or update a Revenue Allocation Configuration.
 
Parameter name Type/Value Cardinality Description Validations
Allocate_Revenue_at_Summary_and_Prorate_at_Line  boolean  [0..1]  Determines whether to Allocate in Summary.   
Default_Revenue_Allocation_Configuration_Line_Data  Default_Revenue_Allocation_Configuration_Line_Data  [0..1]  Defines the Default Revenue Allocation Configuration Line   
Override_Revenue_Allocation_Configuration_Line_Data  Override_Revenue_Allocation_Configuration_Line_Data  [0..*]  Defines the Revenue Allocation Configuration Lines that will override the Default Revenue Allocation Configuration Line.   
top
 

Default_Revenue_Allocation_Configuration_Line_Data

part of: Revenue_Allocation_Configuration_Data
Element contains all data necessary to create or update a Revenue Allocation Configuration.
 
Parameter name Type/Value Cardinality Description Validations
Lower_Range_Percentage  decimal (10, 4) >0   [0..1]  Lower Range Percentage for Default Revenue Allocation Configuration Line Data   
Upper_Range_Percentage  decimal (10, 4) >0   [0..1]  Upper Range Percentage for Default Revenue Allocation Configuration Line Data.   
Allocation_Basis_Reference  Revenue_Allocation_Calculation_BasisObject  [0..1]  Revenue Allocation Calculation Basis for Default Revenue Allocation Configuration Line. This field is a required field. 
Validation Description
Enter an Allocation Basis.   
 
Fair_Value_Price_List_Reference  Sales_Item_Fair_Value_Price_ListObject  [0..1]  Fair Value Price List for Default Revenue Allocation Configuration Line Data   
top
 

Revenue_Allocation_Calculation_BasisObject

part of: Override_Revenue_Allocation_Configuration_Line_Details_Data, Override_Revenue_Allocation_Configuration_Line_Data, Default_Revenue_Allocation_Configuration_Line_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  Revenue_Allocation_Calculation_BasisObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Revenue_Allocation_Calculation_BasisObjectID

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

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

Sales_Item_Fair_Value_Price_ListObjectID

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

Override_Revenue_Allocation_Configuration_Line_Data

part of: Revenue_Allocation_Configuration_Data
Element representing an Override Revenue Allocation Configuration Line.
 
Parameter name Type/Value Cardinality Description Validations
Override_Revenue_Allocation_Configuration_ID  string  [0..1]  Reference ID for Override Revenue Allocation Configuration Line.   
Override_Revenue_Allocation_Configuration_Reference  Revenue_Allocation_Configuration_LineObject  [0..1]  Reference to Override Revenue Allocation Configuration Line. 
Validation Description
Cannot reference the Default Revenue Allocation Configuration Line from Override Revenue Allocation Configuration Line Data.   
 
Company_Reference  CompanyObject  [0..1]  Company for Override Revenue Allocation Configuration Line. This field is required on the instance and must be unique across all Override Revenue Allocation Configuration Lines for the Revenue Allocation System Configuration. 
Validation Description
Enter a unique Company for the Revenue Allocation Configuration Line.   
Enter a Company.   
 
Fair_Value_Price_List_Reference  Sales_Item_Fair_Value_Price_ListObject  [0..1]  Fair Value Price List for Override Revenue Allocation Configuration Line. This field is required on the instance. 
Validation Description
Enter a Fair Value Price List.   
 
Lower_Range_Percentage  decimal (10, 4) >0   [0..1]  Lower Range Percentage for the Override Revenue Allocation Configuration Line. This field is required on the instance. 
Validation Description
Enter a Lower Range Percentage.   
 
Upper_Range_Percentage  decimal (10, 4) >0   [0..1]  Upper Range Percentage for Override Revenue Allocation Configuration Line. This field is required on the instance. 
Validation Description
Enter an Upper Range Percentage.   
 
Allocation_Basis_Reference  Revenue_Allocation_Calculation_BasisObject  [0..1]  Allocation Basis for Override Revenue Allocation Configuration Line. This field is required on the instance. 
Validation Description
Enter an Allocation Basis.   
 
Line_Override_Defaults_Data  Override_Revenue_Allocation_Configuration_Line_Details_Data  [0..*]  Revenue Allocation Configuration Line Override Details for Override Revenue Allocation Configuration Line.   
top
 

Revenue_Allocation_Configuration_LineObject

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

Revenue_Allocation_Configuration_LineObjectID

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

CompanyObject

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

CompanyObjectID

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

Override_Revenue_Allocation_Configuration_Line_Details_Data

part of: Override_Revenue_Allocation_Configuration_Line_Data
Element representing Revenue Allocation Configuration Line Override Details.
 
Parameter name Type/Value Cardinality Description Validations
Revenue_Allocation_Configuration_Line_Override_Details_ID  string  [0..1]  Revenue Allocation Configuration Line Override Details Reference ID.   
Revenue_Allocation_Configuration_Line_Override_Details_Reference  Revenue_Allocation_Configuration_Line_Override_DetailsObject  [0..1]  Revenue Allocation Configuration Line Override Details Reference. 
Validation Description
Enter a unique Sales Item Group for the Revenue Allocation Configuration Line Override Details.   
Enter either a Sales Item or a Sales Item Group for the Revenue Allocation Configuration Line Override Details.   
Enter a unique Sales Item for the Revenue Allocation Configuration Line Override Details.   
 
Sales_Item_Group_Reference  Sales_Item_GroupObject  [0..1]  Sales Item Group for Revenue Allocation Configuration Line Override Details. This field must be unique for all Revenue Allocation Configuration Line Override Details associated with the same Override Revenue Allocation Configuration Line. This field is also required on the instance. 
Validation Description
Select a sales item group that is part of the associated fair value price list for that row.   
 
Sales_Item_Reference  Sales_ItemObject  [0..1]  Sales Item for Revenue Allocation Configuration Line Override Details. This field must be unique across all Revenue Allocation Configuration Line Override Details associated with the same Override Revenue Allocation Configuration Line. This field is also required on the instance. 
Validation Description
Select a sales item that is part of the associated fair value price list for that row.   
 
Lower_Range_Percentage  decimal (10, 4) >0   [0..1]  Lower Range Percentage for Revenue Allocation Configuration Line Override Details. This field is required on the instance. 
Validation Description
Enter a Lower Range Percentage.   
 
Upper_Range_Percentage  decimal (10, 4) >0   [0..1]  Upper Range Percentage for Revenue Allocation Configuration Line Override Details. This field is required on the instance. 
Validation Description
Enter an Upper Range Percentage.   
 
Allocation_Basis_Reference  Revenue_Allocation_Calculation_BasisObject  [0..1]  Allocation Basis for Revenue Allocation Configuration Line Override Details. This field is required on the instance. 
Validation Description
Enter a Revenue Allocation Calculation Basis for the Revenue Allocation Configuration Line Override Details.   
 
top
 

Revenue_Allocation_Configuration_Line_Override_DetailsObject

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

Revenue_Allocation_Configuration_Line_Override_DetailsObjectID

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

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

Sales_Item_GroupObjectID

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

part of: Revenue_Allocation_System_ConfigurationObjectID
Base Type
string
top
 

Revenue_Allocation_Calculation_BasisReferenceEnumeration

part of: Revenue_Allocation_Calculation_BasisObjectID
Base Type
string
top
 

Sales_Item_Fair_Value_Price_ListReferenceEnumeration

part of: Sales_Item_Fair_Value_Price_ListObjectID
Base Type
string
top
 

Revenue_Allocation_Configuration_LineReferenceEnumeration

part of: Revenue_Allocation_Configuration_LineObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Revenue_Allocation_Configuration_Line_Override_DetailsReferenceEnumeration

part of: Revenue_Allocation_Configuration_Line_Override_DetailsObjectID
Base Type
string
top
 

Sales_Item_GroupReferenceEnumeration

part of: Sales_Item_GroupObjectID
Base Type
string
top
 

Sales_ItemReferenceEnumeration

part of: Sales_ItemObjectID
Base Type
string
top