Service Directory > v32.1 > Financial_Management > Put_Withholding_Tax_Rate
 

Operation: Put_Withholding_Tax_Rate

Support of Automation for Put Withholding Tax Rate V29.0


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

Put Withholding Tax Rate 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.   
Withholding_Tax_Rate_Reference  Tax_RateObject  [0..1]  The reference to the Tax Rate being updated. For new Tax Rates, this element will not exist.   
Withholding_Tax_Rate_Data  Withholding_Tax_Rate_Data  [0..1]  The wrapper element for Tax Rate data 
Validation Description
You can't change the Country because this tax rate is already in use: [Tax Rate].   
You can't change the Tax Base Percentage because this tax rate is already in use: [Tax Rate].   
You can't change the Tax Base Type because this tax rate is already in use: [Tax Rate].   
You can't change the Realization Point 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: [Tax Rate].   
You can't change the Tax Authority because this tax rate is already in use: [Tax Rate].   
You must specify a Rate Type.   
You can't specify both Single and Progressive Rate types.   
You can't specify both Individual and Accumulated for Threshold Type.   
You can't specify the Progressive Rate when you select Single for the Rate Type.   
You can't specify the Threshold Rule for No Threshold Rate type.   
Threshold-based rates may only be specified for a Tax Base type of Net.   
You can't change the Threshold Type because this tax rate is already in use: [Tax Rate].   
You must specify Withholding Tax Threshold Data if you specify Individual or Accumulated Threshold.   
You must specify No Threshold, Individual Threshold, or Accumulated Threshold.   
You can't specify more than one of No Threshold, Individual Threshold, and Accumulated Threshold.   
Specify at least one effective date on this tax rate : [Tax Rate].   
You can't clear the Include In Progess for Accumulation check box because the tax rate is already in use.   
You can't change the Accumulation Schedule because the tax rate is already in use.   
When you change the Threshold Type, you must submit all effective date configurations for the tax rate.   
When you change the Tax Base Type, you must submit all effective date configurations for the tax rate.   
When you change the Fiscal Schedule, you must submit all effective date configurations for the tax rate.   
When you change the Realization Point, you must submit all effective date configurations for the tax rate.   
 
Validation Description
The web service is set to add only, but the Withholding Tax Rate already exists.   
top
 

Response Element: Put_Withholding_Tax_Rate_Response

Put Withholding Tax Rate Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Withholding_Tax_Rate_Reference  Tax_RateObject  [0..1]  Withholding Tax Rate Reference   
top
 

Tax_RateObject

part of: Put_Withholding_Tax_Rate_Request, Put_Withholding_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
 

Withholding_Tax_Rate_Data

part of: Put_Withholding_Tax_Rate_Request
Container for Withholding Tax Rate data.
 
Parameter name Type/Value Cardinality Description Validations
Tax_Rate_ID  string  [0..1]  Reference ID   
Tax_Rate_Name  string  [1..1]  Tax Rate Name 
Validation Description
The Tax Rate Name is already in use: [name]   
 
Country_Reference  CountryObject  [1..1]  Country for the Tax Rate   
Tax_Authority_Reference  Tax_AuthorityObject  [1..1]  Tax Authority   
Tax_Category_Reference  Tax_CategoryObject  [1..1]  Tax Category 
Validation Description
The Tax Category provided is not marked as Withholding. Please resubmit with a Withholding Tax Category.   
 
Realization_Point_Reference  Realization_PointObject  [1..1]  Realization Point   
Tax_Base_Type_Reference  Tax_Base__TypeObject  [1..1]  Tax Base Type   
Tax_Base_Percentage  decimal (6, 3) >0   [0..1]  Tax Base Percentage 
Validation Description
The Tax Base Percentage must be between 0 and 100.   
 
