Service Directory > v31.2 > Cash_Management > Get_Investment_Pool_Transfers
 

Operation: Get_Investment_Pool_Transfers

This service operation will get Investment Pool Transfers 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_Transfers_Request

This element is the top-level request element for all Investment Pool Transfer "Get" operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Investment_Pool_Transfer_Request_References  [0..1]  References to existing Investment Pool Transfers.   
Request_Criteria [Choice]   Investment_Pool_Transfer_Request_Criteria  [0..1]  Element containing search criteria for Investment Pool Transfers.   
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_Transfer_Response_Group  [0..1]  Element containing data for existing Investment Pool Transfers.   
top
 

Response Element: Get_Investment_Pool_Transfers_Response

Element containing Investment Pool Transfer 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_Transfer_Request_References  [0..1]  References to existing Investment Pool Transfers.   
Request_Criteria  Investment_Pool_Transfer_Request_Criteria  [0..1]  Element containing search criteria for Investment Pool Transfers.   
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_Transfer_Response_Group  [0..1]  Element containing data for existing Investment Pool Transfers.   
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_Transfer_Response_Data  [0..1]  Element containing data for existing Investment Pool Transfers.   
top
 

Investment_Pool_Transfer_Request_References

part of: Get_Investment_Pool_Transfers_Request, Get_Investment_Pool_Transfers_Response
References to existing Investment Pool Transfers.
 
Parameter name Type/Value Cardinality Description Validations
Investment_Pool_Transfer_Reference  Investment_Pool_TransferObject  [1..*]  References to existing Investment Pool Transfers.   
top
 

Investment_Pool_TransferObject

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

Investment_Pool_TransferObjectID

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

Investment_Pool_Transfer_Request_Criteria

part of: Get_Investment_Pool_Transfers_Request, Get_Investment_Pool_Transfers_Response
Element containing search criteria for Investment Pool Transfers.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Investment_Pool_Transfers_Request, Get_Investment_Pool_Transfers_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_Transfer_Response_Group

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

Response_Results

part of: Get_Investment_Pool_Transfers_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_Transfer_Response_Data

part of: Get_Investment_Pool_Transfers_Response
Element containing data for existing Investment Pool Transfers.
 
Parameter name Type/Value Cardinality Description Validations
Investment_Pool_Transfer  Investment_Pool_Transfer  [0..*]  Element containing reference to an existing Investment Pool Transfer and data   
top
 

Investment_Pool_Transfer

part of: Investment_Pool_Transfer_Response_Data
Element containing reference to an existing Investment Pool Transfer and data
 
Parameter name Type/Value Cardinality Description Validations
Investment_Pool_Transfer_Reference  Investment_Pool_TransferObject  [0..1]  Reference to an existing Investment Pool Transfer   
Investment_Pool_Transfer_Data  Investment_Pool_Transfer_Data  [0..*]  Investment Pool Transfer Data contains essential information about an Investment Pool Transfer 
Validation Description
The source and destination Gift may not be the same.   
The source and destination Gift must belong to the same Investment Pool.   
The following worktag type(s) are required: [missing]   
The following worktag(s) are invalid: [invalid]   
Units not required for ALL Unit Selection Method   
Fair Market Value not required for ALL Unit Selection Method   
 
top
 

Investment_Pool_Transfer_Data

part of: Investment_Pool_Transfer
Investment Pool Transfer Data contains essential information about an Investment Pool Transfer
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Investment Pool Transfer ID   
Transaction_Date  date  [1..1]  Transaction Date is the day the units were transferred 
Validation Description
Cannot perform investment pool transaction for 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].   
 
Status  string  [0..1]  Indicates the status of the transfer   
Source_Gift_Reference  GiftObject  [1..1]  Reference to the Gift that was the source of the transferred units 
Validation Description
Source Gift should be a pooled gift.   
 
Destination_Gift_Reference  GiftObject  [1..1]  Reference to the Gift that received the transferred units 
Validation Description
The Destination Gift must belong to the Source Gift's Company: [company].   
Destination Gift should be a pooled gift.   
 
