Service Directory > v31.2 > Financial_Management > Put_VAT_Group
 

Operation: Put_VAT_Group

This service operation will add or update 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: Put_VAT_Group_Request

Put VAT Group Request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
VAT_Group_Reference  VAT_GroupObject  [0..1]  The reference to the VAT Group being updated. For new VAT Groups, this element will not exist.   
VAT_Group_Data  VAT_Group_Data  [1..1]  The wrapper element for VAT Group data.   
Validation Description
This Web Service is set to Add Only; but the VAT Group already exists.   
top
 

Response Element: Put_VAT_Group_Response

Put VAT Group Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
VAT_Group_Reference  VAT_GroupObject  [0..1]  VAT Group Reference   
top
 

VAT_GroupObject

part of: Put_VAT_Group_Request, Put_VAT_Group_Response
 
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_Data

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