Is_Single_Rate_Type  boolean  [0..1]  Is Singular Rate   
Is_Progressive_Rate_Type  boolean  [0..1]  Is Progressive Rate   
Is_No_Threshold  boolean  [0..1]  Is No Threshold   
Is_Individual_Threshold  boolean  [0..1]  Is Individual Threshold   
Is_Accumulated_Threshold  boolean  [0..1]  Is Accumulated Threshold   
Fiscal_Schedule_Reference  Fiscal_ScheduleObject  [0..1]  Fiscal Schedule Reference   
Include_In_Progress_for_Accumulation  boolean  [0..1]  Whether In Progress Invoices/Submissions are included in Withholding Tax Accumulation.   
Effective_Withholding_Tax_Data  Effective_Dated_Withholding_Tax_WS_Data  [0..*]  Container for Effective Dated Withholding Tax Data 
Validation Description
The field Effective Date must have an entry equal to the start of the accumulation period.   
Enter a unique effective date [Effective Date] for the [Tax Rate].  Enter a unique effective date. 
Enter an Effective Date in a valid fiscal period because a fiscal period doesn't exist for this Effective Date : [Effective Date].   
Select a minimum of 2 tiers for Progressive Rates.   
You can't change the Single Rate Percentage because the Tax Rate is used in a Tax code.   
You can't change the Progressive Rate because the Tax Rate is used in a Tax code.   
You must specify the Progressive Tier Rate when you select Progressive for the Rate Type.   
Single Rate Percentage cannot be used with Progressive Rate Tier Rules   
 
Validation Description
You can't change the Country because this tax rate is already in use: [Tax Rate].   
You can't change the Tax Base Percentage because this tax rate is already in use: [Tax Rate].   
You can't change the Tax Base Type because this tax rate is already in use: [Tax Rate].   
You can't change the Realization Point 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: [Tax Rate].   
You can't change the Tax Authority because this tax rate is already in use: [Tax Rate].   
You must specify a Rate Type.   
You can't specify both Single and Progressive Rate types.   
You can't specify both Individual and Accumulated for Threshold Type.   
You can't specify the Progressive Rate when you select Single for the Rate Type.   
You can't specify the Threshold Rule for No Threshold Rate type.   
Threshold-based rates may only be specified for a Tax Base type of Net.   
You can't change the Threshold Type because this tax rate is already in use: [Tax Rate].   
You must specify Withholding Tax Threshold Data if you specify Individual or Accumulated Threshold.   
You must specify No Threshold, Individual Threshold, or Accumulated Threshold.   
You can't specify more than one of No Threshold, Individual Threshold, and Accumulated Threshold.   
Specify at least one effective date on this tax rate : [Tax Rate].   
You can't clear the Include In Progess for Accumulation check box because the tax rate is already in use.   
You can't change the Accumulation Schedule because the tax rate is already in use.   
When you change the Threshold Type, you must submit all effective date configurations for the tax rate.   
When you change the Tax Base Type, you must submit all effective date configurations for the tax rate.   
When you change the Fiscal Schedule, you must submit all effective date configurations for the tax rate.   
When you change the Realization Point, you must submit all effective date configurations for the tax rate.   
top
 

CountryObject

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

Realization_PointObject

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

Realization_PointObjectID

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

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

Tax_Base__TypeObjectID

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

Fiscal_ScheduleObject

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

Fiscal_ScheduleObjectID

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

Effective_Dated_Withholding_Tax_WS_Data

part of: Withholding_Tax_Rate_Data
Container for Effective Dated Withholding Tax Data
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  The date the snapshot comes into effect.   
Tax_Rate  decimal (6, 3) >0   [0..1]  Numeric value of the Tax Rate 
Validation Description
Tax Base Percentage must be less than or equal to 100.   
 
