Service Directory > v32.1 > Payroll > Put_Payroll_Involuntary_Withholding_Order
 

Operation: Put_Payroll_Involuntary_Withholding_Order

This web service will load all types of Withholding Orders: 1-Bankruptcy Order 2-Creditor Garnishment 3-Federal Administrative Wage Garnishment 4-Federal Student Loan 5-Federal Tax Levy 6-State Tax Levy 7-Wage Assignment 8-Support Order (Lump Sum) 9-Support Order This method also supports Amend/Terminate Support Order. For extracting the above Withholding Orders, there is a corresponding web service: Get Payroll Involuntary Withholding Orders.


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

Put Payroll Involuntary Withholding Order Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Add_Only  boolean  [0..1]  Add Only Field for IMM   
Payroll_Involuntary_Withholding_Order_Reference [Choice]   Withholding_OrderObject  [0..1]  Provide an existing Involuntary Withholding Order Reference in order to update a Withholding Order. If no reference is provided, a new Withholding Order will b created.   
Payroll_Support_Order_Amend_or_Terminate_Data [Choice]   Payroll_Support_Order_Amend_or_Terminate_Data  [0..1]  If Amending or Terminating an existing Support Order, you must provide this reference to the Original or Amended Support Order.   
Payroll_Involuntary_Withholding_Order_Data  Payroll_Involuntary_Withholding_Order_Data  [0..1]  Payroll Involuntary Withholding Order 
Validation Description
When Withholding Order Type is [fed_levy], Withholding Order Amount or Federal Tax Levy Data must be provided but not both.   
An active Federal Tax Levy already exists for this Worker.   
End Date must be on or after Begin Date.   
Amount Type Reference must be [amount] when Withholding Order Type is [fedlevy]   
Withholding Order Amount must be greater than 0 (zero) when Amount Type Reference equals [amt]   
Originating Authority is not valid when Withholding Order type is [fedlevy] or [awg]   
Total Debt Amount is required for all Withholding Order Types except [support] and [bankruptcy]   
Bankruptcy Order Data is required when the Withholding Order Type is [bankruptcy]   
Creditor Garnishment Order Data is required when the Withholding Order Type is [creditor]   
Issued In reference must be [federal] when Withholding Order Type is [order_type]   
State Tax Levy Order Data is required when Withholding Support Order type is [state tax levy]   
Wage Assignment Order Data is required when the Withholding Order type is [wage assignment]   
Amount as Percent must be greater than 0 (zero) if Withholding Order Amount Type is [percent_de] or [percent_gross]   
Invalid Withholding Order Type. Must be a valid reference to one of the following: [order types]   
Total Support Amount does not equal the sum of the Order Detail Support Amounts.   
Withholding Order Amount as Percent does not equal the sum of the Order Detail Support Amount Percentages.   
Issued In Reference is not a valid Payroll State Tax Authority.   
Total Debt Amount must be zero for Withholding Orders of type Support Order.   
Order End Date is not a valid field for Withholding Orders of type Support Order   
Employee does not match the current Employee of the existing Withholding Order.   
Support Order Lump Sum Data is required when the Withholding Order Type is Support Order (Lump Sum).   
Support Order Data is required when Withholding Order Type is Support Order.   
Total Support Amount does not equal the sum of the Order Detail Support Amounts.   
Withholding Order Amount as Percent does not equal the sum of the Order Detail Support Amount Percentages.   
The Worker must be in the Company and the Company must have a US Business Number configured.   
The Company cannot be changed if there are results that are deducting the case number.   
FIPS code is not valid for the issuing state - i.e. County does not exist for selected State.   
Issued In reference must be Federal or Kentucky when Withholding Order Type is Student Loan   
Received Date must be on or after the Order Date.   
Begin Date must be on or after the Order Date.   
The worker must be assigned to a pay group.   
 
Validation Description
When a Withholding Order Reference is provided for update, the Withholding Order Data must contain a valid Withholding Order Case Reference.   
Case Number must be provided for all new non-Support Order Withholding Orders   
If Payroll Support Order to Amend or Terminate is provided, Amended Order or Terminated Order must be true.   
Withholding Order Case Number already exists.   
Payroll Support Order Amend or Terminate is only valid when amending or terminating Support Orders (i.e. when Withholding Order Type is Support Order)   
Withholding Order Case Reference of the Amendment or Termination Order ([new case]) does not match the Case Number of the current Support Order ([old case]).   
Withholding Order Case Reference is not valid when adding a new Withholding Order for any Withholding Order type except Support Order. Use Case Number instead.   
Withholding Order Case Reference does not match the current Case Reference of the Withholding Order.   
This Withholding Order ID already exists and the Add Only check box is selected. To overwrite the existing data, deselect the Add Only check box or create a new withholding order with a different Withholding Order ID.   
top
 

Response Element: Put_Payroll_Involuntary_Withholding_Order_Response

Put Payroll Involuntary Withholding Order Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Put_Payroll_Involuntary_Withholding_Order_Response_Data  Put_Payroll_Involuntary_Withholding_Order_Response_Data  [0..*]  Put Payroll Involuntary Withholding Order Response Data   
top
 

Withholding_OrderObject

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

Withholding_OrderObjectID

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

Payroll_Support_Order_Amend_or_Terminate_Data

part of: Put_Payroll_Involuntary_Withholding_Order_Request
Include this element to Amend or Terminate an existing Support Order.
 
Parameter name Type/Value Cardinality Description Validations
Support_Order_Reference  Support_OrderObject  [0..1]  The original support order that being amended or terminated   
top
 

Support_OrderObject

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

Support_OrderObjectID

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

Payroll_Involuntary_Withholding_Order_Data

part of: Put_Payroll_Involuntary_Withholding_Order_Request
Payroll Involuntary Withholding Order
 
