Service Directory > v31.2 > Financial_Management > Get_Basic_Sales_Items
 

Operation: Get_Basic_Sales_Items

This service operation will add or update Sales Items used as worktag values only. Basic Sales Item data includes Sales Item ID, Item Name, Inactive status. These basic sales items can only be used as worktag values and will not be usable from many financial transactions such as Customer Invoices, Customer Contracts, Expense Reports, or Cash Sale transactions. The request criteria can be for a single transaction based on Reference, or all transaction can be retrieved if no criteria is specified.


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

Contains request reference, criteria, filter and response group for getting Sales Item data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Sales_Item_Request_References  [0..1]  Get Sales Items Request References   
Request_Criteria [Choice]   Sales_Item_Request_Criteria  [0..1]  Get Sales Items Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Sales Items Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Sales_Item_Response_Group  [0..1]  Get Basic Sales Item response group   
top
 

Response Element: Get_Basic_Sales_Items_Response

Element containing Sales Item response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Sales_Item_Request_References  [0..1]  Element containing reference instances for a Sales Item   
Request_Criteria  Sales_Item_Request_Criteria  [0..1]  Element containing Sales Item request criteria   
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_Response_Group  [0..1]  Element containing Sales Item response grouping options   
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  Basic_Sales_Item_Response_Data  [0..1]  Wrapper Element that includes Sales Item Instance and Data   
top
 

Sales_Item_Request_References

part of: Get_Basic_Sales_Items_Request, Get_Basic_Sales_Items_Response
Element containing reference instances for a Sales Item
 
Parameter name Type/Value Cardinality Description Validations
Sales_Item_Reference  Sales_ItemObject  [1..*]  This is the reference id value of the sales item. If a value is provided for sales item, revenue category will default so it is recommended to provide a value for either sales item or revenue category but not both.   
top
 

Sales_ItemObject

part of: Sales_Item_Request_References, Basic_Sales_Item
 
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
 

Sales_Item_Request_Criteria

part of: Get_Basic_Sales_Items_Request, Get_Basic_Sales_Items_Response
Element containing Sales Item request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Basic_Sales_Items_Request, Get_Basic_Sales_Items_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_Response_Group

part of: Get_Basic_Sales_Items_Request, Get_Basic_Sales_Items_Response
Element containing Sales Item response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Basic_Sales_Item_Response_Data

part of: Get_Basic_Sales_Items_Response
Wrapper Element that includes Sales Item Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Sales_Item  Basic_Sales_Item  [0..*]  Get Sales Items Response Data   
top
 

Basic_Sales_Item

part of: Basic_Sales_Item_Response_Data
Wrapper Element that includes Sales Item Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Sales_Item_Reference  Sales_ItemObject  [0..1]  This is the reference id value of a sales item available to be used as a worktag value.   
Sales_Item_Data  Basic_Sales_Item_Data  [0..1]  Sales Item Data 
Validation Description
Can not update an existing Sales Item with detail information to be a basic worktag only Sales Item.   
 
top
 

Basic_Sales_Item_Data

part of: Basic_Sales_Item
Element containing all Sales Item data for a Sales Item used as a basic worktag only
 
Parameter name Type/Value Cardinality Description Validations
Sales_Item_ID  string  [0..1]  Sales Item ID. This is the Sales Item unique identifier   
Item_Name  string  [1..1]  Free form text for a meaningful Sales Item Name 
Validation Description
Sales item name is already used.  Sales item name is already used. 
 
Inactive  boolean  [0..1]  Boolean to indicate a Sales Item that is Inactive.   
Validation Description
Can not update an existing Sales Item with detail information to be a basic worktag only Sales Item.   
top
 

Sales_ItemReferenceEnumeration

part of: Sales_ItemObjectID
Base Type
string
top