Service Directory > v31.2 > Financial_Management > Get_Tax_Applicabilities
 

Operation: Get_Tax_Applicabilities

This service operation will get Tax Applicability data for the specified criteria. Data includes Tax ID, Tax Applicability Code, Taxable, and Recoverable. The request criteria can be for a specific Tax Applicability based on reference(s), Tax Applicability Code (partial match ok), Taxable?, and Recoverable? criteria. If no criteria are specified, all Tax Applicabilities will be retrieved.


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

Contains request reference, criteria, filter and response group for getting Tax Applicability data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Tax_Applicability_Request_References  [0..1]  Get Tax Applicability Request References   
Request_Criteria [Choice]   Tax_Applicability_Request_Criteria  [0..1]  Get Tax Applicability Request Criteria   
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  Tax_Applicability_Response_Group  [0..1]  Get Tax Applicability Response Group   
top
 

Response Element: Get_Tax_Applicabilities_Response

Element containing Tax Applicability 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_Applicability_Request_References  [0..1]  Get Tax Applicability Request References   
Request_Criteria  Tax_Applicability_Request_Criteria  [0..1]  Get Tax Applicability Request Criteria   
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  Tax_Applicability_Response_Group  [0..1]  Tax Applicability Response Group   
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  Tax_Applicability_Response_Data  [0..1]  Wrapper Element that includes Tax Applicability Reference Instance and Tax Applicability Data   
top
 

Tax_Applicability_Request_References

part of: Get_Tax_Applicabilities_Request, Get_Tax_Applicabilities_Response
Get Tax Applicability Request References
 
Parameter name Type/Value Cardinality Description Validations
Tax_Applicability_Reference  Tax_ApplicabilityObject  [1..*]  Tax Applicability Reference   
top
 

Tax_ApplicabilityObject

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

Tax_ApplicabilityObjectID

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

part of: Get_Tax_Applicabilities_Request, Get_Tax_Applicabilities_Response
Get Tax Applicability Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Tax_Applicability_Code  string  [0..1]  Search by Tax Applicability Code. Can be a match of a partial string.   
Taxable [Choice]   boolean  [0..1]  Search by Taxable boolean   
Non-Taxable [Choice]   boolean  [0..1]  Search by Non-Taxable boolean. You can only enter a Non-Taxable boolean criteria or a Taxable boolean, but not both.   
Tax_Recoverability_Reference  Tax_RecoverabilityObject  [0..1]  Search by Tax Recoverability.   
top
 

Tax_RecoverabilityObject

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

Tax_RecoverabilityObjectID

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

part of: Get_Tax_Applicabilities_Request, Get_Tax_Applicabilities_Response
Tax Applicability Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Tax_Applicabilities_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_Applicability_Response_Data

part of: Get_Tax_Applicabilities_Response
Wrapper Element that includes Tax Applicability Reference Instance and Tax Applicability Data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Applicability  Tax_Applicability  [0..*]  Contains data for a given Tax Applicability object   
top
 

Tax_Applicability

part of: Tax_Applicability_Response_Data
Element containing Tax Applicability reference and data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Applicability_Reference  Tax_ApplicabilityObject  [0..1]  Tax Applicability Reference   
Tax_Applicability_Data  Tax_Applicability_Data  [0..1]  Tax Applicability Data   
top
 

Tax_Applicability_Data

part of: Tax_Applicability
Tax Applicability Data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Applicability_ID  string  [0..1]  This is the unique identifier for Tax Applicability   
Tax_Applicability_Code  string  [1..1]  Tax Applicability Code. Description of the applicability, such as "Non-Taxable Sales" 
Validation Description
Enter a unique Tax Applicability Code. [code] is already in use.  The Tax Applicability Code entered has already been used. 
 
Taxable  boolean  [0..1]  Is it taxable? 
Validation Description
Taxable field cannot be changed since the Tax Applicability is in use.   
 
Tax_Recoverability_Reference  Tax_RecoverabilityObject  [0..1]  Reference to the Tax Recoverability 
Validation Description
For a Tax Applicability that is non-taxable, you can only specify the Tax Recoverability that is Non Recoverable.  For a Tax Applicability that is non-taxable, you can only specify the Tax Recoverability that is Non Recoverable. 
 
top
 

Tax_ApplicabilityReferenceEnumeration

part of: Tax_ApplicabilityObjectID
Base Type
string
top
 

Tax_RecoverabilityReferenceEnumeration

part of: Tax_RecoverabilityObjectID
Base Type
string
top