Service Directory > v32.1 > Financial_Management > Get_Tax_Categories
 

Operation: Get_Tax_Categories

This service operation will get Tax Categories for the specified criteria. Tax Category data includes Tax Category ID and Name. The request criteria can be for a single transaction based on Reference, or all transactions 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_Tax_Categories_Request

Contains request reference, criteria, filter and response group for getting Tax Category data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Tax_Category_Request_References  [0..1]  Get Tax Categories Request References   
Request_Criteria [Choice]   Tax_Category_Request_Criteria  [0..1]  Get Tax Categories Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Tax Categories Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Tax_Category_Response_Group  [0..1]  Get Tax Categories Response Group   
top
 

Response Element: Get_Tax_Categories_Response

Element containing Tax 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  Tax_Category_Request_References  [0..1]  Get Tax Categories Request References   
Request_Criteria  Tax_Category_Request_Criteria  [0..1]  Get Tax Categories Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Tax Categories Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Tax_Category_Response_Group  [0..1]  Get Tax Categories Response Group   
Response_Results  Response_Results  [0..1]  Get Tax Categories Response Results   
Response_Data  Tax_Category_Response_Data  [0..1]  Get Tax Categories Response Data   
top
 

Tax_Category_Request_References

part of: Get_Tax_Categories_Request, Get_Tax_Categories_Response
Element containing reference instances for a Tax Category
 
Parameter name Type/Value Cardinality Description Validations
Tax_Category_Reference  Tax_CategoryObject  [1..*]  Reference to an existing Tax Category   
top
 

Tax_CategoryObject

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

Tax_CategoryObjectID

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

Tax_Category_Request_Criteria

part of: Get_Tax_Categories_Request, Get_Tax_Categories_Response
Element containing Tax Category request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Tax_Categories_Request, Get_Tax_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
 

Tax_Category_Response_Group

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

Response_Results

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

Tax_Category_Response_Data

part of: Get_Tax_Categories_Response
Wrapper Element that includes Tax Category Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Category  Tax_Category  [0..*]  Tax Category   
top
 

Tax_Category

part of: Tax_Category_Response_Data
Wrapper Element that includes Tax Category Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Category_Reference  Tax_CategoryObject  [0..1]  Reference to an existing Tax Category   
Tax_Category_Data  Tax_Category_Data  [0..*]  Tax Category Data 
Validation Description
Withholding tax categories can't be Subject to Recoverability.   
 
top
 

Tax_Category_Data

part of: Tax_Category
Element containing all Tax Category data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Category_ID  string  [0..1]  Tax Category ID. This is the Tax Category unique identifier.   
Tax_Category_Name  string  [1..1]  Free form text field for a meaningful Tax Category Name 
Validation Description
Enter a unique Tax Category Name. [name] is already in use.  The tax category name is already in use 
 
Subject_to_Recoverability  boolean  [0..1]  is it Subject to Recoverability? 
Validation Description
Tax Category is in use; Subject to Recoverability cannot be changed.   
Withholding tax categories can't be Subject to Recoverability.   
 
Withholding_Tax  boolean  [0..1]  Is it part of WithHolding Tax ? 
Validation Description
Tax Category is in use; Withholding Tax cannot be changed.   
Withholding tax categories can't be Subject to Recoverability.   
 
Validation Description
Withholding tax categories can't be Subject to Recoverability.   
top
 

Tax_CategoryReferenceEnumeration

part of: Tax_CategoryObjectID
Base Type
string
top