Service Directory > v31.2 > Payroll > Get_Tax_Levy_Deduction_Restrictions
 

Operation: Get_Tax_Levy_Deduction_Restrictions

This web service will extract all tax levy deduction restrictions. For loading the above tax levy deduction restrictions, there is a corresponding web service: Put Tax Levy Deduction Restriction.


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

Get Tax Levy Deduction Restrictions Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Tax_Levy_Deduction_Restriction_Request_References  [0..1]  An optional list of existing Involuntary Withholding Order Reference Numbers. This list will act as a filter for the Get Tax Levy Deduction Restriction Request, retrieving only the withholding orders with matching references.   
Request_Criteria [Choice]   Tax_Levy_Deduction_Restriction_Request_Criteria  [0..1]  Tax Levy Deduction Restriction Request Criteria   
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  Tax_Levy_Deduction_Restriction_Response_Group  [0..1]  Tax Levy Deduction Restriction Response Group   
top
 

Response Element: Get_Tax_Levy_Deduction_Restrictions_Response

Get Tax Levy Deduction Restrictions Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Tax_Levy_Deduction_Restriction_Request_References  [0..1]  Tax Levy Deduction Restriction Request References   
Request_Criteria  Tax_Levy_Deduction_Restriction_Request_Criteria  [0..1]  Tax Levy Deduction Restriction Request Criteria   
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  Tax_Levy_Deduction_Restriction_Response_Group  [0..1]  Tax Levy Deduction Restriction 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  Tax_Levy_Deduction_Restrictions_Response_Data  [0..1]  Get Tax Levy Deduction Restrictions Response   
top
 

Tax_Levy_Deduction_Restriction_Request_References

part of: Get_Tax_Levy_Deduction_Restrictions_Request, Get_Tax_Levy_Deduction_Restrictions_Response
Tax Levy Deduction Restriction Request References
 
Parameter name Type/Value Cardinality Description Validations
Tax_Levy_Reference  Tax_LevyObject  [1..*]  Tax Levy Reference   
top
 

Tax_LevyObject

part of: Tax_Levy_Deduction_Restriction_Request_References, Tax_Levy_Deduction_Restrictions
 
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_Request_Criteria

part of: Get_Tax_Levy_Deduction_Restrictions_Request, Get_Tax_Levy_Deduction_Restrictions_Response
Tax Levy Deduction Restriction Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..*]  An optional list of Worker References. Response will limit the Withholding Orders to the Workers specified in this list.   
Company_Reference  CompanyObject  [0..*]  An optional list of Company References. Response will limit the Withholding Orders to the Companies specified in this list.   
Effective_As_Of  date  [0..1]  An optional list of Worker References. Response will limit the Withholding Orders to the Workers specified in this list.   
top
 

WorkerObject

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

WorkerObjectID

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

CompanyObject

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

Response_Filter

part of: Get_Tax_Levy_Deduction_Restrictions_Request, Get_Tax_Levy_Deduction_Restrictions_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
 

Tax_Levy_Deduction_Restriction_Response_Group

part of: Get_Tax_Levy_Deduction_Restrictions_Request, Get_Tax_Levy_Deduction_Restrictions_Response
Tax Levy Deduction Restriction Response Group
 
Parameter name Type/Value Cardinality Description Validations
Exclude_Baseline_Restrictions  boolean  [0..1]  If true, excludes baseline deduction restrictions from being in the response.   
top
 

Response_Results

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

Tax_Levy_Deduction_Restrictions_Response_Data

part of: Get_Tax_Levy_Deduction_Restrictions_Response
Get Tax Levy Deduction Restrictions Response
 
Parameter name Type/Value Cardinality Description Validations
Tax_Levy_Deduction_Restriction  Tax_Levy_Deduction_Restrictions  [0..*]  Tax Levy Deduction Restrictions   
top
 

Tax_Levy_Deduction_Restrictions

part of: Tax_Levy_Deduction_Restrictions_Response_Data
Tax Levy Deduction Restrictions
 
Parameter name Type/Value Cardinality Description Validations
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_Levy_Deduction_Restriction_Data

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

DeductionReferenceEnumeration

part of: DeductionObjectID
Base Type
string
top