Service Directory > v31.2 > Cash_Management > Submit_Investment_Pool_Sale
 

Operation: Submit_Investment_Pool_Sale

This service if for Selling Investment Pool Units


@ - 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: Submit_Investment_Pool_Sale_Request

Request Element for Selling Investing Pool Units
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Investment_Pool_Sale_Reference  Investment_Pool_SaleObject  [0..1]  Investment Pool Sale Reference   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..1]  Contains data for business processing   
Investment_Pool_Sale_Data  Investment_Pool_Sale_Data  [0..1]  Element that have data for Investment Pool Sale 
Validation Description
Units not required for ALL Unit Selection Method   
Fair Market Value not required for ALL Unit Selection Method   
 
Validation Description
Investment Pool Sale Record ID already exists.   
top
 

Response Element: Submit_Investment_Pool_Sale_Response

Response Element for Selling Investment Pool Units
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Investment_Pool_Sale_Reference  Investment_Pool_SaleObject  [0..1]  Investment Pool Sale Reference   
top
 

Investment_Pool_SaleObject

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

Financials_Business_Process_Parameters

part of: Submit_Investment_Pool_Sale_Request
Contains data for business processing
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures the Comment for the Business Process.   
top
 

Business_Process_Comment_Data

part of: Financials_Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

WorkerObjectID

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

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

WorkerReferenceEnumeration

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