Service Directory > v31.2 > Cash_Management > Get_Investment_Pool_Purchases
 

Operation: Get_Investment_Pool_Purchases

This service operation will get Investment Pool Purchases for the specified criteria.


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

This element is the top-level request element for all Investment Pool Purchase "Get" operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Investment_Pool_Purchase_Request_References  [0..1]  Element containing references to existing Investment Pool Purchase Records.   
Request_Criteria [Choice]   Investment_Pool_Purchase_Request_Criteria  [0..1]  Element containing search criteria for Investment Pool Purchases.   
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_Purchase_Response_Group  [0..1]  Element containing data for existing Investment Pool Purchases.   
top
 

Response Element: Get_Investment_Pool_Purchases_Response

Element containing Investment Pool Purchase response elements including echoed request data and request result
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Investment_Pool_Purchase_Request_References  [0..1]  Element containing references to existing Investment Pool Purchase Records.   
Request_Criteria  Investment_Pool_Purchase_Request_Criteria  [0..1]  Element containing search criteria for Investment Pool Purchases.   
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_Purchase_Response_Group  [0..1]  Element containing data for existing Investment Pool Purchases.   
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_Purchase_Response_Data  [0..1]  Element containing data for existing Investment Pool Purchases.   
top
 

Investment_Pool_Purchase_Request_References

part of: Get_Investment_Pool_Purchases_Request, Get_Investment_Pool_Purchases_Response
Element containing references to existing Investment Pool Purchase Records.
 
Parameter name Type/Value Cardinality Description Validations
Investment_Pool_Purchase_Record_Reference  Investment_Pool_PurchaseObject  [1..*]  References to existing Investment Pool Purchases.   
top
 

Investment_Pool_PurchaseObject

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

Investment_Pool_PurchaseObjectID

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

part of: Get_Investment_Pool_Purchases_Request, Get_Investment_Pool_Purchases_Response
Element containing search criteria for Investment Pool Purchases.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Investment_Pool_Purchases_Request, Get_Investment_Pool_Purchases_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_Purchase_Response_Group

part of: Get_Investment_Pool_Purchases_Request, Get_Investment_Pool_Purchases_Response
Element containing data for existing Investment Pool Purchases.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Investment Pool Purchase Reference data is to be included in the response   
top
 

Response_Results

part of: Get_Investment_Pool_Purchases_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_Purchase_Response_Data

part of: Get_Investment_Pool_Purchases_Response
Element containing data for existing Investment Pool Purchases.
 
Parameter name Type/Value Cardinality Description Validations
Investment_Pool_Purchase  Investment_Pool_Purchase  [0..*]  Element containing reference to an existing Investment Pool Purchase Record and data   
top
 

Investment_Pool_Purchase

part of: Investment_Pool_Purchase_Response_Data
Element containing reference to an existing Investment Pool Purchase Record and data
 
Parameter name Type/Value Cardinality Description Validations
Investment_Pool_Purchase_Reference  Investment_Pool_PurchaseObject  [0..1]  Reference to an existing Investment Pool Purchase   
Investment_Pool_Purchase_Data  Investment_Pool_Purchase_Data  [0..1]  Investment Pool Purchase Data contains essential information about an Investment Pool Purchase 
Validation Description
Donor Contributions may only be used once to purchase investment pool units.  Donor Contributions may only be used once to purchase investment pool units. 
The following worktag type(s) are required: [missing]   
The following worktag type(s) are invalid: [invalid]   
 
Investment_Pool_Purchase_Value  Investment_Pool_Purchase_Value  [0..1]  Element containing additional Investment Pool Purchase Record data.   
top
 

Investment_Pool_Purchase_Data

part of: Investment_Pool_Purchase
Investment Pool Purchase Data contains essential information about an Investment Pool Purchase
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Investment Pool Purchase ID   
Submit  boolean  [0..1]  Save and Submit   
Gift_Reference  GiftObject  [1..1]  Gift Reference 
Validation Description
The selected gift, [gift], does not have any donor contributions available to use for purchasing investment pool units.  Gift must have donor contributions available to use for purchasing investment pool units. 
Gift has to be a pooled Gift .   
 
Transaction_Date  date  [1..1]  Transaction Date is the day the investment pool units were purchased. 
Validation Description
Cannot purchase investment pool units in the future. The Transaction Date must be on or before the current date.  Cannot purchase investment pool units in the future. The Transaction Date must be on or before the current date. 
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].   
 
