Service Directory > v31.2 > Financial_Management > Get_VAT_Groups
 

Operation: Get_VAT_Groups

This operation will return VAT Groups


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

Element containing Get VAT Group Request information.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   VAT_Group_Request_References  [0..1]  Element containing VAT Group references.   
Request_Criteria [Choice]   VAT_Group_Request_Criteria  [0..1]  Element containing VAT Group criteria.   
Response_Filter  Response_Filter  [0..1]  Element containing filter for VAT Groups. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  VAT_Group_Response_Group  [0..1]  Element for VAT Group Instance reference and data.   
top
 

Response Element: Get_VAT_Groups_Response

Element containing VAT Group response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  VAT_Group_Request_References  [0..1]     
Request_Criteria  VAT_Group_Request_Criteria  [0..1]  Element containing criteria for VAT Group request.   
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  VAT_Group_Response_Group  [0..1]  VAT Group Response Group   
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  VAT_Group_Response_Data  [0..1]  Element containing VAT Group Response Data.   
top
 

VAT_Group_Request_References

part of: Get_VAT_Groups_Request, Get_VAT_Groups_Response
 
Parameter name Type/Value Cardinality Description Validations
VAT_Group_Reference  VAT_GroupObject  [1..*]  Element containing reference instances for a VAT Group.   
top
 

VAT_GroupObject

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

VAT_GroupObjectID

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

VAT_Group_Request_Criteria

part of: Get_VAT_Groups_Request, Get_VAT_Groups_Response
Element containing criteria for VAT Group request.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_VAT_Groups_Request, Get_VAT_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
 

VAT_Group_Response_Group

part of: Get_VAT_Groups_Request, Get_VAT_Groups_Response
VAT Group Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  If the Include Reference is true, the reference to the requested VAT Group will be included in the response.   
top
 

Response_Results

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

VAT_Group_Response_Data

part of: Get_VAT_Groups_Response
Element containing VAT Group Response Data.
 
Parameter name Type/Value Cardinality Description Validations
VAT_Group  VAT_Group  [0..*]  VAT Group   
top
 

VAT_Group

part of: VAT_Group_Response_Data
VAT Group
 
Parameter name Type/Value Cardinality Description Validations
VAT_Group_Reference  VAT_GroupObject  [0..1]  VAT Group Reference   
VAT_Group_Data  VAT_Group_Data  [0..*]  Element containing data for VAT Group   
top
 

VAT_Group_Data

part of: VAT_Group
Element containing data for VAT Group
 
Parameter name Type/Value Cardinality Description Validations
VAT_Group_ID  string  [0..1]  Reference ID   
VAT_Group_Name  string  [1..1]  VAT Group Name 
Validation Description
Enter a VAT Group Name that is unique within a Country and not already in use.  Enter a VAT Group Name that is unique within a Country and not already in use. 
 
Country_Reference  CountryObject  [1..1]  VAT Group Country   
Company__Nonsingular__Reference  CompanyObject  [0..*]  Companies to assign to VAT Group 
Validation Description
A Company can be in only one VAT Group per Country.  A Company can be in only one VAT Group per Country. 
You've only selected 1 company. Select at least 2 companies to a VAT Group.  You've only selected 1 company. Select at least 2 companies to a VAT Group. 
 
top
 

CountryObject

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

CompanyObject

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

CompanyObjectID

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

VAT_GroupReferenceEnumeration

part of: VAT_GroupObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top