Service Directory > v31.2 > Financial_Management > Get_Basic_Suppliers
 

Operation: Get_Basic_Suppliers

This service operation will get basic Suppliers that can be used as worktags only. Basic Supplier data includes a Reference ID, Supplier 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 Suppliers can not be used on financial transactions such as Supplier Invoices or Supplier Payments. Use the Get Suppliers web service for retrieving complete supplier 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_Suppliers_Request

This element is the top-level request element for all "Get" Basic Suppliers operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Supplier_Request_References  [0..1]  Supplier Reference element contains the specific instance set containing the requested Supplier. The ID is either the Lookup ID or the Workday ID (GUID).   
Request_Criteria [Choice]   Supplier_Request_Criteria  [0..1]  Element used to Request certain Suppliers 
Validation Description
You cannot submit a blank Request Criteria Element.   
Updated To Date must be less than or equal to Current Moment   
One of the dates for Update to Date or Update From Date is missing. If using this criteria please enter both dates.   
Updated From Date must be less than or equal to Updated To Date in order to possibly return any Data.   
 
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  Supplier_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_Suppliers_Response

Top-level response element for all "Get" Basic Suppliers operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Supplier_Request_References  [0..1]  Supplier Reference element contains the specific instance set containing the requested Supplier. The ID is either the Lookup ID or the Workday ID (GUID).   
Request_Criteria  Supplier_Request_Criteria  [0..1]  Element used to Request certain Suppliers 
Validation Description
You cannot submit a blank Request Criteria Element.   
Updated To Date must be less than or equal to Current Moment   
One of the dates for Update to Date or Update From Date is missing. If using this criteria please enter both dates.   
Updated From Date must be less than or equal to Updated To Date in order to possibly return any Data.   
 
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  Supplier_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Supplier 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_Supplier_Response_Data  [0..1]  Wrapper element that contains the Basic Supplier data elements included in the response.   
top
 

Supplier_Request_References

part of: Get_Basic_Suppliers_Request, Get_Basic_Suppliers_Response
Supplier Reference element contains the specific instance set containing the requested Supplier. The ID is either the Lookup ID or the Workday ID (GUID).
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Reference  SupplierObject  [1..*]  Supplier Reference   
top
 

SupplierObject

part of: Supplier_Request_References, Supplier_Request_Criteria, Basic_Supplier
 
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  SupplierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

SupplierObjectID

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

Supplier_Request_Criteria

part of: Get_Basic_Suppliers_Request, Get_Basic_Suppliers_Response
Element used to Request certain Suppliers
 
Parameter name Type/Value Cardinality Description Validations
Updated_From_Date  dateTime  [0..1]  Supplier Change From Date   
Updated_To_Date  dateTime  [0..1]  Supplier Change To Date   
Supplier_Status_Reference  Business_Entity_Status_ValueObject  [0..*]  Supplier Status   
Supplier_Category_Reference  Supplier_CategoryObject  [0..*]  Supplier Category   
Supplier_Group_Reference  Supplier_GroupObject  [0..*]  Supplier Group   
Customer_Account_Number  string  [0..1]  Account Number   
DUNS_Number  string (9)   [0..1]  DUNS Number   
Parent_Supplier_Reference  SupplierObject  [0..*]  Parent Supplier   
Validation Description
You cannot submit a blank Request Criteria Element.   
Updated To Date must be less than or equal to Current Moment   
One of the dates for Update to Date or Update From Date is missing. If using this criteria please enter both dates.   
Updated From Date must be less than or equal to Updated To Date in order to possibly return any Data.   
top
 

Business_Entity_Status_ValueObject

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

Business_Entity_Status_ValueObjectID

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

Supplier_CategoryObject

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

Supplier_CategoryObjectID

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

Supplier_GroupObject

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

Supplier_GroupObjectID

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

Response_Filter

part of: Get_Basic_Suppliers_Request, Get_Basic_Suppliers_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
 

Supplier_Response_Group

part of: Get_Basic_Suppliers_Request, Get_Basic_Suppliers_Response
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]  Flag indicating if the Supplier reference is to be included in the response.   
Include_Attachment_Data  boolean  [0..1]  Flag indicating if the attachment data within Supplier Data is to be included in the response   
top
 

Response_Results

part of: Get_Basic_Suppliers_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_Supplier_Response_Data

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

Basic_Supplier

part of: Basic_Supplier_Response_Data
This element is the wrapper element for all Supplier data
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Reference  SupplierObject  [0..1]  Supplier Reference   
Basic_Supplier_Data  Basic_Supplier_Data  [0..1]  This Element contains Supplier attributes. 
Validation Description
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_Supplier_Data

part of: Basic_Supplier
This Element contains basic Supplier attributes for suppliers used as worktags only.
 
Parameter name Type/Value Cardinality Description Validations
Supplier_ID  string  [0..1]  Supplier ID   
Supplier_Reference_ID  string  [0..1]  Supplier Reference ID. The Supplier Reference ID can be used to uniquely identify a Supplier Unlike Supplier ID, Workday will not automatically generate a Supplier Reference ID if one is not received. The recommended use for Supplier Reference ID is where the Workday is not the source system of the Supplier   
Supplier_Name  string  [1..1]  Supplier Name   
Inactive  boolean  [0..1]  Inactive Flag.   
Validation Description
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
 

SupplierReferenceEnumeration

part of: SupplierObjectID
Base Type
string
top
 

Business_Entity_Status_ValueReferenceEnumeration

part of: Business_Entity_Status_ValueObjectID
Base Type
string
top
 

Supplier_CategoryReferenceEnumeration

part of: Supplier_CategoryObjectID
Base Type
string
top
 

Supplier_GroupReferenceEnumeration

part of: Supplier_GroupObjectID
Base Type
string
top