Parameter name Type/Value Cardinality Description Validations
@Copied_Message  string  [1..1]  This attribute displays an informational message if copied order also needs to be updated. Any change made to this field will not be persisted.   
@Copied_To  string  [1..1]  This attribute has the value of the Withholding order this current Withholding order is copied to. Any change made to this field will not be persisted   
@Copied_From  string  [1..1]  This attribute has the value of the Withholding order this current Withholding order is copied from. Any change made to this field will not be persisted.   
@Processing_Message  string  [1..1]  This attribute displays an informational message if the order will no longer be processed by a certain date. Any change made to this field will not be persisted.   
@Copied_From_Date  date  [1..1]  This attribute has the value of the date that the copy was effective. Any change made to this field will not be persisted   
@Copied_To_Date  date  [1..1]  This attribute has the value of the date that the copy was effective. Any change made to this field will not be persisted   
Employee_Reference  WorkerObject  [1..1]  Worker Reference   
Withholding_Order_Type_Reference  Withholding_Order_TypeObject  [1..1]  Withholding Order Type   
Withholding_Order_Case_Reference [Choice]   Withholding_Order_CaseObject  [1..1]  Withholding Order Case Data   
Case_Number [Choice]   string  [1..1]  Case Number   
Withholding_Order_Additional_Order_Number  string  [0..1]  Withholding Order Additional Order Number   
Order_Date  date  [1..1]  Order Date   
Received_Date  dateTime  [1..1]  Received Date   
Begin_Date  date  [1..1]  Date the Withholding Order should begin   
End_Date  date  [0..1]  Date the Withholding Order should end   
Company_Reference  CompanyObject  [0..1]  Company the Withholding Order should be for   
Inactive_Order  boolean  [0..1]  Withholding Order is Inactive   
Withholding_Order_Amount_Type_Reference  Withholding_Order_Amount_TypeObject  [0..1]  Indicates whether Withholding Order is for an Amount, Percent of Disposable Earnings, or Percent of Gross.   
Withholding_Order_Amount [Choice]   decimal (26, 6) >0   [0..1]  Amount. If Amount Type Reference = "AMT", then Amount must be specified.   
Withholding_Order_Amount_as_Percent [Choice]   decimal (9, 6) >0   [0..1]  Amount as Percent. If Amount Type Reference = "PERCENTDE" or "PERCENTGROSS" then Amount as Percent must be specified.   
Pay_Period_Frequency_Reference  FrequencyObject  [1..1]  The frequency for which the pay period Amount is specified.   
Total_Debt_Amount  decimal (26, 6) >0   [0..1]  Total Debt Amount.   
Monthly_Limit  decimal (14, 2) >0   [0..1]  Monthly Limit.   
Issued_in_Reference  Payroll_Tax_AuthorityObject  [1..1]  Issued in State   
Deduction_Recipient_Reference  Deduction_RecipientObject  [1..1]  Deduction Recipient Reference   
Originating_Authority  string  [0..1]  Originating Authority. Not applicable if Withholding Order type is FEDLEVY or WAGE.   
Memo  string  [0..1]  Additional details.   
Bankruptcy_Order_Data [Choice]   Bankruptcy_Order_Specific_Data  [0..1]  Bankruptcy Order Specific Data   
Creditor_Garnishment_Data [Choice]   Creditor_Garnishment_Specific_Data  [0..1]  Creditor Garnishment Specific Data 
Validation Description
Good Cause Limit Percent must be between 10% and 24%.   
Good Cause Limit Percent is only valid for workers with a work state of Indiana and order date after July 1, 2014.   
Expected Annual Earnings is only valid for Non-Consumer creditor orders.   
Weekly gross wages are required when work state is NV and the order date is on or after October 1, 2017.   
Weekly gross wages are only applicable to Nevada creditor garnishments with an order date on or after October 1, 2017.   
FIPS code is not valid for the selected state.   
County FIPS codes are only available to MD Creditor garnishments with an order date on or after January 1, 2017.   
County FIPS codes are only available to Maryland state workers.   
Non Resident State is only used for Alaska creditor garnishments.   
Non Resident State is only used for Alaska creditor garnishments for Alaska workers.   
 
Federal_Tax_Levy_Data [Choice]   Federal_Tax_Levy_Specific_Data  [0..1]  Federal Tax Levy Specific Data 
Validation Description
The Federal Tax Levy Signed Part 3 Date is before 2007. Only enter values for Exemption Amount Override (required) and Exemption Frequency (required).   
Marital Status is invalid for Federal Tax Levy.   
Personal Exemptions must be greater than 0 when Withholding Order Amount is 0 for Federal Tax Levy.   
The Federal Tax Levy Signed Part 3 Date is after 2007. Only enter values for Payroll Marital Status (required), Personal Exemptions (optional), and Additional 65+ or Blind Exemptions (optional).   
The federal tax levy needs to be a new order to be able to load baseline deduction restrictions.   
 
State_Tax_Levy_Order_Data [Choice]   State_Tax_Levy_Order_Data  [0..1]  State Tax Levy Order Data 
Validation Description
State Tax Levy Federal Data is only valid when State Tax Levy Order is issued in Arizona, Kentucky, or Virginia.   
State Tax Levy Federal Data is required when the State Tax Levy Order is issued in Arizona, Kentucky, or Virginia.   
Good Cause Limit Percent is only valid for orders issued by Indiana and order date after July 1, 2014.   
Good Cause Limit Percent must be between 10% and 24%.   
Prorate Until Date is only available for State Tax Levies issued in Puerto Rico.   
Process Until is only available for State Tax Levies issued in Puerto Rico.   
Termination Date is required when Process Until is Termination Date.   
End Date is required when Process Until is End Date.   
County FIPS codes are only available to MD State Tax Levy garnishments with an order date on or after January 1, 2017.   
County FIPS codes are only available to Maryland state workers.   
FIPS code is not valid for the selected state.   
 
Support_Order_Data [Choice]   Payroll_Support_Order_Data  [0..1]  Payroll Support Order Data 
Validation Description
One and only one of the following attributes must be set to true: Case Type of Original Order, Case Type of Amended Order, Case Type of One Time Order, Case Type of Termination Order.   
End Date, and Total Debt Amount, and Process in Regular Period flag are only valid for orders with one time lump sum flag set.   
A specific support type cannot be assigned to more than one order detail line.   
The Payroll Local County Authority does not exist for the entered FIPS Code and Issuing State.   
An original support order with the same case number, order date, and company already exists for that worker.   
An existing case instance must be used if you are adding an amend or terminate order.   
The company on an amend or terminate support order cannot be changed.   
 
Payroll_Support_Order_Lump_Sum_Data [Choice]   Payroll_Support_Order_Lump_Sum_Data  [0..1]  Payroll Support Order Lump Sum Data   
Wage_Assignment_Data [Choice]   Wage_Assignment_Specific_Data  [0..1]  Wage Assignment Specific Data   
Federal_Student_Loan_Data  Federal_Student_Loan_Specific_Data  [0..*]  Federal Student Loan Specific Data   
Withholding_Order_Fee_Data  Withholding_Order_Fee_Data  [0..*]  Withholding Order Fee Data 
Validation Description
Fee Begin Date and Fee End Date are only valid when Override Fee Schedule = True   
Fee End Date must be on or after Fee Begin Date when Fee Schedule Override = True   
Fee Begin Date is required when Fee Schedule Override = True   
 
Withholding_Order_Withholding_Frequency_Data  Withholding_Order_Withholding_Frequency_Data  [0..*]  Withholding Order Withholding Frequency Data 
Validation Description
Withholding frequency is only supported for bankruptcy withholding orders at this time.   
The withholding frequencies given are invalid for the worker's pay frequency. The worker [worker] has a pay frequency of [frequency]. Valid withholding frequencies for this worker are [valid frequencies].   
 
