Service Directory > v32.1 > Payroll_GBR > Get_Deduction_from_Earnings_Orders
 

Operation: Get_Deduction_from_Earnings_Orders

Provides the ability to retrieve all or some worker's Deduction from Earnings Orders information based on Criteria (Company/Worker(s)).


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

Get Deduction from Earnings Orders Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Court_Order_Request_Reference  [0..1]  Direct Earnings Attachment Request Reference   
Request_Criteria [Choice]   Court_Order_Request_Criteria  [0..1]  Court Order 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  Deduction_from_Earnings_Orders_Response_Group  [0..1]  Deduction from Earnings Orders Response Group   
top
 

Response Element: Get_Deduction_from_Earnings_Orders_Response

Get Deduction from Earnings Orders Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Court_Order_Request_Reference  [0..1]  Direct Earnings Attachment Request Reference   
Request_Criteria  Court_Order_Request_Criteria  [0..1]  Court Order 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  Deduction_from_Earnings_Orders_Response_Group  [0..1]  Deduction from Earnings Orders 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  Deduction_from_Earnings_Orders_Response_Data  [0..1]  Deduction from Earnings Order Response Data   
top
 

Court_Order_Request_Reference

part of: Get_Deduction_from_Earnings_Orders_Request, Get_Deduction_from_Earnings_Orders_Response
Direct Earnings Attachment Request Reference
 
Parameter name Type/Value Cardinality Description Validations
Court_Order_Reference  Court_Order_Interface__UK_Object  [1..1]  AEO Non Priority Order Reference   
top
 

Court_Order_Interface__UK_Object

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

Court_Order_Interface__UK_ObjectID

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

Court_Order_Request_Criteria

part of: Get_Deduction_from_Earnings_Orders_Request, Get_Deduction_from_Earnings_Orders_Response
Court Order Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference [Choice]   WorkerObject  [0..*]  Court Order Request Worker(s)   
Company_Reference [Choice]   CompanyObject  [0..1]  Court Order Request Company   
top
 

WorkerObject

part of: Common_Court_Order_Data, Court_Order_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: Common_Court_Order_Data, Court_Order_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_Deduction_from_Earnings_Orders_Request, Get_Deduction_from_Earnings_Orders_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
 

Deduction_from_Earnings_Orders_Response_Group

part of: Get_Deduction_from_Earnings_Orders_Request, Get_Deduction_from_Earnings_Orders_Response
Deduction from Earnings Orders Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include the Reference check   
top
 

Response_Results

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

Deduction_from_Earnings_Orders_Response_Data

part of: Get_Deduction_from_Earnings_Orders_Response
Deduction from Earnings Order Response Data
 
Parameter name Type/Value Cardinality Description Validations
Deduction_from_Earnings_Order  Deduction_from_Earnings_Order  [0..*]  Deduction from Earnings Order   
top
 

Deduction_from_Earnings_Order

part of: Deduction_from_Earnings_Orders_Response_Data
Deduction from Earnings Order
 
Parameter name Type/Value Cardinality Description Validations
Court_Order_Reference  Deduction_from_Earnings_OrderObject  [0..1]  Deduction from Earnings Order   
Deduction_from_Earnings_Order_Data  Deduction_from_Earnings_Order_Data  [1..1]  Put Deduction from Earnings Order Request 
Validation Description
The field Frequency is required and must have a value   
The field Normal Deduction Rate is required and must have a value   
The field Protected Earnings Rate is required and must have a value   
The type of Court Order being edited or revised is incorrect for this request   
 
top
 

Deduction_from_Earnings_OrderObject

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

Deduction_from_Earnings_OrderObjectID

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

Deduction_from_Earnings_Order_Data

part of: Deduction_from_Earnings_Order
Put Deduction from Earnings Order Request
 
Parameter name Type/Value Cardinality Description Validations
Common_Court_Order_Data  Common_Court_Order_Data  [0..*]  Common Court Order Data 
Validation Description
You must specify a Deduction Recipient   
You must specify a Worker   
You must specify a Company   
You must specify a Begin Date   
You must specify a Received Date   
You must specify an Order Date   
You must specify a Reference Number   
You must specify an Issuing Authority   
Court Order Begin Date must be on or after the Order Date   
Worker cannot be changed on a revision   
Reference Number cannot be changed on a revision   
Company cannot be changed on a revision   
Issuing Authority cannot be changed on a revision   
Invalid Issuing Authority Region, court orders are currently in force within a different jurisdiction   
Court Order End Date cannot be before Court Order Begin Date   
The Revision Order Date must be later than the Original Order Date   
The specified Company is not valid as of the Court Order Begin date   
You can't change the Worker that a Court Order is assigned to.   
The specified Company isn't valid for the worker as of the Court Order Begin date   
The type of Court Order being edited or revised is incorrect for this request   
Court Order Reference and Court Order ID are mutually exclusive you must specify one or the other   
 
