Service Directory > v31.2 > Revenue_Management > Get_Sales_Item_Price_Lists
 

Operation: Get_Sales_Item_Price_Lists

This web service operation will get Sales Item Price Lists. If no Reference ID is passed in the all Sales Items Price Lists will be returned, otherwise only the one specified in Reference ID.


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

Contains Get Sales Item Price List Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Sales_Item_Price_List_Request_References  [0..1]  Sales Item Price List Reference element contains the specific instance set containing the requested Sales Item Price List. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the instance of Sales Item Price List.   
Request_Criteria [Choice]   Sales_Item_Price_List_Request_Criteria  [0..1]  This element is the wrapper around a list of element content representing the specific criteria needed to search for Sales Item Price List 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_Group  Sales_Item_Price_List_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Sales Item Price List response.   
top
 

Response Element: Get_Sales_Item_Price_Lists_Response

Element contains Sales Item Price List 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  Sales_Item_Price_List_Request_References  [0..1]  Sales Item Price List Reference element contains the specific instance set containing the requested Sales Item Price List. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the instance of Sales Item Price List.   
Request_Criteria  Sales_Item_Price_List_Request_Criteria  [0..1]  This element is the wrapper around a list of element content representing the specific criteria needed to search for Sales Item Price List 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_Group  Sales_Item_Price_List_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Sales Item Price List 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  Sales_Item_Price_List_Response_Data  [0..1]  Sales Item Price List Response Data Element.   
top
 

Sales_Item_Price_List_Request_References

part of: Get_Sales_Item_Price_Lists_Request, Get_Sales_Item_Price_Lists_Response
Sales Item Price List Reference element contains the specific instance set containing the requested Sales Item Price List. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the instance of Sales Item Price List.
 
Parameter name Type/Value Cardinality Description Validations
Sales_Item_Price_List_Reference  Sales_Item_Unit_Price_ListObject  [1..*]  Sales Item Price List Request Reference.   
top
 

Sales_Item_Unit_Price_ListObject

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

Sales_Item_Unit_Price_ListObjectID

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

Sales_Item_Price_List_Request_Criteria

part of: Get_Sales_Item_Price_Lists_Request, Get_Sales_Item_Price_Lists_Response
This element is the wrapper around a list of element content representing the specific criteria needed to search for Sales Item Price List instances. All of the elements are "AND" conditions.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Sales_Item_Price_Lists_Request, Get_Sales_Item_Price_Lists_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
 

Sales_Item_Price_List_Response_Group

part of: Get_Sales_Item_Price_Lists_Request, Get_Sales_Item_Price_Lists_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Sales Item Price List response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Sales Item Price List Reference data is to be included in the response.   
top
 

Response_Results

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

Sales_Item_Price_List_Response_Data

part of: Get_Sales_Item_Price_Lists_Response
Sales Item Price List Response Data Element.
 
Parameter name Type/Value Cardinality Description Validations
Sales_Item_Price_List  Sales_Item_Price_List  [0..*]  Sales Item Price List Response Data Element.   
top
 

Sales_Item_Price_List

part of: Sales_Item_Price_List_Response_Data
Sales Item Price List Data details.
 
Parameter name Type/Value Cardinality Description Validations
Sales_Item_Price_List_Reference  Sales_Item_Unit_Price_ListObject  [0..1]  Sales Item Price List Reference   
Sales_Item_Price_List_Data  Sales_Item_Price_List_Data  [0..1]  The data for the Sales Item Price List.   
top
 

Sales_Item_Price_List_Data

part of: Sales_Item_Price_List
Contains element data for Get/Put Sales Item Price List.
 
Parameter name Type/Value Cardinality Description Validations
Sales_Item_Price_List_Data_ID  string  [0..1]  Sales Item Price List ID.   
Price_List_Name  string  [1..1]  Sales Item Price List Name.   
Currency_Reference  CurrencyObject  [1..1]  Sales Item Price List Currency Reference.   
Sales_Item_Price_List_Snapshot_Data  Sales_Item_Price_List_Snapshot_Data  [0..*]  Sales Item Price List Snapshot Data element. 
Validation Description
The following Sales Item Price Rules are duplicates: [rules]. Enter a Sales Item Price Rule with a unique combination of Contract Line Type, Sales Item Group, Sales Item, Unit of Measure, and Worktag values.   
There are price rules with invalid worktags. Select worktag values for all worktag types or remove all worktag values.   
 
top
 

CurrencyObject

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

CurrencyObjectID

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

