Service Directory > v32.1 > Financial_Management > Get_Withholding_Tax_Codes
 

Operation: Get_Withholding_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 Transaction Tax Code for San Francisco, and include city, state, and county sales Transaction Tax Rates. Transaction 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_Withholding_Tax_Codes_Request

Get Withholding Tax Codes Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Withholding_Tax_Code_Request_References  [0..1]  Withholding Tax Code Request References   
Request_Criteria [Choice]   Withholding_Tax_Code_Request_Criteria  [0..1]  Withholding Tax Code Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Withholding_Tax_Code_Response_Group  [0..1]  Withholding Tax Code Response Group   
top
 

Response Element: Get_Withholding_Tax_Codes_Response

Get Withholding Tax Codes Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Withholding_Tax_Code_Request_References  [0..1]  Withholding Tax Code Request References   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Withholding_Tax_Code_Response_Data  [0..1]  Withholding Tax Code Response Data   
top
 

Withholding_Tax_Code_Request_References

part of: Get_Withholding_Tax_Codes_Request, Get_Withholding_Tax_Codes_Response
Withholding Tax Code Request References
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Tax_Code_Reference  Tax_CodeObject  [1..*]  Withholding Tax Code Request References   
top
 

Tax_CodeObject

part of: Withholding_Tax_Code_Request_References, Withholding_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
 

Withholding_Tax_Code_Request_Criteria

part of: Get_Withholding_Tax_Codes_Request
Withholding Tax Code Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Withholding_Tax_Codes_Request, Get_Withholding_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
 

Withholding_Tax_Code_Response_Group

part of: Get_Withholding_Tax_Codes_Request
Withholding Tax Code Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Withholding_Tax_Code_Response_Data

part of: Get_Withholding_Tax_Codes_Response
Withholding Tax Code Response Data
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Tax_Code  Withholding_Tax_Code  [0..*]  Withholding Tax Code   
top
 

Withholding_Tax_Code

part of: Withholding_Tax_Code_Response_Data
Withholding Tax Code
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Tax_Code_Reference  Tax_CodeObject  [0..1]  Tax Code Reference   
Withholding_Tax_Code_Data  Withholding_Tax_Code_Data  [0..*]  Withholding Tax Code Data 
Validation Description
Tax Rates cannot be assigned to a Tax Code with a different Country.  Tax Rates cannot be assigned to a Tax Code with a different Country. 
Cannot mix gross tax type tax rates with net or tax type tax rates in a Tax Code  Cannot mix gross tax type tax rates with net or tax type tax rates in a Tax Code 
Invoice and payment realization types tax rates cannot both be part of a tax code  Invoice and payment realization types tax rates cannot both be part of a tax code 
You can't change the Country because this tax code is already in use: [Tax Code].   
 
top
 

Withholding_Tax_Code_Data

part of: Withholding_Tax_Code
Withholding Tax Code Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID   
Tax_Code_Name  string  [1..1]  Tax Code Name 
Validation Description
Enter a unique Tax Code Name. [name] is already in use.   
 
Country_Reference  CountryObject  [1..1]  Country Reference   
Tax_Rate_Reference  Tax_RateObject  [1..*]  Tax Rate Reference   
Validation Description
Tax Rates cannot be assigned to a Tax Code with a different Country.  Tax Rates cannot be assigned to a Tax Code with a different Country. 
Cannot mix gross tax type tax rates with net or tax type tax rates in a Tax Code  Cannot mix gross tax type tax rates with net or tax type tax rates in a Tax Code 
Invoice and payment realization types tax rates cannot both be part of a tax code  Invoice and payment realization types tax rates cannot both be part of a tax code 
You can't change the Country because this tax code is already in use: [Tax Code].   
top
 

CountryObject

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