Service Directory > v31.2 > Financial_Management > Get_Transaction_Tax_Codes
 

Operation: Get_Transaction_Tax_Codes

This service operation will get Transaction Tax Codes for the specified criteria. Transaction Tax codes group together multiple Transaction tax rates. For example, you could create a tax code for San Francisco, and include city, state, and county sales tax rates. Tax Code data includes the Tax Code ID, Tax Code Name, and the Tax Rate. 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_Codes_Request

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

Response Element: Get_Tax_Codes_Response

Element containing Tax Code 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_Code_Request_References  [0..1]  Get Tax Codes Request References   
Request_Criteria  Tax_Code_Request_Criteria  [0..1]  Get Tax Codes Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Tax Codes Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Tax_Code_Response_Group  [0..1]  Get Tax Codes Response Group   
Response_Results  Response_Results  [0..1]  Get Tax Codes Response Results   
Response_Data  Tax_Code_Response_Data  [0..1]  Get Tax Codes Response Data   
top
 

Tax_Code_Request_References

part of: Get_Tax_Codes_Request, Get_Tax_Codes_Response
Element containing reference instances for a Tax Code
 
Parameter name Type/Value Cardinality Description Validations
Tax_Code_Reference  Tax_CodeObject  [1..*]  This is the reference id value of the tax code. If this is blank, Workday will default in the default tax code from the invoice header if there is one. If the invoice line has a tax applicability value, Workday will validate that the invoice line also has a tax code.   
top
 

Tax_CodeObject

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

Tax_CodeObjectID

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

part of: Get_Tax_Codes_Request, Get_Tax_Codes_Response
Element containing Tax Code request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Tax_Codes_Request, Get_Tax_Codes_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_Code_Response_Group

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

Response_Results

part of: Get_Tax_Codes_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_Code_Response_Data

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

Tax_Code

part of: Tax_Code_Response_Data
Wrapper Element that includes Tax Code Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Code_Reference  Tax_CodeObject  [0..1]  This is the reference id value of the tax code. If this is blank, Workday will default in the default tax code from the invoice header if there is one. If the invoice line has a tax applicability value, Workday will validate that the invoice line also has a tax code.   
Tax_Code_Data  Tax_Code_Data  [0..1]  Tax Code Data 
Validation Description
Tax Code Country needs to be the same as all the Tax Rate Countries that are associated with this Tax Code.   
You can't change the Country because this tax code is already in use: [Tax Code].   
Withholding Tax Rates cannot be added to Transaction Tax Code.   
Tax Code must be of type Transaction Tax Code.   
The maximum number of transaction tax rates is 6 for all transaction tax codes.  The maximum number of transaction tax rates is 6 for all transaction tax codes. 
 
top
 

Tax_Code_Data

part of: Tax_Code
Element containing all Tax Code data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Code_ID  string  [0..1]  Tax Code ID. This is the Tax Code unique identifier   
Tax_Code_Name  string  [1..1]  Free form text field for a meaningful Tax Code Name 
Validation Description
Enter a unique Tax Code Name. [name] is already in use.  The Tax Code entered has already been used. 
 
Transaction_Tax_ID_Required  boolean  [0..1]  This indicator identifies that when this Tax Code is used within a transaction, the Company must have a Transaction Tax ID defined for the country associated with the Tax Code.   
Country_Reference  CountryObject  [1..1]  Reference to an existing Country   
Exempt [Choice]   boolean  [0..1]  Tax Exempt   
Tax_Rate_Reference  Tax_RateObject  [0..*]  Reference to an existing Tax Rate 
Validation Description
Tax Rate Reference is required if Tax Exempt is not true.  Tax Rate Reference is required if Tax Exempt is not true. 
 
Validation Description
Tax Code Country needs to be the same as all the Tax Rate Countries that are associated with this Tax Code.   
You can't change the Country because this tax code is already in use: [Tax Code].   
Withholding Tax Rates cannot be added to Transaction Tax Code.   
Tax Code must be of type Transaction Tax Code.   
The maximum number of transaction tax rates is 6 for all transaction tax codes.  The maximum number of transaction tax rates is 6 for all transaction tax codes. 
top
 

CountryObject

part of: Tax_Code_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_RateObject

part of: Tax_Code_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_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_CodeReferenceEnumeration

part of: Tax_CodeObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Tax_RateReferenceEnumeration

part of: Tax_RateObjectID
Base Type
string
top