Currency_Reference  CurrencyObject  [0..1]  Currency Reference. Only USD is supported at this time.   
Deduction_Recipient_Address_Data  Address_Information_Data  [0..*]  Address information 
Validation Description
Postal Code is not a valid address component for certain countries.  Postal Code is not a valid address component for certain countries. 
Municipality is not a valid address component for certain countries .  Municipality is not a valid address component for certain countries . 
Postal Code is required for certain countries.  Postal Code is required for certain countries. 
Municipality is required for certain countries.  Municipality is required for certain countries. 
Region Name must be valid for the specified Country.  Region Name must be valid for the specified Country. 
Usage Type and Use For combination must be valid for Address.  Usage Type and Use For combination must be valid for Address. 
Second Address Line is required for certain countries.  Second Address Line is required for certain countries. 
Third Address Line is required for certain countries.  Third Address Line is required for certain countries. 
Fourth Address Line is required for certain countries.  Fourth Address Line is required for certain countries. 
Subregion is required for certain countries.  Subregion is required for certain countries. 
Second Subregion is required for certain countries.  Second Subregion is required for certain countries. 
Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries.  Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries. 
Second Submunicipality is required for certain countries.  Second Submunicipality is required for certain countries. 
Second Address Line is not a valid address component for certain countries.  Second Address Line is not a valid address component for certain countries. 
Third Address Line is not a valid address component for certain countries.  Third Address Line is not a valid address component for certain countries. 
Fourth Address Line is not a valid address component for certain countries.  Fourth Address Line is not a valid address component for certain countries. 
Subregion is not a valid address component for certain countries.  Subregion is not a valid address component for certain countries. 
Second Subregion is not a valid address component for certain countries.  Second Subregion is not a valid address component for certain countries. 
Submunicipality is not a valid address component for certain countries.  Submunicipality is not a valid address component for certain countries. 
Second Submunicipality is not a valid address component for certain countries.  Second Submunicipality is not a valid address component for certain countries. 
A maximum of four Submunicipalities are allowed in an address.  A maximum of four Submunicipalities are allowed in an address. 
A maximum of four Subregions are allowed in an address.  A maximum of four Subregions are allowed in an address. 
A maximum of four Address Lines are allowed in an address.  A maximum of four Address Lines are allowed in an address. 
Region is required for certain countries.  Region is required for certain countries. 
Home addresses which are not additionally used as work addresses cannot be marked as public.  Home addresses which are not additionally used as work addresses cannot be marked as public. 
[postal code] is not a valid postal code for [region]  Postal Code must be valid for the Region. 
Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 1 is not valid for this Country.  Address Line 1 is not valid for this Country. 
Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country.  Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country. 
Address Line 2 not Valid for this Country.  Address Line 2 not Valid for this Country. 
Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 3 is not Valid for this Country.  Address Line 3 is not Valid for this Country. 
Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 4 is not Valid for this Country.  Address Line 4 is not Valid for this Country. 
Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 5 is not Valid for this Country.  Address Line 5 is not Valid for this Country. 
Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 7 is not Valid for this Country.  Address Line 7 is not Valid for this Country. 
Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 8 is not Valid for this Country.  Address Line 8 is not Valid for this Country. 
Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 9 is not Valid for this Country.  Address Line 9 is not Valid for this Country. 
You cannot specify the same usage type more than once for an address.  You cannot specify the same usage type more than once for an address. 
Address Line 1 - Local is not valid for this Country.  Address Line 1 - Local is not valid for this Country. 
Municipality - Local is not a valid address component for certain countries .  Municipality - Local is not a valid address component for certain countries . 
Address Line 2 - Local is not valid for this Country.  Address Line 2 - Local is not valid for this Country. 
Address Line 3 - Local is not Valid for this Country.  Address Line 3 - Local is not Valid for this Country. 
Address Line 9 - Local is not Valid for this Country.  Address Line 9 - Local is not Valid for this Country. 
Address Line 8 - Local is not Valid for this Country.  Address Line 8 - Local is not Valid for this Country. 
Address Line 7 - Local is not Valid for this Country.  Address Line 7 - Local is not Valid for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 5 - Local is not Valid for this Country.  Address Line 5 - Local is not Valid for this Country. 
Address Line 4 - Local is not Valid for this Country.  Address Line 4 - Local is not Valid for this Country. 
City Subdivision 1 - Local is not a valid address component for certain countries.  City Subdivision 1 - Local is not a valid address component for certain countries. 
City Subdivision 2 - Local is not a valid address component for certain countries.  City Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 1 - Local is not a valid address component for certain countries.  Region Subdivision 1 - Local is not a valid address component for certain countries. 
Region Subdivision 2 - Local is not a valid address component for certain countries.  Region Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 2 is not a valid address component for certain countries.  Region Subdivision 2 is not a valid address component for certain countries. 
City Subdivision 2 is not a valid address component for certain countries.  City Subdivision 2 is not a valid address component for certain countries. 
Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country.  Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country. 
Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country.  Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country. 
Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
If one local script address field is submitted, all required local script address fields must be submitted.  If one local script address field is submitted, all required local script address fields must be submitted. 
Address Reference is required when deleting an address  Address Reference is required when deleting an address 
Usage Data is required unless address is being deleted  Usage Data is required unless address is being deleted 
Country Reference is required unless address is being deleted  Country Reference is required unless address is being deleted 
Address deletion is not supported in this web service request  Address deletion is not supported in this web service request 
If one western script field is submitted, all required western script address fields must be submitted.  If one western script field is submitted, all required western script address fields must be submitted. 
Address Reference must match an existing (and not deleted) address in use by the worker subject of this request  Address Reference must match an existing (and not deleted) address in use by the worker subject of this request 
Use a unique Address Reference ID for each address. [ID] is already used on another address.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
You can only update addresses that belong to this customer.   
You can't use an existing address for a new customer.   
Existing addresses can't be future dated. Select an effective date that is on or before today, or create a new address with a future date.   
The Address ID must match the Address Reference.   
You can't use an existing address for a new customer request.   
You can't use an existing address for a new prospect.   
You can only update addresses that belong to this customer request.   
You can only update addresses that belong to this prospect.   
Enter a postal code in the valid format: [PostalCodeValidationMessage]   
Postal Code is required for [countryWithMustHavePostalCode]   
One or more addresses are missing a Country City reference. This field is required because the City Prompt localization is active for: [countryref].   
Enter a Country City reference that is valid for: [countryref]. You entered this Country City reference: [countrycityref].   
Only Address reference belonging to the Customer tied to the Customer Contact can be shared by the Customer Contact   
International Assignment is only valid for Non-Primary Home Addresses   
Number of Days cannot be greater than 7.  Number of Days cannot be greater than 7. 
Number of Days is not allowed for the country specified.  Number of Days is not allowed for the country specified. 
You must enter a Country City reference instead of a text element because the City Prompt localization is active for: [countryref]. You entered this text element: [cityattrib] [citylocalattrib].   
You entered this Country City reference: [countrycityref]. To use this Country City reference, you must activate the City Prompt localization for: [countryref]. Perform either one of these actions: Activate the City Prompt localization. Enter a municipality instead of a Country City reference.   
Address "[ID]" is already in use by another address (possibly on another contactable). Please choose a different Address ID.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
Address Line is required for certain countries.  Address Line is required for certain countries. 
 
