Service Directory > v33.1 > Payroll_CAN > Get_Canada_Income_Withholding_Orders
 

Operation: Get_Canada_Income_Withholding_Orders

Extracts all types of Income Withholding Orders for Canada.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Canada_Income_Withholding_Orders_Request

Canada Income Withholding Orders Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Canada_Income_Withholding_Order_Request_References  [0..1]  Reference number for a specific income withholding order.   
Request_Criteria [Choice]   Canada_Income_Withholding_Order_Request_Criteria  [0..1]  Filtering criteria that specifies the income withholding order to return in the response. 
Validation Description
The Withholding Order Type Criteria must be empty or include only Canada Withholding Order types.   
 
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Canada_Income_Withholding_Order_Response_Group  [0..1]  The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request, then all groups will be returned.   
top
 

Response Element: Get_Canada_Income_Withholding_Orders_Response

Response element containing instances of Income Withholding Orders and the associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Canada_Income_Withholding_Order_Request_References  [0..1]  Reference number for a specific income withholding order.   
Request_Criteria  Canada_Income_Withholding_Order_Request_Criteria  [0..1]  Filtering criteria that specifies the income withholding order to return in the response. 
Validation Description
The Withholding Order Type Criteria must be empty or include only Canada Withholding Order types.   
 
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Canada_Income_Withholding_Order_Response_Group  [0..1]  Canada Income Withholding order Response Group   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Canada_Income_Withholding_Order_Response_Data  [0..1]  Canada Income Withholding Order Response Data   
top
 

Canada_Income_Withholding_Order_Request_References

part of: Get_Canada_Income_Withholding_Orders_Request, Get_Canada_Income_Withholding_Orders_Response
Reference number for a specific income withholding order.
 
Parameter name Type/Value Cardinality Description Validations
Canada_Income_Withholding_Order_Reference  Withholding_OrderObject  [1..*]  References to the Canada income withholding orders.   
top
 

Withholding_OrderObject

part of: Canada_Income_Withholding_Order_Request_References, Canada_Income_Withholding_Order
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  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
 

Canada_Income_Withholding_Order_Request_Criteria

part of: Get_Canada_Income_Withholding_Orders_Request, Get_Canada_Income_Withholding_Orders_Response
Filtering criteria that specifies the income withholding order to return in the response.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..*]  When specified, the response will only include withholding orders for workers selected.   
Type_Reference  Withholding_Order_TypeObject  [0..*]  When specified, the response will only include withholding order types selected.   
Effective_As_Of  date  [0..1]  When specified, the response will only include withholding orders that are in effect as of the date selected.   
Case_Reference [Choice]   Withholding_Order_CaseObject  [0..*]  When specified, the response will only include the withholding orders with the case numbers selected.   
Case_Number [Choice]   string  [0..1]  When specified, the response includes any order with the exact withholding order case number.   
Validation Description
The Withholding Order Type Criteria must be empty or include only Canada Withholding Order types.   
top
 

WorkerObject

part of: Canada_Income_Withholding_Order_Request_Criteria, Canada_Income_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  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: Canada_Income_Withholding_Order_Request_Criteria, Canada_Income_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: Canada_Income_Withholding_Order_Request_Criteria, Canada_Income_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_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
 

Response_Filter