Investment_Pool_Reference  Investment_PoolObject  [0..1]  Reference to the Investment Pool that contains the source and destination Gifts   
Investment_Pool_Valuation_Reference  Unique_IdentifierObject  [0..1]  Reference to the Investment Pool Valuation that determined the fair market value of the transferred units   
Currency_Reference  CurrencyObject  [0..1]  Reference to the transaction currency   
Unit_Price  decimal (26, 6) >0   [0..1]  The fair market value of each transferred unit   
Total_Units_Transferred  decimal (26, 6)   [0..1]  The total number of transferred units 
Validation Description
Either Total Units Transferred or Fair Market Value should be entered Total Units Transferred entered is:[total units transferred] and Fair Market Value entered is:[fair market value]   
Total Transaction Units entered is: [units to transfer] which is greater than Total Units for Gifts: [max units]   
The number of units to transfer must be greater than zero.   
 
Fair_Market_Value  decimal (26, 6) >0   [0..1]  The total fair market value of the transferred units   
Net_Book_Value  decimal (26, 6)   [0..1]  The total book value transferred   
Unit_Selection_Method_Reference  Unique_IdentifierObject  [1..1]  Reference to the Unit Selection Method used to determine which units to transfer 
Validation Description
Unit Selection Method is: [unit selection method] which is not allowed. Allowed Unit Selection Methods are: [allowed unit selection methods]   
 
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
Remove these worktag types that aren't valid for this transaction: [list of worktag types].   
Only one worktag of each type is allowed   
Select a balancing worktag for Worktags of the following type: [type]   
[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.   
 
Unit_Source_Data  Investment_Pool_Transfer_Line_Data  [0..*]  Unit Source Data contains essential information on one unit source for the Investment Pool Transfer   
Validation Description
The source and destination Gift may not be the same.   
The source and destination Gift must belong to the same Investment Pool.   
The following worktag type(s) are required: [missing]   
The following worktag(s) are invalid: [invalid]   
Units not required for ALL Unit Selection Method   
Fair Market Value not required for ALL Unit Selection Method   
top
 

GiftObject

part of: Investment_Pool_Transfer_Data, Investment_Pool_Transfer_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_PoolObject

part of: Investment_Pool_Transfer_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_Transfer_Data, Investment_Pool_Transfer_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_Transfer_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
 

Accounting_WorktagObject

part of: Investment_Pool_Transfer_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_Transfer_Line_Data

part of: Investment_Pool_Transfer_Data
Unit Source Data contains essential information on one unit source for the Investment Pool Transfer
 
Parameter name Type/Value Cardinality Description Validations
Investment_Pool_Transaction_Reference  Investment_Pool_TransactionObject  [0..1]  Reference to the Investment Pool Transaction that provided units to transfer   
Donor_Contribution_Reference  Donor_ContributionObject  [0..1]  Donor Contribution 
Validation Description
Donor Contribution ID is required for Purchase Transaction line for Manual Unit selection method.   
Line Amount is required for Manual Unit selection method.   
Number of Units to sell should be equal to the total of Transaction Line Units.   
Line Amount specified should be less than or equal to remaining amount on Transaction Line.   
Transaction line ID is required for Manual Unit selection method.   
Line Units is required for Manual Unit selection method.   
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]  The type of transaction used as a unit source   
Transaction_Date  date  [0..1]  The date the unit source transaction took place   
Unit_Price  decimal (26, 6)   [0..1]  The unit price used to acquire the units and determine book value   
Units  decimal (26, 6)   [0..1]  The number of units transferred from this unit source   
Amount  decimal (26, 6)   [0..1]  The book value transferred from this unit source   
Amount_Withdrawn  decimal (26, 6) >0   [0..1]  The book value that was later withdrawn from this transfer   
top
 

Investment_Pool_TransactionObject

part of: Investment_Pool_Transfer_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_Transfer_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_TransferReferenceEnumeration

part of: Investment_Pool_TransferObjectID
Base Type
string
top
 

GiftReferenceEnumeration

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

Accounting_WorktagReferenceEnumeration

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