Withholding_Order_ID  string  [0..1]  Customer defined ID to identify a Withholding Order   
Validation Description
When Withholding Order Type is [fed_levy], Withholding Order Amount or Federal Tax Levy Data must be provided but not both.   
An active Federal Tax Levy already exists for this Worker.   
End Date must be on or after Begin Date.   
Amount Type Reference must be [amount] when Withholding Order Type is [fedlevy]   
Withholding Order Amount must be greater than 0 (zero) when Amount Type Reference equals [amt]   
Originating Authority is not valid when Withholding Order type is [fedlevy] or [awg]   
Total Debt Amount is required for all Withholding Order Types except [support] and [bankruptcy]   
Bankruptcy Order Data is required when the Withholding Order Type is [bankruptcy]   
Creditor Garnishment Order Data is required when the Withholding Order Type is [creditor]   
Issued In reference must be [federal] when Withholding Order Type is [order_type]   
State Tax Levy Order Data is required when Withholding Support Order type is [state tax levy]   
Wage Assignment Order Data is required when the Withholding Order type is [wage assignment]   
Amount as Percent must be greater than 0 (zero) if Withholding Order Amount Type is [percent_de] or [percent_gross]   
Invalid Withholding Order Type. Must be a valid reference to one of the following: [order types]   
Total Support Amount does not equal the sum of the Order Detail Support Amounts.   
Withholding Order Amount as Percent does not equal the sum of the Order Detail Support Amount Percentages.   
Issued In Reference is not a valid Payroll State Tax Authority.   
Total Debt Amount must be zero for Withholding Orders of type Support Order.   
Order End Date is not a valid field for Withholding Orders of type Support Order   
Employee does not match the current Employee of the existing Withholding Order.   
Support Order Lump Sum Data is required when the Withholding Order Type is Support Order (Lump Sum).   
Support Order Data is required when Withholding Order Type is Support Order.   
Total Support Amount does not equal the sum of the Order Detail Support Amounts.   
Withholding Order Amount as Percent does not equal the sum of the Order Detail Support Amount Percentages.   
The Worker must be in the Company and the Company must have a US Business Number configured.   
The Company cannot be changed if there are results that are deducting the case number.   
FIPS code is not valid for the issuing state - i.e. County does not exist for selected State.   
Issued In reference must be Federal or Kentucky when Withholding Order Type is Student Loan   
Received Date must be on or after the Order Date.   
Begin Date must be on or after the Order Date.   
The worker must be assigned to a pay group.   
top
 

WorkerObject

part of: Payroll_Involuntary_Withholding_Order_Data, Put_Payroll_Involuntary_Withholding_Order_Response_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  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
 

Withholding_Order_TypeObject

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

Withholding_Order_TypeObjectID

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

Withholding_Order_CaseObject

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

Withholding_Order_CaseObjectID

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

Withholding_Order_Amount_TypeObject

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

Withholding_Order_Amount_TypeObjectID

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

FrequencyObject

part of: Federal_Tax_Levy_Specific_Data, Payroll_Involuntary_Withholding_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
 

Payroll_Tax_AuthorityObject

part of: Creditor_Garnishment_Specific_Data, Payroll_Involuntary_Withholding_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: Withholding_Order_Fee_Data, Payroll_Involuntary_Withholding_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
 

Bankruptcy_Order_Specific_Data

part of: Payroll_Involuntary_Withholding_Order_Data
Bankruptcy Order Specific Data
 
Parameter name Type/Value Cardinality Description Validations
Chapter_13 [Choice]   boolean  [1..1]  Chapter 13 Bankruptcy   
Chapter_7 [Choice]   boolean  [1..1]  Chapter 7 Bankruptcy   
top
 

Creditor_Garnishment_Specific_Data

part of: Payroll_Involuntary_Withholding_Order_Data
Creditor Garnishment Specific Data
 
Parameter name Type/Value Cardinality Description Validations
Creditor_Garnishment_Type_Reference  Unique_IdentifierObject  [1..1]  Creditor Garnishment Type Reference   
Non_Resident_State_Reference  Payroll_Tax_AuthorityObject  [0..1]  Non Resident State Reference   
Head_of_Household  boolean  [0..1]  Head of Household   
Number_of_Dependents  decimal (2, 0) >0   [0..1]  Number of Dependents   
Payroll_Local_County_Authority_FIPS_Code  string  [0..1]  County FIPS Code Reference   
Worker_is_Laborer_or_Mechanic  boolean  [0..1]  Worker is Laborer or Mechanic   
Worker_Income_is_Poverty_Level  boolean  [0..1]  Worker income is Poverty Level   
Good_Cause_Limit_Percent  decimal (9, 6) >0   [0..1]  Good Cause Limit Percent   
Weekly_Gross_Wages  decimal (22, 2) >0   [0..1]  Weekly Gross Wages   
Expected_Annual_Earnings  decimal (26, 6) >0   [0..1]  If the expected annual earnings amount is not provided, the Iowa annual limit on withholding for non-consumer orders will not be enforced.   
Validation Description
Good Cause Limit Percent must be between 10% and 24%.   
Good Cause Limit Percent is only valid for workers with a work state of Indiana and order date after July 1, 2014.   
Expected Annual Earnings is only valid for Non-Consumer creditor orders.   
Weekly gross wages are required when work state is NV and the order date is on or after October 1, 2017.   
Weekly gross wages are only applicable to Nevada creditor garnishments with an order date on or after October 1, 2017.   
FIPS code is not valid for the selected state.   
County FIPS codes are only available to MD Creditor garnishments with an order date on or after January 1, 2017.   
County FIPS codes are only available to Maryland state workers.   
Non Resident State is only used for Alaska creditor garnishments.   
Non Resident State is only used for Alaska creditor garnishments for Alaska workers.   
top
 

Unique_IdentifierObject

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

Federal_Tax_Levy_Specific_Data

part of: Payroll_Involuntary_Withholding_Order_Data
Federal Tax Levy Specific Data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Levy_Signed_Part_3_Date  date  [0..1]  Tax Levy Signed Part 3 Date   
Payroll_Marital_Status_Reference  Payroll_Marital_Status_Reference  [0..*]  Payroll Marital Status Reference 
Validation Description
Payroll Marital Status Reference is not found.   
 
Personal_Exemptions  decimal (2, 0) >0   [0..1]  Personal Exemptions   
Additional_Exemptions_65_or_Blind  decimal (1, 0) >0   [0..1]  Additional Exemptions 65 or Blind   
Exemption_Amount_Override  decimal (9, 2) >0   [0..1]  Exemption Amount Override   
Exemption_Frequency_Reference  FrequencyObject  [0..1]  Exemption Frequency Reference   
Tax_Levy_Termination_Date  date  [0..1]  Tax Levy Termination Date   
Federal_Tax_Levy_Dependent_Reference  Federal_Tax_Levy_Dependent_Reference  [0..*]  Federal Tax Levy Dependent Reference   
Lock_Tax_Elections  boolean  [0..1]  If true, blocks tax elections changes for the worker from employee self-service.   
Load_Baseline_Restrictions  boolean  [0..1]  If true, loads baseline deduction restrictions for the order. This is only valid for new orders.   
Validation Description
The Federal Tax Levy Signed Part 3 Date is before 2007. Only enter values for Exemption Amount Override (required) and Exemption Frequency (required).   
Marital Status is invalid for Federal Tax Levy.   
Personal Exemptions must be greater than 0 when Withholding Order Amount is 0 for Federal Tax Levy.   
The Federal Tax Levy Signed Part 3 Date is after 2007. Only enter values for Payroll Marital Status (required), Personal Exemptions (optional), and Additional 65+ or Blind Exemptions (optional).   
The federal tax levy needs to be a new order to be able to load baseline deduction restrictions.   
top
 

Payroll_Marital_Status_Reference

part of: Federal_Tax_Levy_Specific_Data, State_Tax_Levy_Federal_Data
Payroll Marital Status Reference
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Marital_Status_Reference  string  [0..1]  Payroll Marital Status Reference   
Validation Description
Payroll Marital Status Reference is not found.   
top
 

Federal_Tax_Levy_Dependent_Reference

part of: Federal_Tax_Levy_Specific_Data, State_Tax_Levy_Order_Data
Federal Tax Levy Specific Data
 
Parameter name Type/Value Cardinality Description Validations
Dependent_Name  string  [0..1]  Dependant Name   
Dependent_Identification_Number  string  [0..1]  Dependent Identification Number   
top
 