Revision_Court_Order_Reference  Deduction_from_Earnings_OrderObject  [0..1]  Revision Court Order Reference   
Revision_Court_Order_ID  string  [0..1]  Revision Court Order ID   
Pre_April_2003  boolean  [0..1]  Pre-April 2003   
Normal_Deduction_Rate  decimal (26, 6) >0   [0..1]  Normal Deduction Rate   
Protected_Earnings_Rate  decimal (9, 2) >0   [0..1]  Protected Earnings Rate   
Protected_Earnings_Proportion  decimal (9, 2) >0   [0..1]  Protected Earnings Proportion   
Protected_Earnings_Proportion_Percent  decimal (9, 6) >0   [0..1]  Protected Earnings Proportion Percent   
Frequency_Reference  FrequencyObject  [0..1]  Pay Period Frequency Reference   
Court_Order_Fee_Data  UK_Court_Order_Fee_Data  [0..*]  Court Order Fee Data 
Validation Description
Fee Amount is required and must be greater than zero   
 
Validation Description
The field Frequency is required and must have a value   
The field Normal Deduction Rate is required and must have a value   
The field Protected Earnings Rate is required and must have a value   
The type of Court Order being edited or revised is incorrect for this request   
top
 

Common_Court_Order_Data

part of: Deduction_from_Earnings_Order_Data
Common Court Order Data
 
Parameter name Type/Value Cardinality Description Validations
Reference_Number  string  [0..1]  Reference Number.   
Court_Order_ID  string  [0..1]  Court Order ID   
Order_Date  date  [0..1]  Order Date.   
Date_Received  dateTime  [0..1]  Date Received.   
Begin_Date  date  [0..1]  Begin Date.   
End_Date  date  [0..1]  End Date   
Company_Reference  CompanyObject  [0..1]  Company reference.   
Inactive_Order  boolean  [0..1]  Court order is inactive.   
Memo  string  [0..1]  Memo   
Worker_Reference  WorkerObject  [0..1]  Worker Reference.   
Issuing_Authority_Reference  Payroll_Tax_AuthorityObject  [0..1]  Issuing Authority.   
Deduction_Recipient_Reference  Deduction_RecipientObject  [0..1]  Deduction Recipient.   
Validation Description
You must specify a Deduction Recipient   
You must specify a Worker   
You must specify a Company   
You must specify a Begin Date   
You must specify a Received Date   
You must specify an Order Date   
You must specify a Reference Number   
You must specify an Issuing Authority   
Court Order Begin Date must be on or after the Order Date   
Worker cannot be changed on a revision   
Reference Number cannot be changed on a revision   
Company cannot be changed on a revision   
Issuing Authority cannot be changed on a revision   
Invalid Issuing Authority Region, court orders are currently in force within a different jurisdiction   
Court Order End Date cannot be before Court Order Begin Date   
The Revision Order Date must be later than the Original Order Date   
The specified Company is not valid as of the Court Order Begin date   
You can't change the Worker that a Court Order is assigned to.   
The specified Company isn't valid for the worker as of the Court Order Begin date   
The type of Court Order being edited or revised is incorrect for this request   
Court Order Reference and Court Order ID are mutually exclusive you must specify one or the other   
top
 

Payroll_Tax_AuthorityObject

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

Payroll_Tax_AuthorityObjectID

part of: Payroll_Tax_AuthorityObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payroll_Federal_Authority_Tax_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_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
 

Deduction_RecipientObject

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

Deduction_RecipientObjectID

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

FrequencyObject

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

FrequencyObjectID

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

UK_Court_Order_Fee_Data

part of: Deduction_from_Earnings_Order_Data
Direct Earnings Attachment Order Data
 
Parameter name Type/Value Cardinality Description Validations
Fee_Reference  Unique_IdentifierObject  [0..1]  Withholding Order Fee.   
Fee_Type_Reference  Withholding_Order_Fee_TypeObject  [1..1]  Fee Type Reference.   
Fee_Amount  decimal (26, 6) >0   [0..1]  Fee amount.   
Validation Description
Fee Amount is required and must be greater than zero   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

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

Withholding_Order_Fee_TypeObjectID

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

Court_Order_Interface__UK_ReferenceEnumeration

part of: Court_Order_Interface__UK_ObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Deduction_from_Earnings_OrderReferenceEnumeration

part of: Deduction_from_Earnings_OrderObjectID
Base Type
string
top
 

Payroll_Tax_AuthorityReferenceEnumeration

part of: Payroll_Tax_AuthorityObjectID
Base Type
string
top
 

Deduction_RecipientReferenceEnumeration

part of: Deduction_RecipientObjectID
Base Type
string
top
 

FrequencyReferenceEnumeration

part of: FrequencyObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Withholding_Order_Fee_TypeReferenceEnumeration

part of: Withholding_Order_Fee_TypeObjectID
Base Type
string
top