Service Directory > v31.2 > Financial_Management > Get_Withholding_Tax_Exemptions
 

Operation: Get_Withholding_Tax_Exemptions

This operation will return Withholding Tax Exemption Objects.


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

Element containing Withholding Tax Exemptions Request information.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Withholding_Tax_Exemption_Request_References  [0..1]  Element containing Withholding Tax Exemption Request references.   
Request_Criteria [Choice]   Withholding_Tax_Exemption_Request_Criteria  [0..1]  Element containing Withholding Tax Exemption criteria.   
Response_Filter  Response_Filter  [0..1]  Element containing filter criteria for Withholding Tax Exemptions. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Withholding_Tax_Exemption_Response_Group  [0..1]  Element for Withholding Tax Exemption reference and data.   
top
 

Response Element: Get_Withholding_Tax_Exemptions_Response

Element containing Withholding Tax Exemption response elements including received criteria, references, data based on criteria and grouping, result filter and result summary.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Withholding_Tax_Exemption_Request_References  [0..1]  Element containing references to a Withholding Tax Exemption.   
Request_Criteria  Withholding_Tax_Exemption_Request_Criteria  [0..1]  Element containing Withholding Tax Exemption 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  Withholding_Tax_Exemption_Response_Group  [0..1]  Element for Withholding Tax Exemption reference and data.   
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  Withholding_Tax_Exemption_Response_Data  [0..1]  Element containing Withholding Tax Exemption Data.   
top
 

Withholding_Tax_Exemption_Request_References

part of: Get_Withholding_Tax_Exemptions_Response, Get_Withholding_Tax_Exemptions_Request
Element containing references to a Withholding Tax Exemption.
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Tax_Exemption_Reference  Withholding_Tax_ExemptionObject  [1..*]  Reference to a Withholding Tax Exemption.   
top
 

Withholding_Tax_ExemptionObject

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

Withholding_Tax_ExemptionObjectID

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

part of: Get_Withholding_Tax_Exemptions_Response, Get_Withholding_Tax_Exemptions_Request
Withholding Tax Exemption Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Supplier_Reference  Resource_ProviderObject  [0..1]  Reference for a Supplier to filter on.   
Tax_Exemption_Name  string  [0..1]  Withholding Tax Exemption Name to filter on.   
Tax_Exemption_Number  string  [0..1]  Withholding Tax Exemption Number to filter on.   
Affected_Tax_Rate_Reference  Tax_RateObject  [0..1]  Withholding Tax Exemption Tax Rate to filter on.   
top
 

Resource_ProviderObject

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

Resource_ProviderObjectID

part of: Resource_ProviderObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Supplier_ID, Supplier_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_RateObject

part of: Withholding_Tax_Exemption_Data, Withholding_Tax_Exemption_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_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
 

Response_Filter

part of: Get_Withholding_Tax_Exemptions_Response, Get_Withholding_Tax_Exemptions_Request
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_Exemption_Response_Group

part of: Get_Withholding_Tax_Exemptions_Response, Get_Withholding_Tax_Exemptions_Request
Element for Withholding Tax Exemption Instance reference and data.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  If the Include Reference is true, the reference to the requested Withholding Tax Exemption will be included in the response.   
top
 

Response_Results

part of: Get_Withholding_Tax_Exemptions_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_Exemption_Response_Data

part of: Get_Withholding_Tax_Exemptions_Response
Element containing Withholding Tax Exemption Response Data
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Tax_Exemption  Withholding_Tax_Exemption  [0..*]  Element containing Withholding Tax Exemption reference and data.   
top
 

Withholding_Tax_Exemption

part of: Withholding_Tax_Exemption_Response_Data
Withholding Tax Exemption
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Tax_Exemption_Reference  Withholding_Tax_ExemptionObject  [0..1]  Withholding Tax Exemption Reference.   
Withholding_Tax_Exemption_Data  Withholding_Tax_Exemption_Data  [0..*]  Element containing data for the Withholding Tax Exemption. 
Validation Description
You can't change the Supplier, Tax Rate, Effective Tax Percentage, Start Date, or End Date because this tax exemption is already in use: [Tax Exemption].   
 
top
 

Withholding_Tax_Exemption_Data

part of: Withholding_Tax_Exemption
Put Withholding Tax Exemption Request
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Tax_Exemption_ID  string  [0..1]  Withholding Tax Exemption Reference ID   
Supplier_Reference  Resource_ProviderObject  [1..1]  Supplier for the Withholding Tax Exemption. 
Validation Description
Enter a valid Supplier.   
 
Tax_Exemption_Name  string  [1..1]  Withholding Tax Exemption Name.   
Tax_Exemption_Number  string  [0..1]  Withholding Tax Exemption Number.   
Affected_Tax_Rate_Reference  Tax_RateObject  [0..1]  Withholding Tax Rate for which the Withholding Tax Exemption applies to. 
Validation Description
Enter a Withholding Tax Rate that does not have Progressive Rate Threshholds.   
Withholding Tax Exemptions don't apply on Withholding Tax Rates with a realization point of Customer Invoice Self Withholding.   
 
Effective_Tax_Percentage  decimal (7, 4) >0   [0..1]  The effective tax percentage that will override the Withholding Tax Rate after the Withholding Tax Exemption is applied. 
Validation Description
Enter an Effective Tax Rate Percentage after exemption that is between 0% and 100%.   
 
Tax_Exemption_Start_Date  date  [0..1]  Date on which the Withholding Tax Exemption begins effect. 
Validation Description
Enter an Exemption Start Date that is before the Exemption End Date.   
You have more than 1 active withholding tax exemption for the same withholding tax rate(s); enter only 1 withholding tax exemption for a specified effective date range.   
 
Tax_Exemption_End_Date  date  [0..1]  Date for which the Withholding Tax Exemption stops effect. 
Validation Description
Enter an Exemption Start Date that is before the Exemption End Date.   
You have more than 1 active withholding tax exemption for the same withholding tax rate(s); enter only 1 withholding tax exemption for a specified effective date range.   
 
Inactive  boolean  [0..1]  Inactive Tax Exemption denotes whether or not the Withholding Tax Exemption is inactive.   
Validation Description
You can't change the Supplier, Tax Rate, Effective Tax Percentage, Start Date, or End Date because this tax exemption is already in use: [Tax Exemption].   
top
 

Withholding_Tax_ExemptionReferenceEnumeration

part of: Withholding_Tax_ExemptionObjectID
Base Type
string
top
 

Resource_ProviderReferenceEnumeration

part of: Resource_ProviderObjectID
Base Type
string
top
 

Tax_RateReferenceEnumeration

part of: Tax_RateObjectID
Base Type
string
top