Service Directory > v32.1 > Cash_Management > Get_Investment_Pool_Sales
 

Operation: Get_Investment_Pool_Sales

This service is to get the Investment Pool Sale Unit details


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

Get Investment Pool Sales Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Investment_Pool_Sale_Request_References  [0..1]  Investment Pool Sale Request References   
Request_Criteria [Choice]   Investment_Pool_Sale_Request_Criteria  [0..1]  Investment Pool Sale Request Criteria   
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  Investment_Pool_Sale_Response_Group  [0..1]  Investment Pool Sale Response Group   
top
 

Response Element: Get_Investment_Pool_Sales_Response

Get Investment Pool Sales Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Investment_Pool_Sale_Request_References  [0..1]  Investment Pool Sale Request References   
Request_Criteria  Investment_Pool_Sale_Request_Criteria  [0..1]  Investment Pool Sale Request Criteria   
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  Investment_Pool_Sale_Response_Group  [0..1]  Investment Pool Sale 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  Investment_Pool_Sale_Response_Data  [0..1]  Investment Pool Sale Response Data   
top
 

Investment_Pool_Sale_Request_References

part of: Get_Investment_Pool_Sales_Request, Get_Investment_Pool_Sales_Response
Investment Pool Sale Request References
 
Parameter name Type/Value Cardinality Description Validations
Investment_Pool_Sale_Reference  Investment_Pool_SaleObject  [1..*]  Investment Pool Sale Reference   
top
 

Investment_Pool_SaleObject

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

Investment_Pool_SaleObjectID

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

Investment_Pool_Sale_Request_Criteria

part of: Get_Investment_Pool_Sales_Request, Get_Investment_Pool_Sales_Response
Investment Pool Sale Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

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

Investment_Pool_Sale_Response_Group

part of: Get_Investment_Pool_Sales_Request, Get_Investment_Pool_Sales_Response
Investment Pool Sale Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Investment_Pool_Sale_Response_Data

part of: Get_Investment_Pool_Sales_Response
Investment Pool Sale Response Data
 
Parameter name Type/Value Cardinality Description Validations
Investment_Pool_Sale  Investment_Pool_Sale  [0..*]  Investment Pool Sale Element   
top
 

Investment_Pool_Sale

part of: Investment_Pool_Sale_Response_Data
Investment Pool Sale Element
 
Parameter name Type/Value Cardinality Description Validations
Investment_Pool_Sale_Reference  Investment_Pool_SaleObject  [0..1]  Investment Pool Sale Reference   
Investment_Pool_Sale_Data  Investment_Pool_Sale_Data  [0..*]  Data Element having data for Selling Investment Pool Units 
Validation Description
Units not required for ALL Unit Selection Method   
Fair Market Value not required for ALL Unit Selection Method   
 
top
 

Investment_Pool_Sale_Data

part of: Investment_Pool_Sale
Data Element having data for Selling Investment Pool Units
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID   
Transaction_Date  date  [1..1]  Transaction Date 
Validation Description
The Investment Pool Transaction Date cannot be set prior to the latest recorded Investment Pool Valuation Fiscal Period End Date [latest fiscal period end date for investment pool from gift].   
Cannot perform investment pool transaction for the future. The Transaction Date must be on or before the current date.   
 
Status_Reference  Document_StatusObject  [0..1]  Status Reference   
Cancel_Accounting_Date  date  [0..1]  Cancel Accounting Date 
Validation Description
Cancel Accounting Date can not be included when submitting an Investment Pool Transaction.   
 
Investment_Pool_Reference  Investment_PoolObject  [0..1]  Investment Pool Reference   
Investment_Pool_Valuation_Reference  Unique_IdentifierObject  [0..1]  Investment Pool Valuation Reference   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
Gift_Reference  GiftObject  [1..1]  Gift Reference 
Validation Description
Gift has to be a pooled Gift .   
 
Units_to_Sell  decimal (26, 6)   [0..1]  Units to Sell 
Validation Description
The number of units to sell must be greater than zero.   
Line Units is required for Manual Unit selection method.   
Either Total Units to Sell or Fair Market Value should be entered, but not both. Total Units to Sell entered is:[total units to sell] and Fair Market Value entered is:[fair market value]   
Total Transaction Units entered is: [units to sell] which is greater than Total Units for Gifts: [max units]   
 
Unit_Price  decimal (26, 6) >0   [0..1]  Unit Price   
Net_Book_Value  decimal (26, 6)   [0..1]  Net Book Value   
Unit_Selection_Method_Reference  Unique_IdentifierObject  [1..1]  Unit Selection Method Reference   
Fair_Market_Value  decimal (26, 6)   [0..1]  Fair Market Value   
Unit_Source_Data  Investment_Pool_Sale_Line_Data  [0..*]  Investment Pool Sale Line Data Element   
Validation Description
Units not required for ALL Unit Selection Method   
Fair Market Value not required for ALL Unit Selection Method   
top
 

Document_StatusObject

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

Investment_PoolObject

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

Investment_PoolObjectID

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

Unique_IdentifierObject

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

CurrencyObject

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

GiftObject

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

GiftObjectID

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

Investment_Pool_Sale_Line_Data

part of: Investment_Pool_Sale_Data
Investment Pool Sale Line Data Element
 
Parameter name Type/Value Cardinality Description Validations
Investment_Pool_Transaction_Reference  Investment_Pool_TransactionObject  [0..1]  Investment Pool Transaction Reference   
Donor_Contribution_Reference  Donor_ContributionObject  [0..1]  Donor Contribution 
Validation Description
Number of Units to sell should be equal to the total of Transaction Line Units.   
Line Amount is required for Manual Unit selection method.   
Donor Contribution ID is required for Purchase Transaction line for Manual Unit selection method.   
Currency is required for Manual Unit selection method.   
Transaction line ID is required for Manual Unit selection method.   
Line Units is required for Manual Unit selection method.   
Line Amount specified should be less than or equal to remaining amount on Transaction Line.   
Line Amount is only required for Manual Unit selection method.   
Source Transaction Line is only required for Manual Unit selection method.   
Donor Contribution ID is only required for Manual Unit selection method.   
Line Units are only required for Manual Unit selection method.   
Line Units should be less than equal to available units on Transaction Line.   
 
Type  string  [0..1]  Transaction Type   
Transaction_Date  date  [0..1]  Transaction Date   
Units  decimal (26, 6)   [0..1]  Units   
Unit_Price  decimal (26, 6)   [0..1]  Unit Price   
Amount  decimal (26, 6)   [0..1]  Amount   
Amount_Withdrawn  decimal (26, 6) >0   [0..1]  Amount Withdrawn   
top
 

Investment_Pool_TransactionObject

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

Investment_Pool_TransactionObjectID

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

Donor_ContributionObject

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

Donor_ContributionObjectID

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

Investment_Pool_SaleReferenceEnumeration

part of: Investment_Pool_SaleObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

Investment_PoolReferenceEnumeration

part of: Investment_PoolObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

GiftReferenceEnumeration

part of: GiftObjectID
Base Type
string
top
 

Investment_Pool_TransactionReferenceEnumeration

part of: Investment_Pool_TransactionObjectID
Base Type
string
top
 

Donor_ContributionReferenceEnumeration

part of: Donor_ContributionObjectID
Base Type
string
top