Withholding_Tax_Rate_Threshold_Rule_Data  Withholding_Tax_Rate_Threshold_Rule_Data  [0..1]  Container for Withholding Tax Rate Threshhold Data 
Validation Description
Rate Threshold Amount cannot be specified for Payment Realization Point rates.  Rate Threshold Amount cannot be specified for Payment Realization Point rates. 
You can specify the Rate Threshold Amount only for Accumulated Threshold Type.  You can specify the Rate Threshold Amount only for Accumulated Threshold Type. 
Transaction Threshold Amount is required for Individual Threshold Tax Rates and Payment Realization Point.  Transaction Threshold Amount is required for Individual Threshold Tax Rates and Payment Realization Point. 
You can't specify the Individual Rate Threshold Amount for Payment Realization Point rates.  You can't specify the Individual Rate Threshold Amount for Payment Realization Point rates. 
You can't specify the Threshold Combination Reference for Payment Realization Point rates.  You can't specify the Threshold Combination Reference for Payment Realization Point rates. 
You must specify the Threshold Combination when both Document Threshold and Rate Threshold are not zero.  You must specify the Threshold Combination when both Document Threshold and Rate Threshold are not zero. 
Transaction or Rate Threshold must be non-zero when you specify an Individual Threshold.  Transaction or Rate Threshold must be non-zero when you specify an Individual Threshold. 
You can only select Include In Progress for Accumulation when the Realization Point is Invoice.  You can only select Include In Progress for Accumulation when the Realization Point is Invoice. 
You can specify the Accumulation Period only for Accumulated Threshold Type.   
You can specify Transaction Threshold data only for Transaction Threshold type.   
You can only select Include In Progress for Accumulation only for Accumulated Threshold Type.   
Threshold Combination and Rate Threshold Amount may not be specified for Individual Threshold, Net Amount, Realization Point Payment.   
You can't change the Accumulation Rate Threshold if the tax rate is in use by a tax code.   
 
Withholding_Tax_Progressive_Rate_Tier_Rule_Data  Withholding_Tax_Progressive_Rate_Tier_Rule_Data  [0..*]  Container for Withholding Tax Progressive Rate Tier Rule Data 
Validation Description
Max Tier is selected on more than one Progressive Tier Rule Line  Max Tier is selected on more than one Progressive Tier Rule Line 
Minimum Threshold Amount must be less than the Maximum Threshold Amount.  Minimum Threshold Amount must be less than the Maximum Threshold Amount. 
Threshold ranges must not overlap.  Threshold ranges must not overlap. 
There is a gap in the Threshold Amounts.  There is a gap in the Threshold Amounts. 
You can't specify both Max Tier and Maximum Threshold Amount.  You can't specify both Max Tier and Maximum Threshold Amount. 
You must select a Max Tier for one of the Progressive Tier Rule Lines.  You must select a Max Tier for one of the Progressive Tier Rule Lines. 
Progressive Tiers must start with zero.  Progressive Tiers must start with zero. 
 
Validation Description
The field Effective Date must have an entry equal to the start of the accumulation period.   
Enter a unique effective date [Effective Date] for the [Tax Rate].  Enter a unique effective date. 
Enter an Effective Date in a valid fiscal period because a fiscal period doesn't exist for this Effective Date : [Effective Date].   
Select a minimum of 2 tiers for Progressive Rates.   
You can't change the Single Rate Percentage because the Tax Rate is used in a Tax code.   
You can't change the Progressive Rate because the Tax Rate is used in a Tax code.   
You must specify the Progressive Tier Rate when you select Progressive for the Rate Type.   
Single Rate Percentage cannot be used with Progressive Rate Tier Rules   
top
 

Withholding_Tax_Rate_Threshold_Rule_Data

part of: Effective_Dated_Withholding_Tax_WS_Data
Container for Withholding Tax Rate Threshhold Data
 
