Service Directory > v31.2 > Financial_Management > Get_Withholding_Tax_Status
 

Operation: Get_Withholding_Tax_Status

This service operation will get all Withholding Tax Statuses for the specified criteria. Withholding Tax Status data includes Withholding Tax Status ID, Name, Description and Resident flag. 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_Status_Request

Contains request reference, criteria, filter and response group for getting Withholding Tax Status data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Withholding_Tax_Status_Request_References  [0..1]  Element containing reference instances for a Withholding Tax Status   
Request_Criteria [Choice]   Withholding_Tax_Status_Request_Criteria  [0..1]  Element containing Withholding Tax Status 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  Withholding_Tax_Status_Response_Group  [0..1]  Element containing Withholding Tax Status response grouping options.   
top
 

Response Element: Get_Withholding_Tax_Status_Response

Element containing Withholding Tax Status response elements including received criteria, references, and data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Withholding_Tax_Status_Request_References  [0..1]  Element containing reference instances for a Withholding Tax Status   
Request_Criteria  Withholding_Tax_Status_Request_Criteria  [0..1]  Element containing Withholding Tax Status 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  Withholding_Tax_Status_Response_Group  [0..1]  Element containing Withholding Tax Status response grouping options.   
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_Status_Response_Data  [0..1]  Wrapper Element that included Withholding Tax Status Instance and Data.   
top
 

Withholding_Tax_Status_Request_References

part of: Get_Withholding_Tax_Status_Request, Get_Withholding_Tax_Status_Response
Element containing reference instances for a Withholding Tax Status
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Tax_Status_Reference  Withholding_Tax_StatusObject  [1..*]  Reference to an existing Withholding Tax Status for update only purposes   
top
 

Withholding_Tax_StatusObject

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

Withholding_Tax_StatusObjectID

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

part of: Get_Withholding_Tax_Status_Request, Get_Withholding_Tax_Status_Response
Element containing Withholding Tax Status request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Withholding_Tax_Status_Request, Get_Withholding_Tax_Status_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_Status_Response_Group

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

Response_Results

part of: Get_Withholding_Tax_Status_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_Status_Response_Data

part of: Get_Withholding_Tax_Status_Response
Wrapper Element that included Withholding Tax Status Instance and Data.
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Tax_Status  Withholding_Tax_Status  [0..*]  Wrapper Element that includes Withholding Tax Status Instance and Data   
top
 

Withholding_Tax_Status

part of: Withholding_Tax_Status_Response_Data
Wrapper Element that includes Withholding Tax Status Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Tax_Status_Reference  Withholding_Tax_StatusObject  [0..1]  Reference to an existing Withholding Tax Status for update only purposes   
Withholding_Tax_Status_Data  Withholding_Tax_Status_Data  [0..1]  Withholding Tax Status Data   
top
 

Withholding_Tax_Status_Data

part of: Withholding_Tax_Status
Element containing all Withholding Tax Status Tax data
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Tax_Status_ID  string  [0..1]  Withholding Tax Status ID. This is the Withholding Tax Status unique identifier.   
Name  string  [0..1]  Free form text field for a meaningful Withholding Tax Status Name. Withholding Status Name must be unique   
Description  string  [0..1]  Free form text field for a Withholding Tax Status Description   
top
 

Withholding_Tax_StatusReferenceEnumeration

part of: Withholding_Tax_StatusObjectID
Base Type
string
top