Service Directory > v31.2 > Financial_Management > Put_Transaction_Tax_Rate
 

Operation: Put_Transaction_Tax_Rate

This service operation will add or update Transaction Tax Rates. Tax Rates designate a tax percentage to apply to a tax authority and tax category. For example, you can establish a rate for California State sales tax of 6%. Tax Rate data includes Tax Rate ID, Tax Rate Name, Tax Rate, Tax Authority and Tax Category.


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

Element containing Tax Rate reference for update and all Tax Rate data items
 
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.   
Tax_Rate_Reference  Tax_RateObject  [0..1]  Reference to an existing Tax Rate for update only purposes   
Tax_Rate_Data  Tax_Rate_Data  [1..1]  Tax Rate Data 
Validation Description
The Tax Authority must have a Tax Reporting Currency before you can define the tax rate.  The Tax Authority must have a Tax Reporting Currency before you can define the tax rate. 
You can't change the Country because this tax rate is already in use: [Tax Rate].  You can't change the Country because this tax rate is already in use. 
You can't change the Tax Category because this tax rate is already in use: [Tax Rate].  You can't change the Tax Category because this tax rate is already in use. 
You can't change the Tax Authority because this tax rate is already in use: [Tax Rate].  You can't change the Tax Authority field because this tax rate is already in use. 
Tax Rate must be of type Transaction Tax Rate.  Tax Rate must be of type Transaction Tax Rate. 
 
Validation Description
The Web Service is set to Add Only; but the Tax Rate already exists.   
top
 

Response Element: Put_Tax_Rate_Response

Element containing Put Tax Rate Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Tax_Rate_Reference  Tax_RateObject  [0..1]  Reference to an existing Tax Rate   
top
 

Tax_RateObject

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

Tax_RateObjectID

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

part of: Put_Tax_Rate_Request
Element containing all Tax Rate data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Rate_ID  string  [0..1]  Tax Rate ID. This is the Tax Rate unique identifier   
Tax_Rate_Name  string  [1..1]  Free form text field for a meaningful Tax Rate Name 
Validation Description
The Tax Rate Name is already in use: [name]  The Tax Rate entered has already been used. 
 
Country_Reference  CountryObject  [1..1]  Reference to an existing Country   
Tax_Rate  decimal (6, 3) >0   [0..1]  Numeric value of the Tax Rate   
Tax_Authority_Reference  Tax_AuthorityObject  [1..1]  Reference to an existing Tax Authority   
Tax_Category_Reference  Tax_CategoryObject  [1..1]  Reference to an existing Tax Category 
Validation Description
The Tax Category provided is not a Transaction Category. Please resubmit with a Transaction Tax Category.  The Tax Category must be Transaction Category. Please resubmit with a Transaction Tax Category. 
 
Validation Description
The Tax Authority must have a Tax Reporting Currency before you can define the tax rate.  The Tax Authority must have a Tax Reporting Currency before you can define the tax rate. 
You can't change the Country because this tax rate is already in use: [Tax Rate].  You can't change the Country because this tax rate is already in use. 
You can't change the Tax Category because this tax rate is already in use: [Tax Rate].  You can't change the Tax Category because this tax rate is already in use. 
You can't change the Tax Authority because this tax rate is already in use: [Tax Rate].  You can't change the Tax Authority field because this tax rate is already in use. 
Tax Rate must be of type Transaction Tax Rate.  Tax Rate must be of type Transaction Tax Rate. 
top
 

CountryObject

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

Tax_AuthorityObject

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

Tax_AuthorityObjectID

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

Tax_CategoryObject

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

Tax_CategoryObjectID

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

part of: Tax_RateObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Tax_AuthorityReferenceEnumeration

part of: Tax_AuthorityObjectID
Base Type
string
top
 

Tax_CategoryReferenceEnumeration

part of: Tax_CategoryObjectID
Base Type
string
top