Parameter name Type/Value Cardinality Description Validations
Transaction_Threshold_Amount  decimal (15, 3) >0   [0..1]  Document Threshold Amount in Tax Currency   
Threshold_Combination_Reference  Logical_OperatorObject  [0..1]  Logical Operator Reference   
Rate_Threshold_Amount  decimal (15, 3) >0   [0..1]  Line Threshold Amount in Tax Currency   
Accumulated_Rate_Amount_in_Tax_Currency  decimal (15, 3) >0   [0..1]  Accumulated Rate Amount in Tax Currency   
Validation Description
Rate Threshold Amount cannot be specified for Payment Realization Point rates.  Rate Threshold Amount cannot be specified for Payment Realization Point rates. 
You can specify the Rate Threshold Amount only for Accumulated Threshold Type.  You can specify the Rate Threshold Amount only for Accumulated Threshold Type. 
Transaction Threshold Amount is required for Individual Threshold Tax Rates and Payment Realization Point.  Transaction Threshold Amount is required for Individual Threshold Tax Rates and Payment Realization Point. 
You can't specify the Individual Rate Threshold Amount for Payment Realization Point rates.  You can't specify the Individual Rate Threshold Amount for Payment Realization Point rates. 
You can't specify the Threshold Combination Reference for Payment Realization Point rates.  You can't specify the Threshold Combination Reference for Payment Realization Point rates. 
You must specify the Threshold Combination when both Document Threshold and Rate Threshold are not zero.  You must specify the Threshold Combination when both Document Threshold and Rate Threshold are not zero. 
Transaction or Rate Threshold must be non-zero when you specify an Individual Threshold.  Transaction or Rate Threshold must be non-zero when you specify an Individual Threshold. 
You can only select Include In Progress for Accumulation when the Realization Point is Invoice.  You can only select Include In Progress for Accumulation when the Realization Point is Invoice. 
You can specify the Accumulation Period only for Accumulated Threshold Type.   
You can specify Transaction Threshold data only for Transaction Threshold type.   
You can only select Include In Progress for Accumulation only for Accumulated Threshold Type.   
Threshold Combination and Rate Threshold Amount may not be specified for Individual Threshold, Net Amount, Realization Point Payment.   
You can't change the Accumulation Rate Threshold if the tax rate is in use by a tax code.   
top
 

Logical_OperatorObject

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

Logical_OperatorObjectID

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

part of: Effective_Dated_Withholding_Tax_WS_Data
Container for Withholding Tax Progressive Rate Tier Rule Data
 
Parameter name Type/Value Cardinality Description Validations
Minimum_Threshold_Amount  decimal (15, 3) >0   [0..1]  Minimum Threshold Amount in Tax Currency   
Maximum_Threshold_Amount  decimal (15, 3) >0   [0..1]  Maximum Threshold Amount in Tax Currency   
Max_Tier  boolean  [0..1]  Use Max Tier   
Tax_Rate  decimal (6, 3) >0   [0..1]  Numerical Value of Tax Rate 
Validation Description
Tax Rate Percentage must be less than or equal to 100.  Tax Rate Percentage must be less than or equal to 100. 
 
Validation Description
Max Tier is selected on more than one Progressive Tier Rule Line  Max Tier is selected on more than one Progressive Tier Rule Line 
Minimum Threshold Amount must be less than the Maximum Threshold Amount.  Minimum Threshold Amount must be less than the Maximum Threshold Amount. 
Threshold ranges must not overlap.  Threshold ranges must not overlap. 
There is a gap in the Threshold Amounts.  There is a gap in the Threshold Amounts. 
You can't specify both Max Tier and Maximum Threshold Amount.  You can't specify both Max Tier and Maximum Threshold Amount. 
You must select a Max Tier for one of the Progressive Tier Rule Lines.  You must select a Max Tier for one of the Progressive Tier Rule Lines. 
Progressive Tiers must start with zero.  Progressive Tiers must start with zero. 
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
 

Realization_PointReferenceEnumeration

part of: Realization_PointObjectID
Base Type
string
top
 

Tax_Base__TypeReferenceEnumeration

part of: Tax_Base__TypeObjectID
Base Type
string
top
 

Fiscal_ScheduleReferenceEnumeration

part of: Fiscal_ScheduleObjectID
Base Type
string
top
 

Logical_OperatorReferenceEnumeration

part of: Logical_OperatorObjectID
Base Type
string
top