part of: Sales_Item_Price_List_Data
Sales Item Price List Data element. Contains Sales Item Price List Snapshot lines.
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  Sales Item Price List Effective Date.   
Accounting_Worktag_Type_Reference  Accounting_Worktag_TypeObject  [0..*]  Sales Item Price List Accounting Worktag 
Validation Description
Enter valid worktag types.   
 
Sales_Item_Price_List_Rule_Line_Data  Sales_Item_Price_List_Rule_Line_Data  [0..*]  Sales Item Price List Snapshot Line Data element. 
Validation Description
Enter a valid Contract Line Type. You can only enter these Line Types: Fixed Amount, Fixed Amount - Billing Only, Recurring - Fixed Term, Subscription, and Variable Amount- Non Project.   
You can't have a Unit Price on both the Tiered Price and the Price Rule. Remove the Unit Price from either the Tiered Price or the Price Rule.   
Enter the Unit Price on the Price Rule or on the Tiered Price.   
The rule must have one tier that starts from 0.   
Enter a From value that isn’t already in use in another tier.   
Enter the Sales Item or the Sales Item Group.   
 
Validation Description
The following Sales Item Price Rules are duplicates: [rules]. Enter a Sales Item Price Rule with a unique combination of Contract Line Type, Sales Item Group, Sales Item, Unit of Measure, and Worktag values.   
There are price rules with invalid worktags. Select worktag values for all worktag types or remove all worktag values.   
top
 

Accounting_Worktag_TypeObject

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

Accounting_Worktag_TypeObjectID

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

part of: Sales_Item_Price_List_Snapshot_Data
Contains Sales Item Price List Snapshot Line Data for Amount line types.
 
Parameter name Type/Value Cardinality Description Validations
Contract_Line_Type_Reference  Contract_Line_TypeObject  [1..*]  Contract Line Type Reference.   
Sales_Item_Group_Reference [Choice]   Sales_Item_GroupObject  [0..1]  Sales Item Group Reference. 
Validation Description
Enter a valid sales item group.   
 
Sales_Item_Reference [Choice]   Sales_ItemObject  [0..1]  Sales Item Reference.   
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Unit of Measure Reference   
Unit_Price  decimal (18, 4)   [0..1]  Sales Item Price List Unit Price.   
Worktag_Reference  Audited_Accounting_WorktagObject  [0..*]  Worktags for Sales Item Price List Rule Line.   
Sales_Item_Tiered_Pricing_Data  Sales_Item_Tiered_Pricing_Data  [0..*]  Contains Sales Item Tiered Pricing Data. 
Validation Description
Enter the Quantity From.   
 
Validation Description
Enter a valid Contract Line Type. You can only enter these Line Types: Fixed Amount, Fixed Amount - Billing Only, Recurring - Fixed Term, Subscription, and Variable Amount- Non Project.   
You can't have a Unit Price on both the Tiered Price and the Price Rule. Remove the Unit Price from either the Tiered Price or the Price Rule.   
Enter the Unit Price on the Price Rule or on the Tiered Price.   
The rule must have one tier that starts from 0.   
Enter a From value that isn’t already in use in another tier.   
Enter the Sales Item or the Sales Item Group.   
top
 

Contract_Line_TypeObject

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

Contract_Line_TypeObjectID

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

Unit_of_MeasureObject

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

Unit_of_MeasureObjectID

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

Audited_Accounting_WorktagObject

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

Audited_Accounting_WorktagObjectID

part of: Audited_Accounting_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_ID, Customer_Reference_ID, Deduction_Recipient_ID, Donor_ID, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Job_Category_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Loan_ID, Location_ID, Management_Level_ID, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_ID, Program_of_Study_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_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_Tiered_Pricing_Data

part of: Sales_Item_Price_List_Rule_Line_Data
Contains Sales Item Tiered Pricing Data.
 
Parameter name Type/Value Cardinality Description Validations
Quantity_From  decimal (22, 2) >0   [0..1]  Sales Item Tiered Pricing Quantity From Break.   
Unit_Price  decimal (18, 4)   [1..1]  Sales Item Tiered Pricing Unit Price.   
Validation Description
Enter the Quantity From.   
top
 

Sales_Item_Unit_Price_ListReferenceEnumeration

part of: Sales_Item_Unit_Price_ListObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Accounting_Worktag_TypeReferenceEnumeration

part of: Accounting_Worktag_TypeObjectID
Base Type
string
top
 

Contract_Line_TypeReferenceEnumeration

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

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

Audited_Accounting_WorktagReferenceEnumeration

part of: Audited_Accounting_WorktagObjectID
Base Type
string
top