State_Tax_Levy_Order_Data

part of: Payroll_Involuntary_Withholding_Order_Data
State Tax Levy Order Data
 
Parameter name Type/Value Cardinality Description Validations
Number_of_Dependents  decimal (2, 0) >0   [0..1]  Number of Dependents   
Payroll_Local_County_Authority_FIPS_Code  string  [0..1]  County FIPS Code Reference   
Worker_is_Laborer_or_Mechanic  boolean  [0..1]  Worker is Laborer or Mechanic   
Worker_Income_is_Poverty_Level  boolean  [0..1]  Worker income is Poverty Level   
State_Tax_Levy_Federal_Data  State_Tax_Levy_Federal_Data  [0..1]  Federal Data used in State Tax Levy Withholding Orders 
Validation Description
When Pay Period Exemption Override Amount is provided, Marital Status, Personal Exemptions and Additional 65+ or Blind Exemptions must be 0 (zero) for State Tax Levies issued in Kentucky or Virginia.   
Pay Period Exemption Amount must be 0 (zero) for State Tax Levies issued in Arizona.   
Either Pay Period Amount/Amount as % or Part 3 Effective Date data is required for this State Tax Levy. Please enter either Pay Period Amount/Amount as % or Part 3 Effective Date data. When both are entered, the Pay Period Amount/Amount as % will be used in the calculation.   
Part 3 Effective Date, Marital Status and Personal Exemptions are all required for State Tax Levy issued in Kentucky and Virginia when Withholding Order Amount and Pay Period Exemption Override Amount are both 0 (zero).   
Part 3 Effective Date, Marital Status and Personal Exemptions are all required for State Tax Levy issued in Arizona when Withholding Order Amount is 0 (zero).   
Termination Date is required when Process Until is Termination Date.   
When Issuing State is Puerto Rico, only Termination Date is allowed on State Tax Levy Federal Data.   
 
State_Tax_Levy_Dependant_Reference  Federal_Tax_Levy_Dependent_Reference  [0..*]  State Tax Levy Dependants   
Good_Cause_Limit_Percent  decimal (9, 6) >0   [0..1]  Good Cause Limit Percent   
Process_Until_Reference  Withholding_Order_Override_Completion_CriteriaObject  [0..1]  Process Until Reference   
Prorate_Until_Date  date  [0..1]  Prorate Until Date   
Validation Description
State Tax Levy Federal Data is only valid when State Tax Levy Order is issued in Arizona, Kentucky, or Virginia.   
State Tax Levy Federal Data is required when the State Tax Levy Order is issued in Arizona, Kentucky, or Virginia.   
Good Cause Limit Percent is only valid for orders issued by Indiana and order date after July 1, 2014.   
Good Cause Limit Percent must be between 10% and 24%.   
Prorate Until Date is only available for State Tax Levies issued in Puerto Rico.   
Process Until is only available for State Tax Levies issued in Puerto Rico.   
Termination Date is required when Process Until is Termination Date.   
End Date is required when Process Until is End Date.   
County FIPS codes are only available to MD State Tax Levy garnishments with an order date on or after January 1, 2017.   
County FIPS codes are only available to Maryland state workers.   
FIPS code is not valid for the selected state.   
top
 

State_Tax_Levy_Federal_Data

part of: State_Tax_Levy_Order_Data
Federal Data used in State Tax Levy Withholding Orders
 
Parameter name Type/Value Cardinality Description Validations
Part_3_Effective_Date  date  [0..1]  Tax Levy Signed Part 3 Date   
Pay_Period_Exemption_Override_Amount  decimal (26, 6) >0   [0..1]  Tax Levy Exemption Override Amount   
Payroll_Marital_Status_Reference  Payroll_Marital_Status_Reference  [0..1]  Payroll Marital Status Reference 
Validation Description
Payroll Marital Status Reference is not found.   
 
Personal_Exemptions  decimal (2, 0) >0   [0..1]  Personal Exemptions   
Additional_65__or_Blind_Exemptions  decimal (1, 0) >0   [0..1]  Additional Exemptions 65 or Blind   
Termination_Date  date  [0..1]  Termination Date   
Validation Description
When Pay Period Exemption Override Amount is provided, Marital Status, Personal Exemptions and Additional 65+ or Blind Exemptions must be 0 (zero) for State Tax Levies issued in Kentucky or Virginia.   
Pay Period Exemption Amount must be 0 (zero) for State Tax Levies issued in Arizona.   
Either Pay Period Amount/Amount as % or Part 3 Effective Date data is required for this State Tax Levy. Please enter either Pay Period Amount/Amount as % or Part 3 Effective Date data. When both are entered, the Pay Period Amount/Amount as % will be used in the calculation.   
Part 3 Effective Date, Marital Status and Personal Exemptions are all required for State Tax Levy issued in Kentucky and Virginia when Withholding Order Amount and Pay Period Exemption Override Amount are both 0 (zero).   
Part 3 Effective Date, Marital Status and Personal Exemptions are all required for State Tax Levy issued in Arizona when Withholding Order Amount is 0 (zero).   
Termination Date is required when Process Until is Termination Date.   
When Issuing State is Puerto Rico, only Termination Date is allowed on State Tax Levy Federal Data.   
top
 

Withholding_Order_Override_Completion_CriteriaObject

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

Withholding_Order_Override_Completion_CriteriaObjectID

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

Payroll_Support_Order_Data

part of: Payroll_Involuntary_Withholding_Order_Data
Payroll Support Order Data
 
Parameter name Type/Value Cardinality Description Validations
Original_Order [Choice]   boolean  [0..1]  This Support Order is an Original Order. You must choose one of either Original, Amended or Terminated.   
Amended_Order [Choice]   boolean  [0..1]  This Support Order is an Amended Order. You must choose one of either Original, Amended or Terminated.   
Termination_Order [Choice]   boolean  [0..1]  This Support Order is a Termination Order. You must choose one of either Original, Amended or Terminated.   
Custodial_Party_Name  string  [0..1]  Custodial Party Name   
Supports_Second_Family  boolean  [0..1]  Indicate if worker supports a second family.   
Remittance_ID_Override  string  [0..1]  Remittance ID Override   
Support_Order_Dependant_Reference  Support_Order_Dependent_Data  [0..*]  Support Order Dependant Reference   
Support_Order_Details_Reference  Payroll_Support_Order_Detail_Data  [0..*]  Support Order Details Reference 
Validation Description
Order Form Amount is required when Withholding Order Amount Type is 'Amount on Order'   
Lump Sum Support Orders must have a Support Type of 'Lump Sum'.   
Pay Period Amount Override is required for each Support Order Detail line.   
Amount as Percent is required for each Support Order Detail line.   
Order Form Amount must be 0 (zero) when Withholding Order Amount Type is 'Percent of Gross' or 'Percent of Disposable Earnings'.   
 
Payroll_Local_County_Authority_FIPS_Code  string  [0..1]  Payroll Local County Authority 3 digit FIPS Code   
Validation Description
One and only one of the following attributes must be set to true: Case Type of Original Order, Case Type of Amended Order, Case Type of One Time Order, Case Type of Termination Order.   
End Date, and Total Debt Amount, and Process in Regular Period flag are only valid for orders with one time lump sum flag set.   
A specific support type cannot be assigned to more than one order detail line.   
The Payroll Local County Authority does not exist for the entered FIPS Code and Issuing State.   
An original support order with the same case number, order date, and company already exists for that worker.   
An existing case instance must be used if you are adding an amend or terminate order.   
The company on an amend or terminate support order cannot be changed.   
top
 

