Service Directory > v32.1 > Payroll_GBR > Put_Direct_Earnings_Attachment_Order
 

Operation: Put_Direct_Earnings_Attachment_Order

Provides the ability to load one worker's Direct Earnings Attachment Court Order information.


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

Put Direct Earnings Attachment Order Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Court_Order_Reference  Direct_Earnings_AttachmentObject  [0..1]  Direct Earnings Attachment Reference   
Direct_Earnings_Attachment_Order_Data  Direct_Earnings_Attachment_Order_Data  [1..1]  Direct Earnings Attachment Order Data 
Validation Description
Invalid Issuing Authority for Court Order Type   
Higher Rate DEAs can not be processed within Payroll before April 2016.   
The field Frequency is required and must have a value   
The type of Court Order being edited or revised is incorrect for this request   
 
top
 

Response Element: Put_Direct_Earnings_Attachment_Order_Response

Direct Earnings Attachment Court Order Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Direct_Earnings_Attachment_Order_Reference  Direct_Earnings_AttachmentObject  [0..1]  Direct Earnings Attachment Court Order Reference   
top
 

Direct_Earnings_AttachmentObject

part of: Put_Direct_Earnings_Attachment_Order_Request, Direct_Earnings_Attachment_Order_Data, Put_Direct_Earnings_Attachment_Order_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Direct_Earnings_AttachmentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Direct_Earnings_AttachmentObjectID

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

Direct_Earnings_Attachment_Order_Data

part of: Put_Direct_Earnings_Attachment_Order_Request
Put Direct Earnings Attachment Order Request
 
Parameter name Type/Value Cardinality Description Validations
Common_Court_Order_Data  Common_Court_Order_Data  [0..*]  Common Court Order Data 
Validation Description
You must specify a Deduction Recipient   
You must specify a Worker   
You must specify a Company   
You must specify a Begin Date   
You must specify a Received Date   
You must specify an Order Date   
You must specify a Reference Number   
You must specify an Issuing Authority   
Court Order Begin Date must be on or after the Order Date   
Worker cannot be changed on a revision   
Reference Number cannot be changed on a revision   
Company cannot be changed on a revision   
Issuing Authority cannot be changed on a revision   
Invalid Issuing Authority Region, court orders are currently in force within a different jurisdiction   
Court Order End Date cannot be before Court Order Begin Date   
The Revision Order Date must be later than the Original Order Date   
The specified Company is not valid as of the Court Order Begin date   
You can't change the Worker that a Court Order is assigned to.   
The specified Company isn't valid for the worker as of the Court Order Begin date   
The type of Court Order being edited or revised is incorrect for this request   
Court Order Reference and Court Order ID are mutually exclusive you must specify one or the other   
 
Revision_Court_Order_Reference [Choice]   Direct_Earnings_AttachmentObject  [0..1]  Revision Court Order Reference   
Revision_Court_Order_ID [Choice]   string  [0..1]  Revision Court Order ID   
Higher_Rate  boolean  [0..1]  Higher Rate. This is required and mutually exclusive to Standard Rate.   
Override_Deduction_Rate  decimal (26, 6) >0   [0..1]  Override Deduction Rate.   
Frequency_Reference  FrequencyObject  [0..1]  Pay Period Frequency. Conditional, required if Override Deduction Rate is entered   
Total_Debt_Amount  decimal (26, 6) >0   [0..1]  Total Debt Amount   
Court_Order_Fee_Data  UK_Court_Order_Fee_Data  [0..*]  Court Order Fee Data 
Validation Description
Fee Amount is required and must be greater than zero   
 
Validation Description
Invalid Issuing Authority for Court Order Type   
Higher Rate DEAs can not be processed within Payroll before April 2016.   
The field Frequency is required and must have a value   
The type of Court Order being edited or revised is incorrect for this request   
top
 

Common_Court_Order_Data

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

CompanyObject

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

WorkerObject

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

Payroll_Tax_AuthorityObject

part of: Common_Court_Order_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Payroll_Tax_AuthorityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_Tax_AuthorityObjectID

part of: Payroll_Tax_AuthorityObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payroll_Federal_Authority_Tax_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Deduction_RecipientObject

part of: Common_Court_Order_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Deduction_RecipientObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Deduction_RecipientObjectID

part of: Deduction_RecipientObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Deduction_Recipient_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

FrequencyObject

part of: Direct_Earnings_Attachment_Order_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  FrequencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

FrequencyObjectID

part of: FrequencyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Frequency_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

UK_Court_Order_Fee_Data

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

Unique_IdentifierObject

part of: UK_Court_Order_Fee_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Withholding_Order_Fee_TypeObject

part of: UK_Court_Order_Fee_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Withholding_Order_Fee_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Withholding_Order_Fee_TypeObjectID

part of: Withholding_Order_Fee_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Withholding_Order_Fee_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Direct_Earnings_AttachmentReferenceEnumeration

part of: Direct_Earnings_AttachmentObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Payroll_Tax_AuthorityReferenceEnumeration

part of: Payroll_Tax_AuthorityObjectID
Base Type
string
top
 

Deduction_RecipientReferenceEnumeration

part of: Deduction_RecipientObjectID
Base Type
string
top
 

FrequencyReferenceEnumeration

part of: FrequencyObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Withholding_Order_Fee_TypeReferenceEnumeration

part of: Withholding_Order_Fee_TypeObjectID
Base Type
string
top