Purchase_Date  date  [1..1]  Purchase Date determines the default unit price for the purchase by selecting the Investment Pool Valuation for that date. 
Validation Description
The Default Purchase Date cannot be in the future.  Purchase Date cannot be in the future. 
[pool] does not have a Pool Valuation for the Default Purchase Date, [date].  Purchase Date must be in fiscal period with an Investment Pool Valuation for the Investment Pool containing the selected Gift. 
 
Worktags_Reference  Accounting_WorktagObject  [0..*]  Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize. Each transaction can include one value for each worktag type and is subject to configurable validation when submitted for approval. 
Validation Description
[list of worktag types] not valid for this transaction  Worktags must be one of the types allowed for the Investment Pool Purchase transaction. 
Select a balancing worktag for Worktags of the following type: [type]  Worktags must include a Balancing Worktag when worktag balancing is enabled. 
Only one worktag of each type is allowed  Only one worktag of each type is allowed 
[partitionable] is not allowed to be used by [gift company].   
[worktag value] is not permitted as an allowed value for worktag type: [worktag type], because it is inactive.   
 
Investment_Pool_Purchase_Line_Data  Investment_Pool_Purchase_Line_Data  [0..*]  Investment Pool Purchase Line Data   
Validation Description
Donor Contributions may only be used once to purchase investment pool units.  Donor Contributions may only be used once to purchase investment pool units. 
The following worktag type(s) are required: [missing]   
The following worktag type(s) are invalid: [invalid]   
top
 

GiftObject

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

Accounting_WorktagObject

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

Accounting_WorktagObjectID

part of: Accounting_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Income_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, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_ID, Program_of_Study_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_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
 

Investment_Pool_Purchase_Line_Data

part of: Investment_Pool_Purchase_Data
Investment Pool Purchase Record Line Data contains essential information on one Investment Pool Purchase Record Line.
 
Parameter name Type/Value Cardinality Description Validations
Donor_Contribution_Reference  Donor_ContributionObject  [1..1]  Reference to a Donor Contribution for the referenced Gift 
Validation Description
[contribution] is not available to purchase investment pool units. Confirm that [contribution] is approved, is for the selected gift ([gift]), and has not been used on another approved purchase record.  Donor Contribution must not have been referenced on another Investment Pool Purchase Record. 
 
Override_Default_Unit_Price  boolean  [0..1]  If Override Default Unit Price is set, the line Purchase Date and Unit Price overrides the default values from the header.   
Purchase_Date  date  [0..1]  Purchase Date determines the unit price to use on the line by selecting the Investment Pool Valuation for that date. 
Validation Description
[pool] does not have a Pool Valuation for [date].  Purchase Date must be in fiscal period with an Investment Pool Valuation for the Investment Pool containing the selected Gift. 
The Purchase Date cannot be in the future.  Purchase Date cannot be in the future. 
Purchase Date is required when Override is set.  Purchase Date is required when Override Default Unit Price is set. 
 
Unit_Price  decimal (26, 6)   [0..1]  If provided, the line Unit Price overrides the unit price selected by the line Purchase Date.   
top
 

Donor_ContributionObject

part of: Investment_Pool_Purchase_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_Purchase_Value

part of: Investment_Pool_Purchase
Element containing additional Investment Pool Purchase Record data.
 
Parameter name Type/Value Cardinality Description Validations
Status  string  [0..1]  Status of the Investment Pool Purchase Record   
Investment_Pool_Valuation_Reference  Unique_IdentifierObject  [0..1]  Reference to the Investment Pool Valuation selected by the Purchase Date and used to determine the Default Unit Price for the purchase   
Default_Unit_Price  decimal (26, 6) >0   [0..1]  Default Unit Price is the unit price on the referenced Investment Pool Valuation.   
Units_Purchased  decimal (26, 6)   [0..1]  Total Units Purchased for the referenced Gift.   
Total_Amount_Purchased  decimal (26, 6)   [0..1]  Total Amount Purchased for the referenced Gift.   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
Reinvestment  boolean  [0..1]  Indicates that the units were purchased using distributed income when set   
top
 

Unique_IdentifierObject

part of: Investment_Pool_Purchase_Value
 
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_Purchase_Value
 
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
 

Investment_Pool_PurchaseReferenceEnumeration

part of: Investment_Pool_PurchaseObjectID
Base Type
string
top
 

GiftReferenceEnumeration

part of: GiftObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top
 

Donor_ContributionReferenceEnumeration

part of: Donor_ContributionObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top