Service Directory > v32.1 > Financial_Management > Get_Transaction_Tax_Rates
 

Operation: Get_Transaction_Tax_Rates

This service operation will get Tax Rates for the specified criteria. Tax Rates designate a tax percentage to apply to a tax authority and tax category. For example, you can establish a rate for California State sales tax of 6%. Tax Rate data includes Tax Rate ID, Tax Rate Name, Tax Rate, Tax Authority and Tax Category. 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_Rates_Request

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

Response Element: Get_Tax_Rates_Response

Element containing Tax Rate 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_Rate_Request_References  [0..1]  Get Tax Rates Request References   
Request_Criteria  Tax_Rate_Request_Criteria  [0..1]  Get Tax Rates Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Tax Rates Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Tax_Rate_Response_Group  [0..1]  Get Tax Rates Response Group   
Response_Results  Response_Results  [0..1]  Get Tax Rates Response Results   
Response_Data  Tax_Rate_Response_Data  [0..1]  Get Tax Rates Response Data   
top
 

Tax_Rate_Request_References

part of: Get_Tax_Rates_Request, Get_Tax_Rates_Response
Element containing reference instances for a Tax Rate
 
Parameter name Type/Value Cardinality Description Validations
Tax_Rate_Reference  Tax_RateObject  [1..*]  Reference to an existing Tax Rate   
top
 

Tax_RateObject

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

Tax_RateObjectID

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

part of: Get_Tax_Rates_Request, Get_Tax_Rates_Response
Element containing Tax Rate request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Tax_Rates_Request, Get_Tax_Rates_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_Rate_Response_Group

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

Response_Results

part of: Get_Tax_Rates_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_Rate_Response_Data

part of: Get_Tax_Rates_Response
Wrapper Element that includes Tax Rate Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Rate  Tax_Rate  [0..*]  Reference to Line Tax Rate   
top
 

Tax_Rate

part of: Tax_Rate_Response_Data
Wrapper Element that includes Tax Rate Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Rate_Reference  Tax_RateObject  [0..1]  Reference to an existing Tax Rate   
Tax_Rate_Data  Tax_Rate_Data  [0..1]  Tax Rate Data 
Validation Description
The Tax Authority must have a Tax Reporting Currency before you can define the tax rate.  The Tax Authority must have a Tax Reporting Currency before you can define the tax rate. 
You can't change the Country because this tax rate is already in use: [Tax Rate].  You can't change the Country because this tax rate is already in use. 
You can't change the Tax Category because this tax rate is already in use: [Tax Rate].  You can't change the Tax Category because this tax rate is already in use. 
You can't change the Tax Authority because this tax rate is already in use: [Tax Rate].  You can't change the Tax Authority field because this tax rate is already in use. 
Tax Rate must be of type Transaction Tax Rate.  Tax Rate must be of type Transaction Tax Rate. 
Specify at least one effective date on this tax rate : [Tax Rate].   
 
top
 

Tax_Rate_Data

part of: Tax_Rate
Element containing all Tax Rate data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Rate_ID  string  [0..1]  Tax Rate ID. This is the Tax Rate unique identifier   
Tax_Rate_Name  string  [1..1]  Free form text field for a meaningful Tax Rate Name 
Validation Description
The Tax Rate Name is already in use: [name]  The Tax Rate entered has already been used. 
 
Country_Reference  CountryObject  [1..1]  Reference to an existing Country   
Tax_Authority_Reference  Tax_AuthorityObject  [1..1]  Reference to an existing Tax Authority   
Tax_Category_Reference  Tax_CategoryObject  [1..1]  Reference to an existing Tax Category 
Validation Description
The Tax Category provided is not a Transaction Category. Please resubmit with a Transaction Tax Category.  The Tax Category must be Transaction Category. Please resubmit with a Transaction Tax Category. 
 
Effective_Transaction_Tax_Rate_Data  Effective_Transaction_Tax_Rate_Data  [0..*]  Data to effective date the Tax Rate. 
Validation Description
You can't change the Tax Rate percentage because this tax rate percentage is already in use: [Tax Rate] , Effective Date : [Effective Date]  You can't change the Tax Rate percentage because this tax rate percentage is already in use. 
Enter a unique effective date [Effective Date] for the [Tax Rate].  Enter a unique effective date. 
Effective Date is required.  Effective Date is required. 
 
Validation Description
The Tax Authority must have a Tax Reporting Currency before you can define the tax rate.  The Tax Authority must have a Tax Reporting Currency before you can define the tax rate. 
You can't change the Country because this tax rate is already in use: [Tax Rate].  You can't change the Country because this tax rate is already in use. 
You can't change the Tax Category because this tax rate is already in use: [Tax Rate].  You can't change the Tax Category because this tax rate is already in use. 
You can't change the Tax Authority because this tax rate is already in use: [Tax Rate].  You can't change the Tax Authority field because this tax rate is already in use. 
Tax Rate must be of type Transaction Tax Rate.  Tax Rate must be of type Transaction Tax Rate. 
Specify at least one effective date on this tax rate : [Tax Rate].   
top
 

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [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_AuthorityObject

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

Tax_AuthorityObjectID

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

Tax_CategoryObject

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

Effective_Transaction_Tax_Rate_Data

part of: Tax_Rate_Data
Effective Transaction Tax Rate Data
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  The date the snapshot comes into effect.   
Tax_Rate_Percentage  decimal (6, 3) >0   [0..1]  The Tax Rate Percentage for the snapshot.   
Validation Description
You can't change the Tax Rate percentage because this tax rate percentage is already in use: [Tax Rate] , Effective Date : [Effective Date]  You can't change the Tax Rate percentage because this tax rate percentage is already in use. 
Enter a unique effective date [Effective Date] for the [Tax Rate].  Enter a unique effective date. 
Effective Date is required.  Effective Date is required. 
top
 

Tax_RateReferenceEnumeration

part of: Tax_RateObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Tax_AuthorityReferenceEnumeration

part of: Tax_AuthorityObjectID
Base Type
string
top
 

Tax_CategoryReferenceEnumeration

part of: Tax_CategoryObjectID
Base Type
string
top