Service Directory > v32.1 > Payroll > Put_Tax_Levy_Deduction_Restriction
 

Operation: Put_Tax_Levy_Deduction_Restriction

This web service will load tax levy deduction restrictions. For extracting the above deduction restrictions, there is a corresponding web service: Get Tax Levy Deduction Restrictions.


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

Put Tax Levy Deduction Restriction Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Tax_Levy_Reference  Tax_LevyObject  [1..1]  Only withholding orders of type federal tax levy are valid.   
Tax_Levy_Deduction_Restriction_Data  Tax_Levy_Deduction_Restriction_Data  [0..1]  Tax Levy Deduction Restriction Response Data   
Validation Description
Only withholding orders of type federal tax levy are valid.   
top
 

Response Element: Put_Tax_Levy_Deduction_Restriction_Response

Put Tax Levy Deduction Restriction Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Tax_Levy_Reference  Tax_LevyObject  [0..1]  Only withholding orders of type federal tax levy are valid.   
Tax_Levy_Deduction_Restriction_Data  Tax_Levy_Deduction_Restriction_Data  [0..*]  Tax Levy Deduction Restriction Response Data   
top
 

Tax_LevyObject

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

Tax_LevyObjectID

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

part of: Put_Tax_Levy_Deduction_Restriction_Request, Put_Tax_Levy_Deduction_Restriction_Response
Tax Levy Deduction Restriction Response Data
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Order_ID  string  [0..1]  Customer defined ID to identify a Withholding Order   
Lock_Tax_Elections  boolean  [0..1]  If true, blocks tax elections changes for the worker from employee self-service.   
Baseline_Deduction_Restriction_Data  Tax_Levy_Deduction_Restriction_Baseline_Data  [0..1]  Tax Levy Deduction Restriction Baseline Data   
Override_Deduction_Restriction_Data  Tax_Levy_Deduction_Restriction_Override_Data  [0..1]  Tax Levy Deduction Restriction Override Data   
top
 

Tax_Levy_Deduction_Restriction_Baseline_Data

part of: Tax_Levy_Deduction_Restriction_Data
Tax Levy Deduction Restriction Baseline Data
 
Parameter name Type/Value Cardinality Description Validations
Baseline_Data  Tax_Levy_Deduction_for_Baseline_Data  [0..*]  Tax Levy Deduction for Baseline Data 
Validation Description
The restriction for [deduction] on [as of date] must have an effective date greater or equal to the order begin date   
The override percent set for [deduction] on [as of date] cannot be higher than 100   
The restriction for [deduction] on [as of date] must have one override option selected   
Cannot load baseline deduction restrictions when there are complete payroll results for the tax levy.   
The restriction for [deduction] on [as of date] may only have one override option selected   
 
top
 

Tax_Levy_Deduction_for_Baseline_Data

part of: Tax_Levy_Deduction_Restriction_Baseline_Data
Tax Levy Deduction for Baseline Data
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  Date that the deduction restriction will come into effective.   
Deduction_Reference  DeductionObject  [1..1]  Deduction that the restriction will be taken against.   
Amount  decimal (26, 6)   [0..1]  Amount the restriction will be set to.   
Percent  decimal (9, 6) >0   [0..1]  Percent the restriction will be set to.   
Validation Description
The restriction for [deduction] on [as of date] must have an effective date greater or equal to the order begin date   
The override percent set for [deduction] on [as of date] cannot be higher than 100   
The restriction for [deduction] on [as of date] must have one override option selected   
Cannot load baseline deduction restrictions when there are complete payroll results for the tax levy.   
The restriction for [deduction] on [as of date] may only have one override option selected   
top
 

DeductionObject

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

DeductionObjectID

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

part of: Tax_Levy_Deduction_Restriction_Data
Tax Levy Deduction Restriction Override Data
 
Parameter name Type/Value Cardinality Description Validations
Override_Data  Tax_Levy_Deduction_for_Override_Data  [0..*]  Tax Levy Deduction for Override Data 
Validation Description
The restriction for [deduction] on [as of date] must have an effective date greater or equal to the order begin date   
The override percent set for [deduction] on [as of date] cannot be higher than 100   
The restriction for [deduction] on [as of date] must have one override option selected   
The restriction for [deduction] on [as of date] may only have one override option selected   
 
top
 

Tax_Levy_Deduction_for_Override_Data

part of: Tax_Levy_Deduction_Restriction_Override_Data
Tax Levy Deduction for Override Data
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  Date that the deduction restriction will come into effective.   
Deduction_Reference  DeductionObject  [1..1]  Deduction that the restriction will be taken against.   
Amount  decimal (26, 6)   [0..1]  Amount the restriction will be set to.   
Percent  decimal (9, 6) >0   [0..1]  Percent the restriction will be set to.   
Never_Reduces_DE  boolean  [0..1]  If true, the deduction will never reduce disposable earnings.   
Always_Reduces_DE  boolean  [0..1]  If true, the deduction will always reduce disposable earnings.   
Validation Description
The restriction for [deduction] on [as of date] must have an effective date greater or equal to the order begin date   
The override percent set for [deduction] on [as of date] cannot be higher than 100   
The restriction for [deduction] on [as of date] must have one override option selected   
The restriction for [deduction] on [as of date] may only have one override option selected   
top
 

Tax_LevyReferenceEnumeration

part of: Tax_LevyObjectID
Base Type
string
top
 

DeductionReferenceEnumeration

part of: DeductionObjectID
Base Type
string
top