Service Directory > v31.2 > Settlement_Services > Submit_Escheatment_Items
 

Operation: Submit_Escheatment_Items

This Web Service allows you to update or add a new escheatment Item to a payment


@ - 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: Submit_Escheatment_Items_Request

Escheatment Item Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Organization_Reference  OrganizationObject  [1..1]  Reference to Organization or Company. All Payments should fall under this Organization. This is the Organization against which the BP will trigger.   
Financials_Business_Process_Parameters  Financials_Business_Process_Parameters  [0..1]  Business Process Parameters   
Escheatment_Item  Escheatment_Item  [0..1]  Data for Multiple Escheatment Items   
top
 

Response Element: Submit_Escheatment_Items_Response

Response element for Put Escheatment Items
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Escheatment_Item_Reference  Escheatment_ItemObject  [0..*]  Escheatment Items   
top
 

OrganizationObject

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

OrganizationObjectID

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

Financials_Business_Process_Parameters

part of: Submit_Escheatment_Items_Request
Contains data for business processing
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures the Comment for the Business Process.   
top
 

Business_Process_Comment_Data

part of: Financials_Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

Escheatment_Item

part of: Submit_Escheatment_Items_Request
Data for Multiple Escheatment Items
 
Parameter name Type/Value Cardinality Description Validations
Escheatment_WWS_Item  Escheatment_WWS_Item  [0..*]  Stores Information about an Escheatment Item   
top
 

Escheatment_WWS_Item

part of: Escheatment_Item
Stores Information about an Escheatment Item
 
Parameter name Type/Value Cardinality Description Validations
Escheatment_Item_Reference  Escheatment_ItemObject  [0..1]  Reference to the Escheatment Item   
Escheatment_Item_Data  Escheatment_Item_Data  [0..1]  Escheatment Item Data (Company, Item Status, Date, Payment) 
Validation Description
Payments to be escheated must be part of the entered Organization   
 
top
 

Escheatment_ItemObject

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

Escheatment_ItemObjectID

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

Escheatment_Item_Data

part of: Escheatment_WWS_Item
Escheatment Item Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Reference ID for Escheatment Item   
Submit  boolean  [0..1]  Indicates whether Item will through BP Process   
Company_Reference  CompanyObject  [0..1]  Company for Escheatment Item. Note that this field is not enterable. The Company will be derived from the Payment.   
Payment_Reference  PaymentObject  [1..1]  Payment for Escheatment Item 
Validation Description
Selected Payment is not Escheatable   
 
Escheatment_Item_Date  date  [0..1]  Escheatment Item Date   
Payment_Category_Reference  Payment_CategoryObject  [0..1]  Payment Category derived from Payment Reference   
Payment_Type_Reference  Payment_TypeObject  [0..1]  Payment Type derived from Payment Reference   
Payee_Reference  PayeeObject  [0..1]  Payee Derived from Payment Reference   
Payment_Date  date  [0..1]  Payment Date Derived from Payment Reference   
Escheatment_Amount  decimal (36, 6) >0   [0..1]  Escheatment Amount   
Currency_Reference  CurrencyObject  [0..1]  Currency Derived from Payment Reference   
Remit_To_Address  string  [0..1]  Remit to Address Derived from Payment Reference   
Payment_Notification_Date  date  [0..1]  Payment Notification Date- Derived from Payment   
Escheatment_Item_Status_Reference  Document_StatusObject  [0..1]  Status for Escheatment Item (In Progress, Approved, etc)   
Base_Amount  decimal (26, 6)   [0..1]  Escheatment Item Base Amount   
Validation Description
Payments to be escheated must be part of the entered Organization   
top
 

CompanyObject

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

PaymentObject

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

PaymentObjectID

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

Payment_CategoryObject

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

Payment_CategoryObjectID

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

Payment_TypeObject

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

Payment_TypeObjectID

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

PayeeObject

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

PayeeObjectID

part of: PayeeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Person_ID, Ad_hoc_Payee_ID, Applicant_ID, Company_Reference_ID, Contingent_Worker_ID, Corporate_Credit_Card_Account_ID, Customer_ID, Customer_Reference_ID, Deduction_Recipient_ID, Employee_ID, External_Committee_Member_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investor_ID, Organization_Reference_ID, Sponsor_ID, Sponsor_Reference_ID, Student_ID, Student_Proxy_ID, Supplier_Connection_ID, Supplier_ID, Supplier_Reference_ID, Tax_Authority_ID, Tax_Authority_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
 

CurrencyObject

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

Document_StatusObject

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

Document_StatusObjectID

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

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Escheatment_ItemReferenceEnumeration

part of: Escheatment_ItemObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

PaymentReferenceEnumeration

part of: PaymentObjectID
Base Type
string
top
 

Payment_CategoryReferenceEnumeration

part of: Payment_CategoryObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

PayeeReferenceEnumeration

part of: PayeeObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top