Support_Order_Dependent_Data

part of: Payroll_Support_Order_Data, Payroll_Support_Order_Lump_Sum_Data
Support Order Dependent Data
 
Parameter name Type/Value Cardinality Description Validations
Child_s_Name__Last__First__MI_  string  [1..1]  Child's Name (Last, First, MI)   
Child_s_Birth_Date  date  [1..1]  Child's Birth Date   
top
 

Payroll_Support_Order_Detail_Data

part of: Payroll_Support_Order_Data, Payroll_Support_Order_Lump_Sum_Data
Payroll Support Order Detail Data
 
Parameter name Type/Value Cardinality Description Validations
Order_Form_Amount  decimal (26, 6) >0   [0..1]  Order Form Amount   
Pay_Period_Amount_Override [Choice]   decimal (26, 6) >0   [0..1]  If entered, this will override the calculated value based on Order Form Amount / Frequency.   
Amount_as_Percent [Choice]   decimal (9, 6) >0   [0..1]  If entered, this will override the calculated value based on Order Form Amount / Frequency.   
Support_Type_Reference  Support_TypeObject  [1..1]  Support Type Reference   
Arrears_Over_12_Weeks  boolean  [0..1]  Arrears Over 12 Weeks   
Validation Description
Order Form Amount is required when Withholding Order Amount Type is 'Amount on Order'   
Lump Sum Support Orders must have a Support Type of 'Lump Sum'.   
Pay Period Amount Override is required for each Support Order Detail line.   
Amount as Percent is required for each Support Order Detail line.   
Order Form Amount must be 0 (zero) when Withholding Order Amount Type is 'Percent of Gross' or 'Percent of Disposable Earnings'.   
top
 

Support_TypeObject

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

Support_TypeObjectID

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

Payroll_Support_Order_Lump_Sum_Data

part of: Payroll_Involuntary_Withholding_Order_Data
Payroll Support Order Lump Sum Data
 
Parameter name Type/Value Cardinality Description Validations
Process_in_Regular_Period  boolean  [0..1]  Process in Regular Period   
Custodial_Party_Name  string  [0..1]  Custodial Party Name   
Remittance_ID_Override  string  [0..1]  Remittance ID Override   
Supports_Second_Family  boolean  [0..1]  Indicate if worker supports a second family.   
Payroll_Local_County_Authority_Reference  Payroll_Local_County_AuthorityObject  [0..1]  The Local County Authority that issued the Order.   
Dependants_Reference  Support_Order_Dependent_Data  [0..*]  Support Order Dependent Data   
Support_Order_Detail_Reference  Payroll_Support_Order_Detail_Data  [0..1]  Support Order Detail Data 
Validation Description
Order Form Amount is required when Withholding Order Amount Type is 'Amount on Order'   
Lump Sum Support Orders must have a Support Type of 'Lump Sum'.   
Pay Period Amount Override is required for each Support Order Detail line.   
Amount as Percent is required for each Support Order Detail line.   
Order Form Amount must be 0 (zero) when Withholding Order Amount Type is 'Percent of Gross' or 'Percent of Disposable Earnings'.   
 
Payroll_Local_County_Authority_FIPS_Code  string  [0..1]  The Payroll Local County Authority 3 Digit FIPS Code   
top
 

Payroll_Local_County_AuthorityObject

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

Payroll_Local_County_AuthorityObjectID

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

Wage_Assignment_Specific_Data

part of: Payroll_Involuntary_Withholding_Order_Data
Wage Assignment Specific Data
 
Parameter name Type/Value Cardinality Description Validations
Regulated_Loan  boolean  [0..1]  Identify if this Wage Assignment is for a Regulated Loan.   
Head_of_Household  boolean  [0..1]  Indicator whether employee is head of household.   
Married  boolean  [0..1]  Indicates whether Worker is married or not   
top
 

Federal_Student_Loan_Specific_Data

part of: Payroll_Involuntary_Withholding_Order_Data
Federal Student Loan Specific Data
 
Parameter name Type/Value Cardinality Description Validations
Department_of_Education_Student_Loan  boolean  [0..1]  Department of Education Student Loan   
top
 

Withholding_Order_Fee_Data

part of: Payroll_Involuntary_Withholding_Order_Data
Withholding Order Fee Data
 
Parameter name Type/Value Cardinality Description Validations
Fee_Amount  decimal (26, 6) >0   [1..1]  Fee Amount   
Fee_Type_Reference  Withholding_Order_Fee_TypeObject  [1..1]  Fee Type Reference   
Deduction_Recipient_Reference  Deduction_RecipientObject  [0..1]  Deduction Recipient Reference   
Override_Fee_Schedule  boolean  [0..1]  Override Fee Schedule   
Begin_Date  date  [0..1]  Begin Date for Fee Override   
End_Date  date  [0..1]  End Date for Fee Override. Only applicable if Fee Override is True.   
Validation Description
Fee Begin Date and Fee End Date are only valid when Override Fee Schedule = True   
Fee End Date must be on or after Fee Begin Date when Fee Schedule Override = True   
Fee Begin Date is required when Fee Schedule Override = True   
top
 

Withholding_Order_Fee_TypeObject

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

Withholding_Order_Withholding_Frequency_Data

part of: Payroll_Involuntary_Withholding_Order_Data
Withholding Order Withholding Frequency Data
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Order_Withholding_Frequency_Reference  Withholding_Order_Withholding_FrequencyObject  [0..*]  Withholding Order Withholding Frequency Reference   
Validation Description
Withholding frequency is only supported for bankruptcy withholding orders at this time.   
The withholding frequencies given are invalid for the worker's pay frequency. The worker [worker] has a pay frequency of [frequency]. Valid withholding frequencies for this worker are [valid frequencies].   
top
 

Withholding_Order_Withholding_FrequencyObject

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

Withholding_Order_Withholding_FrequencyObjectID

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

CurrencyObject

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

CurrencyObjectID

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

Address_Information_Data

part of: Payroll_Involuntary_Withholding_Order_Data
Address information
 
Parameter name Type/Value Cardinality Description Validations
@Formatted_Address  string  [1..1]  Returns the formatted address in the format specified for the country. This data is not used for inbound requests and any data provided in this element will be ignored.   
@Address_Format_Type  string  [1..1]  The format type of the address.   
@Defaulted_Business_Site_Address  boolean  [1..1]  Set to 1 if the address is a defaulted location address. If this value is 1, this address will not be processed for inbound web services.   
@Delete  boolean  [1..1]  Set this flag to true in order to delete the referenced address. If this flag is set, the Reference ID field becomes required, and all other address fields that would otherwise be required will be optional and meaningless. 
Validation Description
The referenced address is in use as a primary home address and cannot be deleted.  The referenced address is in use as a primary home address and cannot be deleted. 
 
