Service Directory > v25.1 > Human_Resources > Get_Company_Tax_IDs
 

Operation: Get_Company_Tax_IDs DEPRECATED

DEPRECATED: This operation has been replaced by Get Workday Companies. This operation retrieves Tax ID information for one or more companies.


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

This element is the top-level request element for all "Get" Company TaxID operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Company_Tax_ID_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Company_Tax_ID_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Company_Tax_ID_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Company_Tax_IDs_Response

Top-level response element for all "Get" Company Tax ID operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Company_Tax_ID_Request_References  [0..1]  Company Tax ID Request References   
Request_Criteria  Company_Tax_ID_Request_Criteria  [0..1]  Company Tax ID Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Company_Tax_ID_Response_Group  [0..1]  Company Tax ID Response Group   
Response_Results  Response_Results  [0..1]  Company Tax ID Response Results   
Response_Data  Company_Tax_ID_Response_Data  [0..1]  Company Tax ID Response Data   
top
 

Company_Tax_ID_Request_References

part of: Get_Company_Tax_IDs_Request, Get_Company_Tax_IDs_Response
Company Tax ID Request Reference element contains the specific instance set containing the requested Company Tax ID. The Company ID is either the Lookup ID or the Workday ID (GUID).
 
Parameter name Type/Value Cardinality Description Validations
Company_Tax_ID_Reference  CompanyObject  [1..*]  Company Tax ID Reference   
top
 

CompanyObject

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

CompanyObjectID

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

Company_Tax_ID_Request_Criteria

part of: Get_Company_Tax_IDs_Request, Get_Company_Tax_IDs_Response
The Request Criteria is a wrapper element around a list of elements representing the operation specific criteria needed to search for Company TaxID instances
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Company_Tax_IDs_Request, Get_Company_Tax_IDs_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
 

Company_Tax_ID_Response_Group

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

Response_Results

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

Company_Tax_ID_Response_Data

part of: Get_Company_Tax_IDs_Response
Element containing Company Tax ID Response data
 
Parameter name Type/Value Cardinality Description Validations
Company_Tax_ID  Company_Tax_IDs  [0..*]  Element containing Company Tax ID   
top
 

Company_Tax_IDs

part of: Company_Tax_ID_Response_Data
Response element containing an instance of Company and its Tax ID.
 
Parameter name Type/Value Cardinality Description Validations
Company_Tax_ID_Data  Company_WWS_Tax_ID_Data  [0..*]  Element encapsulating Company Tax ID data. 
Validation Description
Tax ID is required  Tax ID is required 
 
top
 

Company_WWS_Tax_ID_Data

part of: Company_Tax_IDs
Element encapsulating Company Tax ID data.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  Represents a reference to the company.   
Company_Tax_ID  string  [0..1]  Tax ID for the Company.   
Validation Description
Tax ID is required  Tax ID is required 
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top