Service Directory > v32.1 > Financial_Management > Get_Basic_Customers
 

Operation: Get_Basic_Customers

This service operation will get basic Customers that can be used as worktags only. Basic Customer data includes Reference ID, Customer Name, and Inactive boolean. The request criteria can be for a single transaction based on Reference, or all transaction can be retrieved if no criteria is specified. Basic Customers can not be used on financial transactions such as Customer Invoices, Customer Contracts, or billing transactions. Use the Get Customers web service for retrieving complete Customer definitions used by Financial transactions.


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

This element is the top-level request element for all "Get" Basic Customers operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Customer_Request_References  [0..1]  Customer Reference element contains the specific instance set containing the requested Customer. The ID is either the Lookup ID or the Workday ID (GUID).   
Request_Criteria [Choice]   Basic_Customer_Request_Criteria  [0..1]  Element used to Request certain Suppliers   
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  Basic_Customer_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Supplier response.   
top
 

Response Element: Get_Basic_Customers_Response

Top-level response element for all "Get" Basic Customers operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Customer_Request_References  [0..1]  Customer Reference element contains the specific instance set containing the requested Customer. The ID is either the Lookup ID or the Workday ID (GUID).   
Request_Criteria  Basic_Customer_Request_Criteria  [0..1]  Element used to Request certain Suppliers   
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  Customer_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Customer 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  Basic_Customer_Response_Data  [0..1]  Wrapper element that contains the Basic Customer data elements included in the response   
top
 

Customer_Request_References

part of: Get_Basic_Customers_Request, Get_Basic_Customers_Response
Customer Reference element contains the specific instance set containing the requested Customer. The ID is either the Lookup ID or the Workday ID (GUID).
 
Parameter name Type/Value Cardinality Description Validations
Customer_Reference  CustomerObject  [0..*]  Reference to an existing Customer for update only purposes   
top
 

CustomerObject

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

CustomerObjectID

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

Basic_Customer_Request_Criteria

part of: Get_Basic_Customers_Request, Get_Basic_Customers_Response
Element used to Request certain Suppliers
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Basic_Customers_Request, Get_Basic_Customers_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
 

Basic_Customer_Response_Group

part of: Get_Basic_Customers_Request
Wrapper element around a list of elements representing the amount of data that should be included in the Supplier response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Customer_Response_Group

part of: Get_Basic_Customers_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Customer response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Customer reference is to be included in the response   
Include_Customer_Data  boolean  [0..1]  Flag indicating if the Customer data is to be included in the response   
Include_Customer_Balance  boolean  [0..1]  Flag indicating if the Customer Balance data is to be included in the response   
Include_Customer_Activity_Detail  boolean  [0..1]  Include Customer Activity Summary for Summary Date Range   
top
 

Response_Results

part of: Get_Basic_Customers_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_Customer_Response_Data

part of: Get_Basic_Customers_Response
Wrapper element that contains the Basic Customer data elements included in the response
 
Parameter name Type/Value Cardinality Description Validations
Basic_Customer  Basic_Customer  [0..*]  Customer wrapper element that contains the Customer "Data" elements that are included in the response   
top
 

Basic_Customer

part of: Basic_Customer_Response_Data
This element is the wrapper element for all basic Customer data
 
Parameter name Type/Value Cardinality Description Validations
Customer_Reference  CustomerObject  [0..1]  Customer Reference   
Basic_Customer_Data  Basic_Customer_Data  [0..1]  This element contains basic Customer attributes 
Validation Description
Can not switch an existing non-basic, non-worktag only supplier to be a basic, worktag only.  Can not switch an existing non-basic, non-worktag only supplier to be a basic, worktag only. 
Two Reference ID's have been provided that resolve to different instances. Please provide only one Reference ID or verify that both Reference ID's resolve to the same instance.  Two Reference ID's have been provided that resolve to different instances. Please provide only one Reference ID or verify that both Reference ID's resolve to the same instance. 
 
top
 

Basic_Customer_Data

part of: Basic_Customer
This element contains basic Customer data for customers used as worktags only.
 
Parameter name Type/Value Cardinality Description Validations
Customer_ID  string  [0..1]  Customer ID. This is a unique identifier for the Customer   
Customer_Reference_ID  string  [0..1]  Customer Reference ID. The Customer Reference ID can be used to uniquely identify a Customer. Unlike Customer ID, Workday will not automatically generate a Customer Reference ID if one is not received. The recommended use for Customer Reference ID is where Workday is not the source system of the Customer.   
Customer_Name  string  [1..1]  Customer Name 
Validation Description
Customer Name is already used by another Business Entity   
 
Inactive  boolean  [0..1]  Inactive Flag.   
Validation Description
Can not switch an existing non-basic, non-worktag only supplier to be a basic, worktag only.  Can not switch an existing non-basic, non-worktag only supplier to be a basic, worktag only. 
Two Reference ID's have been provided that resolve to different instances. Please provide only one Reference ID or verify that both Reference ID's resolve to the same instance.  Two Reference ID's have been provided that resolve to different instances. Please provide only one Reference ID or verify that both Reference ID's resolve to the same instance. 
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
top