@Do_Not_Replace_All  boolean  [1..1]  This flag controls whether or not existing non-primary address data will be replaced. A value of true means only the referenced address will be updated, or created if it does not exist or no reference was provided. This behavior is used if the flag is set to true for ANY address in the request.   
@Effective_Date  date  [1..1]  Effective date of address.   
Country_Reference  CountryObject  [0..1]  Country for the address.   
Last_Modified  dateTime  [0..1]  The moment when the address was last modified.   
Address_Line_Data  Address_Line_Information_Data  [0..*]  The address line for the address. This typically contains Street name, street number, apartment, suite number. 
Validation Description
A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request.  A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request. 
Type is required when you submit an Address Line Data.  Type is required when you submit an Address Line Data. 
The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL.  The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL. 
 
Municipality  string  [0..1]  City part of the address.   
Country_City_Reference  Country_CityObject  [0..1]  Country city for the address.   
Submunicipality_Data  Submunicipality_Information_Data  [0..*]  The submunicipality of the address.   
Country_Region_Reference  Country_RegionObject  [0..1]  The region part of the address. Typically this contains the state/province information.   
Country_Region_Descriptor  string  [0..1]  The region part of the address. Typically this contains the state/province information.   
Subregion_Data  Subregion_Information_Data  [0..*]  The subregion part of the address.   
Postal_Code  string  [0..1]  The postal code part of the address.   
Usage_Data  Communication_Method_Usage_Information_Data  [0..*]  Encapsulating element for all Communication Method Usage data.   
Number_of_Days  decimal (1, 0) >0   [0..1]  Tracks the number of days an employee works from home per week.   
Municipality_Local  string  [0..1]  City in local script part of the address.   
Address_Reference  Address_ReferenceObject  [0..1]  The address Reference ID.   
Address_ID  string  [0..1]  New ID value used in address updates. The ID cannot already be in use by another address.   
Validation Description
Postal Code is not a valid address component for certain countries.  Postal Code is not a valid address component for certain countries. 
Municipality is not a valid address component for certain countries .  Municipality is not a valid address component for certain countries . 
Postal Code is required for certain countries.  Postal Code is required for certain countries. 
Municipality is required for certain countries.  Municipality is required for certain countries. 
Region Name must be valid for the specified Country.  Region Name must be valid for the specified Country. 
Usage Type and Use For combination must be valid for Address.  Usage Type and Use For combination must be valid for Address. 
Second Address Line is required for certain countries.  Second Address Line is required for certain countries. 
Third Address Line is required for certain countries.  Third Address Line is required for certain countries. 
Fourth Address Line is required for certain countries.  Fourth Address Line is required for certain countries. 
Subregion is required for certain countries.  Subregion is required for certain countries. 
Second Subregion is required for certain countries.  Second Subregion is required for certain countries. 
Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries.  Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries. 
Second Submunicipality is required for certain countries.  Second Submunicipality is required for certain countries. 
Second Address Line is not a valid address component for certain countries.  Second Address Line is not a valid address component for certain countries. 
Third Address Line is not a valid address component for certain countries.  Third Address Line is not a valid address component for certain countries. 
Fourth Address Line is not a valid address component for certain countries.  Fourth Address Line is not a valid address component for certain countries. 
Subregion is not a valid address component for certain countries.  Subregion is not a valid address component for certain countries. 
Second Subregion is not a valid address component for certain countries.  Second Subregion is not a valid address component for certain countries. 
Submunicipality is not a valid address component for certain countries.  Submunicipality is not a valid address component for certain countries. 
Second Submunicipality is not a valid address component for certain countries.  Second Submunicipality is not a valid address component for certain countries. 
A maximum of four Submunicipalities are allowed in an address.  A maximum of four Submunicipalities are allowed in an address. 
A maximum of four Subregions are allowed in an address.  A maximum of four Subregions are allowed in an address. 
A maximum of four Address Lines are allowed in an address.  A maximum of four Address Lines are allowed in an address. 
Region is required for certain countries.  Region is required for certain countries. 
Home addresses which are not additionally used as work addresses cannot be marked as public.  Home addresses which are not additionally used as work addresses cannot be marked as public. 
[postal code] is not a valid postal code for [region]  Postal Code must be valid for the Region. 
Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 1 is not valid for this Country.  Address Line 1 is not valid for this Country. 
Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country.  Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country. 
Address Line 2 not Valid for this Country.  Address Line 2 not Valid for this Country. 
Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 3 is not Valid for this Country.  Address Line 3 is not Valid for this Country. 
Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 4 is not Valid for this Country.  Address Line 4 is not Valid for this Country. 
Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 5 is not Valid for this Country.  Address Line 5 is not Valid for this Country. 
Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 7 is not Valid for this Country.  Address Line 7 is not Valid for this Country. 
Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 8 is not Valid for this Country.  Address Line 8 is not Valid for this Country. 
Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 9 is not Valid for this Country.  Address Line 9 is not Valid for this Country. 
You cannot specify the same usage type more than once for an address.  You cannot specify the same usage type more than once for an address. 
Address Line 1 - Local is not valid for this Country.  Address Line 1 - Local is not valid for this Country. 
Municipality - Local is not a valid address component for certain countries .  Municipality - Local is not a valid address component for certain countries . 
Address Line 2 - Local is not valid for this Country.  Address Line 2 - Local is not valid for this Country. 
Address Line 3 - Local is not Valid for this Country.  Address Line 3 - Local is not Valid for this Country. 
Address Line 9 - Local is not Valid for this Country.  Address Line 9 - Local is not Valid for this Country. 
Address Line 8 - Local is not Valid for this Country.  Address Line 8 - Local is not Valid for this Country. 
Address Line 7 - Local is not Valid for this Country.  Address Line 7 - Local is not Valid for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 5 - Local is not Valid for this Country.  Address Line 5 - Local is not Valid for this Country. 
Address Line 4 - Local is not Valid for this Country.  Address Line 4 - Local is not Valid for this Country. 
City Subdivision 1 - Local is not a valid address component for certain countries.  City Subdivision 1 - Local is not a valid address component for certain countries. 
City Subdivision 2 - Local is not a valid address component for certain countries.  City Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 1 - Local is not a valid address component for certain countries.  Region Subdivision 1 - Local is not a valid address component for certain countries. 
Region Subdivision 2 - Local is not a valid address component for certain countries.  Region Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 2 is not a valid address component for certain countries.  Region Subdivision 2 is not a valid address component for certain countries. 
City Subdivision 2 is not a valid address component for certain countries.  City Subdivision 2 is not a valid address component for certain countries. 
Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country.  Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country. 
Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country.  Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country. 
Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
If one local script address field is submitted, all required local script address fields must be submitted.  If one local script address field is submitted, all required local script address fields must be submitted. 
Address Reference is required when deleting an address  Address Reference is required when deleting an address 
Usage Data is required unless address is being deleted  Usage Data is required unless address is being deleted 
Country Reference is required unless address is being deleted  Country Reference is required unless address is being deleted 
Address deletion is not supported in this web service request  Address deletion is not supported in this web service request 
If one western script field is submitted, all required western script address fields must be submitted.  If one western script field is submitted, all required western script address fields must be submitted. 
Address Reference must match an existing (and not deleted) address in use by the worker subject of this request  Address Reference must match an existing (and not deleted) address in use by the worker subject of this request 
Use a unique Address Reference ID for each address. [ID] is already used on another address.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
You can only update addresses that belong to this customer.   
You can't use an existing address for a new customer.   
Existing addresses can't be future dated. Select an effective date that is on or before today, or create a new address with a future date.   
The Address ID must match the Address Reference.   
You can't use an existing address for a new customer request.   
You can't use an existing address for a new prospect.   
You can only update addresses that belong to this customer request.   
You can only update addresses that belong to this prospect.   
Enter a postal code in the valid format: [PostalCodeValidationMessage]   
Postal Code is required for [countryWithMustHavePostalCode]   
One or more addresses are missing a Country City reference. This field is required because the City Prompt localization is active for: [countryref].   
Enter a Country City reference that is valid for: [countryref]. You entered this Country City reference: [countrycityref].   
Only Address reference belonging to the Customer tied to the Customer Contact can be shared by the Customer Contact   
International Assignment is only valid for Non-Primary Home Addresses   
Number of Days cannot be greater than 7.  Number of Days cannot be greater than 7. 
Number of Days is not allowed for the country specified.  Number of Days is not allowed for the country specified. 
You must enter a Country City reference instead of a text element because the City Prompt localization is active for: [countryref]. You entered this text element: [cityattrib] [citylocalattrib].   
You entered this Country City reference: [countrycityref]. To use this Country City reference, you must activate the City Prompt localization for: [countryref]. Perform either one of these actions: Activate the City Prompt localization. Enter a municipality instead of a Country City reference.   
Address "[ID]" is already in use by another address (possibly on another contactable). Please choose a different Address ID.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
Address Line is required for certain countries.  Address Line is required for certain countries. 
top
 

