Service Directory > v32.1 > Financial_Management > Get_Tax_Recoverabilities
 

Operation: Get_Tax_Recoverabilities

This operation will return Tax Recoverability 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_Tax_Recoverabilities_Request

Element containing Get Tax Recoverabilities Request information
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Tax_Recoverability_Request_References  [0..1]  Element containing Tax Recoverability Object Request references.   
Request_Criteria [Choice]   Tax_Recoverability_Request_Criteria  [0..1]  Element containing Tax Recoverability Object criteria.   
Response_Filter  Response_Filter  [0..1]  Element containing filter for Tax Recoverability Objects. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Tax_Recoverability_Response_Group  [0..1]  Element for Tax Recoverability Object instance reference and data.   
top
 

Response Element: Get_Tax_Recoverabilities_Response

Element containing Tax Recoverability 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  Tax_Recoverability_Request_References  [0..1]  Element containing references to a Tax Recoverability.   
Request_Criteria  Tax_Recoverability_Request_Criteria  [0..1]  Element containing Tax Recoverability 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  Tax_Recoverability_Response_Group  [0..1]  Element for Tax Recoverability Instance 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  Tax_Recoverability_Response_Data  [0..1]  Element containing Tax Recoverability Response Data   
top
 

Tax_Recoverability_Request_References

part of: Get_Tax_Recoverabilities_Request, Get_Tax_Recoverabilities_Response
Element containing references to a Tax Recoverability.
 
Parameter name Type/Value Cardinality Description Validations
Tax_Recoverability_Reference  Tax_RecoverabilityObject  [1..*]  Element containing reference instances for a Tax Recoverability Object.   
top
 

Tax_RecoverabilityObject

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

Tax_RecoverabilityObjectID

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

part of: Get_Tax_Recoverabilities_Request, Get_Tax_Recoverabilities_Response
Element containing Tax Recoverability Criteria.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Tax_Recoverabilities_Request, Get_Tax_Recoverabilities_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_Recoverability_Response_Group

part of: Get_Tax_Recoverabilities_Request, Get_Tax_Recoverabilities_Response
Element for Tax Recoverability 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 Tax Recoverability Object will be included in the response.   
top
 

Response_Results

part of: Get_Tax_Recoverabilities_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_Recoverability_Response_Data

part of: Get_Tax_Recoverabilities_Response
Element containing Tax Recoverability Response Data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Recoverability  Tax_Recoverability  [0..*]  Tax Recoverability.   
top
 

Tax_Recoverability

part of: Tax_Recoverability_Response_Data
Tax Recoverability.
 
Parameter name Type/Value Cardinality Description Validations
Tax_Recoverability_Reference  Tax_RecoverabilityObject  [0..1]  Tax Recoverability Object Reference.   
Tax_Recoverability_Data  Tax_Recoverability_Data  [0..*]  Element containing data for the Tax Recoverability.   
top
 

Tax_Recoverability_Data

part of: Tax_Recoverability
Element containing data for the Tax Recoverability.
 
Parameter name Type/Value Cardinality Description Validations
Tax_Recoverability_Object_ID  string  [0..1]  Reference ID   
Tax_Recoverability_Name  string  [1..1]  Tax Recoverability Name 
Validation Description
The Tax Recoverability Name is already in use: [name]   
 
Tax_Recoverability_Reference  Tax_Recoverability_TypeObject  [1..1]  Tax Recoverability Object 
Validation Description
Tax Recoverability Type cannot be changed since the Tax Recoverability is in use.  Tax Recoverability Type cannot be changed since the Tax Recoverability is in use. 
 
Recoverable_Percentage  decimal (6, 3) >0   [0..1]  If the Tax Recoverability is Partial, then enter the Percentage that is recoverable. 
Validation Description
Percentage entered must be between 0 to 100%.  Percentage entered must be between 0 to 100%. 
Tax Recoverability Percentage cannot be changed since the Tax Applicability is in use.  Tax Recoverability Percentage cannot be changed since the Tax Applicability is in use. 
Partial Tax Recoverability Percentage can only be entered if the Tax Recoverability is Partially Recoverable.  Partial Tax Recoverability Percentage can only be entered if the Tax Recoverability is Partially Recoverable. 
 
Allocate_Nonrecoverable_Tax  boolean  [0..1]  Allocate Nonrecoverable Tax? 
Validation Description
Allocate Non-Recoverable Tax cannot be changed since the Tax Recoverability is in use.  Allocate Non-Recoverable Tax cannot be changed since the Tax Recoverability is in use. 
 
Use_Company_Recovery_Pro_Rata_Factor  boolean  [0..1]  Use Company Recovery Pro Rata Factor? 
Validation Description
Use Company Recovery Pro Rata Factor cannot be changed since the Tax Recoverability is in use.  Use Company Recovery Pro Rata Factor cannot be changed since the Tax Recoverability is in use. 
Use Company Recovery Pro Rata Factor cannot be set to True when Tax Recoverability is Non-Recoverable.  Use Company Recovery Pro Rata Factor cannot be set to True when Tax Recoverability is Non-Recoverable. 
 
top
 

Tax_Recoverability_TypeObject

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

Tax_Recoverability_TypeObjectID

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

part of: Tax_RecoverabilityObjectID
Base Type
string
top
 

Tax_Recoverability_TypeReferenceEnumeration

part of: Tax_Recoverability_TypeObjectID
Base Type
string
top