Service Directory > v32.1 > Revenue_Management > Get_Customer_Categories
 

Operation: Get_Customer_Categories

This service operation will get Customer Categories Types for the specified criteria. Customer Category includes the Customer Category ID and Customer Category Name. Customer categories are used to help determine accounting for transactions beyond what is defined in the posting rules. When processing a transaction, Workday finds the category on a customer and applies the accounting based on the category. You can also use customer categories when selecting or searching for customers. Each customer must have one customer category. You assign a customer to a customer categories when creating or editing a customer. 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_Customer_Categories_Request

Element containing Customer Category 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 [Choice]   Customer_Category_Request_References  [0..1]  Get Customer Categories Request References   
Request_Criteria [Choice]   Customer_Category_Request_Criteria  [0..1]  Get Customer Categories Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Customer Categories Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Customer_Category_Response_Group  [0..1]  Get Customer Categories Response Group   
top
 

Response Element: Get_Customer_Categories_Response

Element containing Customer Category 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  Customer_Category_Request_References  [0..1]  Get Customer Categories Request References   
Request_Criteria  Customer_Category_Request_Criteria  [0..1]  Get Customer Categories Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Customer Categories Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Customer_Category_Response_Group  [0..1]  Get Customer Categories Response Group   
Response_Results  Response_Results  [0..1]  Get Customer Categories Response Results   
Response_Data  Customer_Category_Response_Data  [0..1]  Get Customer Categories Response Data   
top
 

Customer_Category_Request_References

part of: Get_Customer_Categories_Request, Get_Customer_Categories_Response
Element containing reference instances for a Customer Category
 
Parameter name Type/Value Cardinality Description Validations
Customer_Category_Reference  Customer_CategoryObject  [1..*]  Reference to an existing Customer Category   
top
 

Customer_CategoryObject

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

Customer_CategoryObjectID

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

Customer_Category_Request_Criteria

part of: Get_Customer_Categories_Request, Get_Customer_Categories_Response
Element containing Customer Category request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Customer_Categories_Request, Get_Customer_Categories_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
 

Customer_Category_Response_Group

part of: Get_Customer_Categories_Request, Get_Customer_Categories_Response
Element containing Customer Category response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Customer_Category_Response_Data

part of: Get_Customer_Categories_Response
Wrapper Element that includes Customer Category Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Customer_Category  Customer_Category  [0..*]  Element containing Customer Category Data   
top
 

Customer_Category

part of: Customer_Category_Response_Data
Wrapper Element that includes Customer Category Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Customer_Category_Reference  Customer_CategoryObject  [0..1]  Reference to an existing Customer Category   
Customer_Category_Data  Customer_Category_Data  [0..*]  Customer Category Data   
top
 

Customer_Category_Data

part of: Customer_Category
Element containing all Customer Category data
 
Parameter name Type/Value Cardinality Description Validations
Customer_Category_ID  string  [0..1]  Customer Category ID. This is the Customer Category unique identifier   
Customer_Category_Name  string  [1..1]  Free form text field for Customer Category Name 
Validation Description
Enter a unique Customer Category Name. [category] is already in use.  The Customer Category Name is already in use. 
 
top
 

Customer_CategoryReferenceEnumeration

part of: Customer_CategoryObjectID
Base Type
string
top