CountryObject

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

Address_Line_Information_Data

part of: Address_Information_Data
The address line for the address. This typically contains Street name, street number, apartment, suite number.
 
Parameter name Type/Value Cardinality Description Validations
#text  string     
Validation Description
A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request.  A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request. 
Type is required when you submit an Address Line Data.  Type is required when you submit an Address Line Data. 
The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL.  The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL. 
 
@Descriptor  string  [1..1]  The descriptor is an optional serialized attribute that shows the text Override Label (such as Apartment Number or Building Number) that helps describe the usage of the type (such as ADDRESS_LINE_5 and ADDRESS_LINE_6) for each country.   
@Type  string  [1..1]  Enter the address line type, such as ADDRESS_LINE_1, or ADDRESS_LINE_2.   
Validation Description
A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request.  A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request. 
Type is required when you submit an Address Line Data.  Type is required when you submit an Address Line Data. 
The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL.  The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL. 
top
 

Country_CityObject

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

Country_CityObjectID

part of: Country_CityObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Country_Subregion_Code_In_Country, Country_Subregion_Internal_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_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 of a parent object   
top
 

Submunicipality_Information_Data

part of: Address_Information_Data
The submunicipality of the address.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@Address_Component_Name  string  [1..1]  The descriptor is an optional serialized attribute that shows the text Override Label (such as Municipality or District) that helps describe the usage of the type (such as CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2) for each country.   
@Type  string  [1..1]  The city subdivision part of the address.   
top
 

Country_RegionObject

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

Country_RegionObjectID

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

Subregion_Information_Data

part of: Address_Information_Data
The subregion part of the address.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@Descriptor  string  [1..1]  The descriptor is an optional serialized attribute that shows the text Override Label (such as Municipality or District) that helps describe the usage of the type (such as REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2) for each country.   
@Type  string  [1..1]  Enter the region subdivision type, such as REGION_SUBDIVISION_1, or REGION_SUBDIVISION_2.   
top
 

Communication_Method_Usage_Information_Data

part of: Address_Information_Data
Encapsulating element for all Communication Method Usage data.
 
Parameter name Type/Value Cardinality Description Validations
@Public  boolean  [1..1]  Indicates if the address is public.   
Type_Data  Communication_Usage_Type_Data  [1..*]  Reference ID for the communication usage type.   
Use_For_Reference  Communication_Usage_BehaviorObject  [0..*]  Reference ID for communication usage behavior.   
Use_For_Tenanted_Reference  Communication_Usage_Behavior_TenantedObject  [0..*]  Reference ID for communication usage behavior tenanted.   
Comments  string  [0..1]  Description of the address, phone, email, instant messenger, or web address.   
top
 

Communication_Usage_Type_Data

part of: Communication_Method_Usage_Information_Data
Reference ID for the communication usage type.
 
Parameter name Type/Value Cardinality Description Validations
@Primary  boolean  [1..1]  Indicates if the communication method is primary.   
Type_Reference  Communication_Usage_TypeObject  [1..1]  Reference ID for the communication usage type.   
top
 

Communication_Usage_TypeObject

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

Communication_Usage_TypeObjectID

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

Communication_Usage_BehaviorObject

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

Communication_Usage_BehaviorObjectID

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

Communication_Usage_Behavior_TenantedObject

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

Communication_Usage_Behavior_TenantedObjectID

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

Address_ReferenceObject

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

Address_ReferenceObjectID

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

Put_Payroll_Involuntary_Withholding_Order_Response_Data

part of: Put_Payroll_Involuntary_Withholding_Order_Response
Put Payroll Involuntary Withholding Order Response Data
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Order_Reference  Withholding_OrderObject  [0..1]  Withholding Order Instance   
Worker_Reference  WorkerObject  [0..1]  Withholding Order Worker   
Withholding_Order_Type  string  [0..1]  Withholding Order Type   
Withholding_Order_Case_Reference  Withholding_Order_CaseObject  [0..1]  Withholding Order Case Reference   
top
 

Withholding_OrderReferenceEnumeration

part of: Withholding_OrderObjectID
Base Type
string
top
 

Support_OrderReferenceEnumeration

part of: Support_OrderObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Withholding_Order_TypeReferenceEnumeration

part of: Withholding_Order_TypeObjectID
Base Type
string
top
 

Withholding_Order_CaseReferenceEnumeration

part of: Withholding_Order_CaseObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Withholding_Order_Amount_TypeReferenceEnumeration

part of: Withholding_Order_Amount_TypeObjectID
Base Type
string
top
 

FrequencyReferenceEnumeration

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Withholding_Order_Override_Completion_CriteriaReferenceEnumeration

part of: Withholding_Order_Override_Completion_CriteriaObjectID
Base Type
string
top
 

Support_TypeReferenceEnumeration

part of: Support_TypeObjectID
Base Type
string
top
 

Payroll_Local_County_AuthorityReferenceEnumeration

part of: Payroll_Local_County_AuthorityObjectID
Base Type
string
top
 

Withholding_Order_Fee_TypeReferenceEnumeration

part of: Withholding_Order_Fee_TypeObjectID
Base Type
string
top
 

Withholding_Order_Withholding_FrequencyReferenceEnumeration

part of: Withholding_Order_Withholding_FrequencyObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Country_CityReferenceEnumeration

part of: Country_CityObjectID
Base Type
string
top
 

Base Type
string

top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top
 

Communication_Usage_TypeReferenceEnumeration

part of: Communication_Usage_TypeObjectID
Base Type
string
top
 

Communication_Usage_BehaviorReferenceEnumeration

part of: Communication_Usage_BehaviorObjectID
Base Type
string
top
 

Communication_Usage_Behavior_TenantedReferenceEnumeration

part of: Communication_Usage_Behavior_TenantedObjectID
Base Type
string
top
 

Address_ReferenceReferenceEnumeration

part of: Address_ReferenceObjectID
Base Type
string
top