Service Directory > v32.1 > Cash_Management > Get_Investment_Pool_Adjustments
 

Operation: Get_Investment_Pool_Adjustments

This service operation will get Investment Pool Adjustments 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_Adjustments_Request

This element is the top-level request element for all Investment Pool Adjustment "Get" operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Investment_Pool_Adjustment_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Investment_Pool_Adjustment_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Investment_Pool_Adjustment_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Investment_Pool_Adjustments_Response

Element containing Investment Pool Adjustment 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_Adjustment_Request_References  [0..1]  References to existing Investment Pool Adjustments.   
Request_Criteria  Investment_Pool_Adjustment_Request_Criteria  [0..1]  Element containing search criteria for Investment Pool Adjustments.   
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_Adjustment_Response_Group  [0..1]  Element containing data for existing Investment Pool Adjustments.   
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_Adjustment_Response_Data  [0..1]  Element containing data for existing Investment Pool Adjustments.   
top
 

Investment_Pool_Adjustment_Request_References

part of: Get_Investment_Pool_Adjustments_Request, Get_Investment_Pool_Adjustments_Response
References to existing Investment Pool Adjustments.
 
Parameter name Type/Value Cardinality Description Validations
Investment_Pool_Adjustment_Reference  Investment_Pool_AdjustmentObject  [1..*]  References to existing Investment Pool Adjustments.   
top
 

Investment_Pool_AdjustmentObject

part of: Investment_Pool_Adjustment_Data, Investment_Pool_Adjustment_Request_References, Investment_Pool_Adjustment
 
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_AdjustmentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Investment_Pool_AdjustmentObjectID

part of: Investment_Pool_AdjustmentObject
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  [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_Adjustment_Request_Criteria

part of: Get_Investment_Pool_Adjustments_Request, Get_Investment_Pool_Adjustments_Response
Element containing search criteria for Investment Pool Adjustments.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Investment_Pool_Adjustments_Request, Get_Investment_Pool_Adjustments_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_Adjustment_Response_Group

part of: Get_Investment_Pool_Adjustments_Request, Get_Investment_Pool_Adjustments_Response
Element containing data for existing Investment Pool Adjustments.
 
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_Adjustments_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_Adjustment_Response_Data

part of: Get_Investment_Pool_Adjustments_Response
Element containing data for existing Investment Pool Adjustments.
 
Parameter name Type/Value Cardinality Description Validations
Investment_Pool_Adjustment  Investment_Pool_Adjustment  [0..*]  Investment Pool Adjustment   
top
 

Investment_Pool_Adjustment

part of: Investment_Pool_Adjustment_Response_Data
Element containing reference to an existing Investment Pool Adjustmentr and data
 
Parameter name Type/Value Cardinality Description Validations
Investment_Pool_Adjustment_Reference  Investment_Pool_AdjustmentObject  [0..1]  Reference to an existing Investment Pool Transfer   
Investment_Pool_Adjustment_Data  Investment_Pool_Adjustment_Data  [0..*]  Investment Pool Transfer Data contains essential information about an Investment Pool Transfer   
top
 

Investment_Pool_Adjustment_Data

part of: Investment_Pool_Adjustment
Investment Pool Transfer Data contains essential information about an Investment Pool Transfer
 
Parameter name Type/Value Cardinality Description Validations
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].   
 
ID  string  [0..1]  Investment Pool Adjustment ID   
Gift_Reference  GiftObject  [1..1]  Valid Gift 
Validation Description
Gift has to be a pooled Gift .   
 
Units_to_Adjust  decimal (26, 6)   [0..1]  Number of units to adjust 
Validation Description
Adjustments cannot be submitted while other transactions are pending. The following transactions are in progress for this gift: [pending transactions]   
Either Units to Adjust or Fair Market Value should be entered, but not both. Units to Adjust entered is:[units to adjust] and Fair Market Value entered is:[fair market value]   
The Gift has a current Book Value. Total Units for the Gift must be greater than zero.   
 
Status_Reference  Document_StatusObject  [0..1]  Status Reference   
Adjustment_Fair_Market_Value  decimal (26, 6)   [0..1]  Adjustment Fair Market Value   
Original_Total_Units  decimal (26, 6)   [0..1]  Original Total Units   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
Investment_Pool_Reference  Investment_PoolObject  [0..1]  Investment Pool Reference   
Unit_Price  decimal (26, 6)   [0..1]  Unit Price   
Investment_Pool_Adjustment_Reference  Investment_Pool_AdjustmentObject  [0..1]  Investment Pool Adjustment Reference   
top
 

GiftObject

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

Document_StatusObject

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

CurrencyObject

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

Investment_PoolObject

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

Investment_Pool_AdjustmentReferenceEnumeration

part of: Investment_Pool_AdjustmentObjectID
Base Type
string
top
 

GiftReferenceEnumeration

part of: GiftObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Investment_PoolReferenceEnumeration

part of: Investment_PoolObjectID
Base Type
string
top