part of: Get_Canada_Income_Withholding_Orders_Request, Get_Canada_Income_Withholding_Orders_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, become effective (Also referred to as the Effective Moment). If you don't specify a date, this date defaults to today.{+4}   
As_Of_Entry_DateTime  dateTime  [0..1]  The date and time the data was entered into the system. (This field is also referred to as the Entry Moment). If the date isn't specified, the default date is the current date and time.   
Page  decimal (12, 0) >0   [0..1]  The numbered page of data Workday returns in the response. The default page is the first page(Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page. Set a value between 1 and 999. The default value is 100.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Canada_Income_Withholding_Order_Response_Group

part of: Get_Canada_Income_Withholding_Orders_Request, Get_Canada_Income_Withholding_Orders_Response
Canada Income Withholding order Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference?   
top
 

Response_Results

part of: Get_Canada_Income_Withholding_Orders_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that your request returned.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages requested. A page of data in a WWS has a 100 entry maximum.   
Page_Results  decimal (12, 0) >0   [0..1]  The number of results in the current page.   
Page  decimal (12, 0) >0   [0..1]  The page number of the data the WWS returned for your request.   
top
 

Canada_Income_Withholding_Order_Response_Data

part of: Get_Canada_Income_Withholding_Orders_Response
Canada Income Withholding Order Response Data
 
Parameter name Type/Value Cardinality Description Validations
Canada_Income_Withholding_Order  Canada_Income_Withholding_Order  [0..*]  Canada Income Withholding Order   
top
 

Canada_Income_Withholding_Order

part of: Canada_Income_Withholding_Order_Response_Data
Canada Income Withholding Order
 
Parameter name Type/Value Cardinality Description Validations
Canada_Income_Withholding_Order_Reference  Withholding_OrderObject  [0..1]  Canada Income Withholding Order   
Canada_Income_Withholding_Order_Data  Canada_Income_Withholding_Order_Data  [0..*]  Contains all income withholding order data. 
Validation Description
Termination Date must be on or after the Begin Date.   
Received Date must be on or after the Order Date.   
Begin Date must be on or after the Order Date.   
Family Maintenance Order Data is required when Withholding Order Type is Family Maintenance.   
Employee does not match the current Employee of the existing Withholding Order.   
Exempt Percent Override is not valid for [province] [type].   
Supports Family is not valid for [province] [type].   
Number of Dependants is not valid for [province] [type].   
No Exemption is not valid for [province] [type].   
The Withholding Order Type must be one of the valid Canada types: FAMILYMAINT, GARNISHMENT, PROVINCELEVY, FEDLEVYCAN, or WAGECAN.   
[tax authority] is not a valid issuing tax authority for the withholding order type: [type].   
The Withholding Order Type does not match the current Type of the existing Withholding Order for the specified Case Reference.   
Number of Child Dependents is only valid for Garnishments in Northwest Territories with a Withholding Order Date before July 1st, 2010.   
The Company cannot be changed if there are results that are deducting the case number.   
The Worker must be in the Company and the Company must have a US Business Number configured.   
Withholding Order Subject Rate Override is only valid for Garnishments in Quebec.   
Override Subject Rate must be between 0 and 1.   
 
top
 

Canada_Income_Withholding_Order_Data

part of: Canada_Income_Withholding_Order
Contains all income withholding order data.
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  WorkerObject  [1..1]  The worker on the withholding order.   
Withholding_Order_Type_Reference  Withholding_Order_TypeObject  [1..1]  The withholding order type.   
Withholding_Order_Case_Reference [Choice]   Withholding_Order_CaseObject  [1..1]  The unique Case Number listed on the withholding order issued by the government.   
Case_Number [Choice]   string  [1..1]  The unique Case Number listed on the withholding order issued by the government.   
Withholding_Order_Additional_Order_Number  string  [0..1]  An additional withholding order number.   
Order_Date  date  [1..1]  Date the withholding order was issued.   
Received_Date  dateTime  [1..1]  Date the withholding order was received.   
Begin_Date  date  [1..1]  Date the withholding order should begin.   
End_Date  date  [0..1]  Date the withholding order should end.   
Termination_Date  date  [0..1]  The date the withholding order is terminated.   
Company_Reference  CompanyObject  [0..1]  The company that employs the worker, that received the order, and is executing the withholding order.   
Inactive_Order  boolean  [0..1]  Indicates that the withholding order is inactive.   
Pay_Period_Frequency_Reference  FrequencyObject  [1..1]  Frequency of the pay period amount as indicated on the withholding order, such as weekly or monthly.   
Total_Debt_Amount  decimal (26, 6) >0   [0..1]  The total debt amount on the order.   
Issued_In_Reference  Payroll_Tax_AuthorityObject  [1..1]  The state/province that issued the order.   
Deduction_Recipient_Reference  Deduction_RecipientObject  [1..1]  The third-party recipient of the withholding order deduction or fee.   
Originating_Entity  string  [0..1]  The agency or court that issued the withholding order.   
Number_of_Dependents  decimal (2, 0) >0   [0..1]  Number of dependants to be used in the exemption calculation.   
Number_of_Child_Dependents  decimal (2, 0) >0   [0..1]  The number of child dependents for use when calculating exemptions.   
Supports_Family  boolean  [0..1]  Indicates whether the employee supports a family for the purpose of determining the exemption amount.   
No_Exemption  boolean  [0..1]  If set to True, Workday doesn't calculate exemptions for the withholding order and the full disposable earnings amount will be eligible for withholding.   
Exemption_Amount_Override  decimal (9, 2) >0   [0..1]  When specified, the exemption amount to be used in the calculation of disposable earnings.   
Exemption_Frequency_Reference  FrequencyObject  [0..1]  The frequency of the Exemption Amount Override. Unless otherwise specified, Workday defaults to using a monthly frequency.   
Exempt_Percent_Override  decimal (9, 6) >0   [0..1]  When the exemption calculation includes a percentage, the percentage to be used in the calculation of disposable earnings.   
Override_Subject_Rate  decimal (6, 3) >0   [0..1]  Override rate used in the maximum amount to withhold calculation for Quebec garnishment orders.   
Memo  string  [0..1]  Additional details.   
Non-Family_Withholding_Order_Data  Canada_Non-Family_Withholding_Order_Data  [0..*]  Non-family withholding order details. 
Validation Description
Max Additional Exemption Override can only be specified for Alberta Garnishment withholding orders.   
Amount as Percent must be greater than 0 (zero) if Withholding Order Amount Type is [percent_de] or [percent_gross]   
Pay Period Amount may only be specified when the amount type is "AMT".   
Amount as Percent may only be specified when the amount type is Percent of Gross or Percent of DE.   
 
Family_Maintenance_Order_Data  Family_Maintenance_Order_Data  [0..*]  Details for family maintenance orders. 
Validation Description
Enforcement Legislation type is only valid for British Columbia.   
Past Due Pay Period Maximum is only valid for Family Maintenance orders issued by Ontario.   
The withholding order must have at least one Order Detail row.   
Past Due Total Debt Amount specified but there are no Past Due Details for the Order.   
Past Due Pay Period Maximum Amount specified but there are no Past Due Details for the Order.   
Enforcement Legislation type is required for British Columbia.   
 
Withholding_Order_Fee_Data  Withholding_Order_Fee_Data  [0..*]  Details of the withholding order fee. 
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   
 
Currency_Reference  CurrencyObject  [0..1]  The currency. Must be Canadian Dollars (CAD).   
Withholding_Order_ID  string  [0..1]  The withholding order ID you defined.   
Validation Description
Termination Date must be on or after the Begin Date.   
Received Date must be on or after the Order Date.   
Begin Date must be on or after the Order Date.   
Family Maintenance Order Data is required when Withholding Order Type is Family Maintenance.   
Employee does not match the current Employee of the existing Withholding Order.   
Exempt Percent Override is not valid for [province] [type].   
Supports Family is not valid for [province] [type].   
Number of Dependants is not valid for [province] [type].   
No Exemption is not valid for [province] [type].   
The Withholding Order Type must be one of the valid Canada types: FAMILYMAINT, GARNISHMENT, PROVINCELEVY, FEDLEVYCAN, or WAGECAN.   
[tax authority] is not a valid issuing tax authority for the withholding order type: [type].   
The Withholding Order Type does not match the current Type of the existing Withholding Order for the specified Case Reference.   
Number of Child Dependents is only valid for Garnishments in Northwest Territories with a Withholding Order Date before July 1st, 2010.   
The Company cannot be changed if there are results that are deducting the case number.   
The Worker must be in the Company and the Company must have a US Business Number configured.   
Withholding Order Subject Rate Override is only valid for Garnishments in Quebec.   
Override Subject Rate must be between 0 and 1.   
top
 

CompanyObject

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

FrequencyObject

part of: Canada_Income_Withholding_Order_Data, Canada_Income_Withholding_Order_Data, Family_Maintenance_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: Canada_Income_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, Canada_Income_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
 

Canada_Non-Family_Withholding_Order_Data

part of: Canada_Income_Withholding_Order_Data
Non-family withholding order details.
 
Parameter name Type/Value Cardinality Description Validations
Amount_Type_Reference  Withholding_Order_Amount_TypeObject  [1..1]  Indicates whether the withholding order is for an Amount, a Percent of Disposable Earnings, or a Percent of Gross.   
Pay_Period_Amount [Choice]   decimal (26, 6) >0   [0..1]  The amount to be withheld per pay period when the Amount Type is Amount. If not specified, the maximum amount is withheld after exemptions.   
Amount_as_Percent [Choice]   decimal (9, 6) >0   [0..1]  The percent to be withheld per pay period. Required for the Percent of Disposable Earnings and Percent of Gross amount types.   
Max_Additional_Exemption_Amount_Override  decimal (9, 2) >0   [0..1]  Applies only to Alberta garnishment withholding orders. Overrides the system maximum exemption limit.   
Validation Description
Max Additional Exemption Override can only be specified for Alberta Garnishment withholding orders.   
Amount as Percent must be greater than 0 (zero) if Withholding Order Amount Type is [percent_de] or [percent_gross]   
Pay Period Amount may only be specified when the amount type is "AMT".   
Amount as Percent may only be specified when the amount type is Percent of Gross or Percent of DE.   
top
 

Withholding_Order_Amount_TypeObject

part of: Family_Maintenance_Order_Detail_Data, Canada_Non-Family_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
 

Family_Maintenance_Order_Data

part of: Canada_Income_Withholding_Order_Data
Details for family maintenance orders.
 
Parameter name Type/Value Cardinality Description Validations
Original_Order [Choice]   boolean  [1..1]  Applies only to Support Orders. You must select Original, Amended, or Terminated.   
Amended_Order [Choice]   boolean  [1..1]  Applies only to Support Orders. You must select Original, Amended, or Terminated.   
Termination_Order [Choice]   boolean  [1..1]  Applies only to Support Orders. You must select Original, Amended, or Terminated.   
Monthly_Limit  decimal (14, 2) >0   [0..1]  Monthly target deduction amount. If a non-zero value is specified, the calculation will attempt to recover any uncollected amounts during subsequent payrolls with payments dates in the same month up to this monthly amount.   
Past_Due_Total_Debt_Amount  decimal (26, 6) >0   [0..1]  The total debt amount that is past due for the withholding order.   
Past_Due_Pay_Period_Maximum  decimal (14, 2) >0   [0..1]  Applies only to Ontario withholding orders. The maximum arrears amount that may be recovered in a single payroll.   
Enforcement_Legislation_Reference  Unique_IdentifierObject  [0..1]  Applies only to family maintenance orders issued in British Columbia. Determines the exemption calculation used. Indicates whether the Family Maintenance order was issued under the Family Maintenance Enforcement Act or the Court Order Enforcement Act.   
Custodial_Party_Name  string  [0..1]  The name of the custodian for family maintenance orders.   
Remittance_ID_Override  string  [0..1]  The Remittance ID Override for family maintenance orders.   
Frequency_of_Form_Details_Reference  FrequencyObject  [1..1]  The frequency in which the detail amounts are specified on the withholding order.   
Family_Maintenance_Order_Detail_Data  Family_Maintenance_Order_Detail_Data  [0..*]  Family maintenance order details. 
Validation Description
Order Form Amount may only be specified when the amount type is "AMT".   
Amount as Percent must be greater than 0 (zero) if Withholding Order Amount Type is [percent_de] or [percent_gross]   
Amount as Percent may only be specified when the amount type is Percent of Gross or Percent of DE.   
 
Family_Maintenance_Dependant_Data  Support_Order_Dependent_Data  [0..*]  Dependents on the family maintenance order.   
Validation Description
Enforcement Legislation type is only valid for British Columbia.   
Past Due Pay Period Maximum is only valid for Family Maintenance orders issued by Ontario.   
The withholding order must have at least one Order Detail row.   
Past Due Total Debt Amount specified but there are no Past Due Details for the Order.   
Past Due Pay Period Maximum Amount specified but there are no Past Due Details for the Order.   
Enforcement Legislation type is required for British Columbia.   
top
 

Unique_IdentifierObject

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

Family_Maintenance_Order_Detail_Data

part of: Family_Maintenance_Order_Data
Family maintenance order details.
 
Parameter name Type/Value Cardinality Description Validations
Support_Type_Reference  Support_TypeObject  [1..1]  The support type.   
Amount_Type_Reference  Withholding_Order_Amount_TypeObject  [0..1]  Indicates whether the withholding order is for an Amount, a Percent of Disposable Earnings, or a Percent of Gross.   
Order_Form_Amount [Choice]   decimal (26, 6) >0   [0..1]  Required when the amount type is Amount. Indicates the amount on the withholding order.   
Amount_as_Percent [Choice]   decimal (9, 6) >0   [0..1]  The percent to be withheld per pay period. Required for the Percent of Disposable Earnings and Percent of Gross amount types.   
Tax_Deductible  boolean  [0..1]  The amount withheld reduces taxable wages.   
Validation Description
Order Form Amount may only be specified when the amount type is "AMT".   
Amount as Percent must be greater than 0 (zero) if Withholding Order Amount Type is [percent_de] or [percent_gross]   
Amount as Percent may only be specified when the amount type is Percent of Gross or Percent of DE.   
top
 

Support_TypeObject

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

Support_Order_Dependent_Data

part of: Family_Maintenance_Order_Data
Support Order Dependent Data
 
Parameter name Type/Value Cardinality Description Validations
Child_s_Name__Last__First__MI_  string  [1..1]  Name of the child (Last, First, MI).   
Child_s_Birth_Date  date  [1..1]  Birth date of the child.   
top
 

Withholding_Order_Fee_Data

part of: Canada_Income_Withholding_Order_Data
Details of the withholding order fee.
 
Parameter name Type/Value Cardinality Description Validations
Fee_Amount  decimal (26, 6) >0   [1..1]  The amount of the fee.   
Fee_Type_Reference  Withholding_Order_Fee_TypeObject  [1..1]  The type of fee.   
Deduction_Recipient_Reference  Deduction_RecipientObject  [0..1]  The third-party recipient of the withholding order deduction or fee.   
Override_Fee_Schedule  boolean  [0..1]  Schedule for the override fee.   
Begin_Date  date  [0..1]  The date the Fee Override begins.   
End_Date  date  [0..1]  The date the Fee Override ends.   
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
 

CurrencyObject

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

Withholding_OrderReferenceEnumeration

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

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
 

Withholding_Order_Amount_TypeReferenceEnumeration

part of: Withholding_Order_Amount_TypeObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Support_TypeReferenceEnumeration

part of: Support_TypeObjectID
Base Type
string
top
 

Withholding_Order_Fee_TypeReferenceEnumeration

part of: Withholding_Order_Fee_TypeObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top