Service Directory > v32.1 > Financial_Management > Get_Escheatment_Items
 

Operation: Get_Escheatment_Items

This Web Service Task allows you to get Escheatment Items based on ID or a combination of company, payment status, and date


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

Request Element for Get Escheatment Items
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Escheatment_Item_Request_References  [0..1]  Element that shows specific Escheatment Items   
Request_Criteria [Choice]   Escheatment_Item_Request_Criteria  [0..1]  Parameters available to request a set of Escheatment Items   
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. 
 
top
 

Response Element: Get_Escheatment_Items_Response

This element is a container that stores all the information about your Get Escheatment Item Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Escheatment_Item_Request_References  [0..1]  You can get Escheatment Items by specifying the ID for the element   
Request_Criteria  Escheatment_Item_Request_Criteria  [0..1]  Criteria to get Escheatment Items. You can query by a combination of company, payment status, or date.   
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_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  Escheatment_Item_Response_Data  [0..1]  Container for Escheatment Item   
top
 

Escheatment_Item_Request_References

part of: Get_Escheatment_Items_Request, Get_Escheatment_Items_Response
Element that shows specific Escheatment Items
 
Parameter name Type/Value Cardinality Description Validations
Escheatment_Item_Reference  Escheatment_ItemObject  [1..*]  Specific Escheatment Items to get. You can request by WID or Escheatment_Item_ID   
top
 

Escheatment_ItemObject

part of: Escheatment_Item_Request_References, Escheatment_WWS_Item
 
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_Request_Criteria

part of: Get_Escheatment_Items_Request, Get_Escheatment_Items_Response
Parameters available to request a set of Escheatment Items
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [0..1]  The Company for Escheatment Items you wish to query   
Escheatment_Item_Status_Reference  Document_StatusObject  [0..1]  Escheatment Item status for Escheatment Items (Approved, In Progress, etc)   
Escheatment_Item_Date  date  [0..1]  Escheatment Item Date for Escheatment Item   
Start_Date  date  [0..1]  Date Range Start Date for Escheatment Item Date   
End_Date  date  [0..1]  Date Range End Date for Escheatment Item Date   
top
 

CompanyObject

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

Document_StatusObject

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

Response_Filter

part of: Get_Escheatment_Items_Request, Get_Escheatment_Items_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Escheatment_Items_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Escheatment_Item_Response_Data

part of: Get_Escheatment_Items_Response
Container for Escheatment Item
 
Parameter name Type/Value Cardinality Description Validations
Escheatment_Item  Escheatment_WWS_Item  [0..*]  Information about Escheatment Item   
top
 

Escheatment_WWS_Item

part of: Escheatment_Item_Response_Data
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_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   
Escheatment_Item_Accounting_Date  date  [0..1]  Escheatment Item Accounting Date   
Cancel_Accounting_Date  date  [0..1]  Escheatment Item Cancel Accounting 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
 

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, Miscellaneous_Payee_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
 

Escheatment_ItemReferenceEnumeration

part of: Escheatment_ItemObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

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