Service Directory > v32.1 > Financial_Management > Get_Withholding_Tax_Item_Groups
 

Operation: Get_Withholding_Tax_Item_Groups

This service operation will get Withholding Tax Items Groups. Withholding Tax Items Groups data includes Tax Item Group ID, Name, and references to Type, Country and Item Descriptor. The request criteria can be for a single instance based on Reference, or all instances 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_Item_Groups_Request

Element containing Withholding Tax Items Groups response elements, including received references.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Withholding_Tax_Item_Group_Request_References  [0..1]  Element containing Withholding Tax Items Groups references.   
Response_Filter  Response_Filter  [0..1]  Element containing filter for Withholding Tax Items Groups. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Withholding_Tax_Item_Groups_Response

Element containing Withholding Tax Items Groups response elements, including received references.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Withholding_Tax_Item_Group_Request_References  [0..1]  Element containing Withholding Tax Items Group request references.   
Response_Filter  Response_Filter  [0..1]  Element containing Get Withholsing Tax Items Groups Response Response Filter. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Element containing Response Result for Withholding Tax Items Groups Response.   
Response_Data  Withholding_Tax_Item_Group_Response_Data  [0..1]  Element containing Withholding Tax Items Group Response data.   
top
 

Withholding_Tax_Item_Group_Request_References

part of: Get_Withholding_Tax_Item_Groups_Request, Get_Withholding_Tax_Item_Groups_Response
Element containing reference instances for a Withholding Tax Items Group.
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Tax_Item_Group_Reference  Withholding_Tax_Items_GroupObject  [1..*]  Withholding Tax Items Group Reference element content.   
top
 

Withholding_Tax_Items_GroupObject

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

Withholding_Tax_Items_GroupObjectID

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

Response_Results

part of: Get_Withholding_Tax_Item_Groups_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_Item_Group_Response_Data

part of: Get_Withholding_Tax_Item_Groups_Response
Element containing Withholding Tax Items Group response elements, including received references.
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Tax_Item_Group  Withholding_Tax_Items_Group  [0..*]  Element for Withholding Tax Items Group Instance reference and data.   
top
 

Withholding_Tax_Items_Group

part of: Withholding_Tax_Item_Group_Response_Data
Element for Withholding Tax Items Group Instance reference and data.
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Tax_Item_Group_Reference  Withholding_Tax_Items_GroupObject  [0..1]  Reference to an existing Withholding Tax Items Group element content.   
Withholding_Tax_Item_Group_Data  Tax_Items_Group_Data  [0..*]  Element containing Withholding Tax Items Group data. 
Validation Description
The items entered will create conflicts with other tax item groups in the following item rules: [Item Rules]   
 
top
 

Tax_Items_Group_Data

part of: Withholding_Tax_Items_Group
Element containing all Tax Items Group data.
 
Parameter name Type/Value Cardinality Description Validations
Tax_Items_Group_Data_ID  string  [0..1]  ID for Transaction Tax Items Group element content.   
Tax_Item_Group_Name  string  [1..1]  Tax Item Group Name element content.   
Tax_Items_Group_Type_Reference  Unique_IdentifierObject  [1..1]  Type for Tax Items Group element content. 
Validation Description
Tax Item Group Type does not match Item Descriptor Type.   
Cannot create a Withholding Tax Item Group with an Expense Item.   
 
Item_Descriptor_Reference  Item_DescriptorObject  [0..*]  Item Descriptor for Tax Items Group Data element content. 
Validation Description
You have at least 1 inactive item: [ITEM_DESCRIPTORS]. Enter an item that is active for the tax group.   
 
Validation Description
The items entered will create conflicts with other tax item groups in the following item rules: [Item Rules]   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Item_DescriptorObject

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

Item_DescriptorObjectID

part of: Item_DescriptorObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Catalog_Item_ID, Catalog_Load_Item_ID, Expense_Item_ID, Purchase_Item_ID, Sales_Item_ID, Supplier_Item_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_Items_GroupReferenceEnumeration

part of: Withholding_Tax_Items_GroupObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Item_DescriptorReferenceEnumeration

part of: Item_DescriptorObjectID
Base Type
string
top