Service Directory > v32.1 > Cash_Management > Get_Investment_Statements
 

Operation: Get_Investment_Statements

This service operation will add or update Investment Statement Data.


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

This element is the top-level request element for Get Investment Statement.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Investment_Statement_Request_References  [0..1]  Element containing references to existing Investment Statements.   
Request_Criteria [Choice]   Investment_Statement_Request_Criteria  [0..1]  Element containing search criteria for Investment Statements.   
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_Statement_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in   
top
 

Response Element: Get_Investment_Statements_Response

Element containing Investment Statement response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Investment_Statement_Request_References  [0..1]  Element containing references to existing Investment Statements.   
Request_Criteria  Investment_Statement_Request_Criteria  [0..1]  Element containing search criteria for Investment Statements.   
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_Statement_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in   
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_Statement_Response_Data  [0..1]  Element containing data for existing Investment Statements.   
top
 

Investment_Statement_Request_References

part of: Get_Investment_Statements_Request, Get_Investment_Statements_Response
Element containing references to existing Investment Statements.
 
Parameter name Type/Value Cardinality Description Validations
Investment_Statement_Reference  Investment_StatementObject  [1..*]  References to existing Investment Statements   
top
 

Investment_StatementObject

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

Investment_StatementObjectID

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

part of: Get_Investment_Statements_Request, Get_Investment_Statements_Response
Element containing search criteria for Investment Statements.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Investment_Statements_Request, Get_Investment_Statements_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_Statement_Response_Group

part of: Get_Investment_Statements_Request, Get_Investment_Statements_Response
Wrapper element around a list of elements representing the amount of data that should be included in
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Investment Statements Reference data is to be included in the response.   
top
 

Response_Results

part of: Get_Investment_Statements_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_Statement_Response_Data

part of: Get_Investment_Statements_Response
Element containing data for existing Investment Statements.
 
Parameter name Type/Value Cardinality Description Validations
Investment_Statement  Investment_Statement  [0..*]  Element containing reference to existing Investment Statement and data.   
top
 

Investment_Statement

part of: Investment_Statement_Response_Data
Element containing reference to existing Investment Statement and data.
 
Parameter name Type/Value Cardinality Description Validations
Investment_Statement_Reference  Investment_StatementObject  [0..1]  Reference to an existing Investment Statement   
Investment_Statement_Data  Investment_Statement_Data  [0..1]  Element containing essential Investment Statement data 
Validation Description
The sum of line amounts must equal the difference between the beginning and ending balance, [amount].  The sum of line amounts must equal the difference between the beginning and ending balance. 
Investment Statement already exists for this statement date.  Investment Statement already exists for this statement date. 
You cannot create or modify an Investment Statement with a Statement Date that is prior to any existing Investment Statements.  You cannot create or modify an Investment Statement with a Statement Date that is prior to any existing Investment Statements. 
Statement Beginning Date must be earlier than Statement Ending Date.   
You cannot update cancelled investment statements.  You cannot update cancelled investment statements. 
 
top
 

Investment_Statement_Data

part of: Investment_Statement
Element containing essential Investment Statement data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Donor Contribution ID   
Submit  boolean  [0..1]  Save and Submit   
Cancel_Accounting_Date  date  [0..1]  Cancel Accounting Date 
Validation Description
Cancel Accounting Date can not be included when submitting an Investment Statement.   
 
Investment_Profile_Reference  Investment_ProfileObject  [1..1]  Reference to the Investment Profile that sent the Investment Statement   
Statement_Beginning_Date  date  [0..1]  The Investment Statement covers activity starting on this date. 
Validation Description
Your latest Investment Statement Date is [latest statement date]. Because your new investment statement must be in sequential order, enter [beginning statement date] for the Investment Statement Beginning Date.   
 
Statement_Date  date  [1..1]  The Investment Statement covers activity until this date. 
Validation Description
Cannot perform investment pool transaction for the future. The Transaction Date must be on or before the current date.   
The Investment Statement 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].   
 
Ending_Balance  decimal (26, 6)   [0..1]  The net activity amount including the Investment Statement activity.   
Memo  string  [0..1]  Memo for the Investment Statement   
Investment_Statement_Line_Data  Investment_Statement_Line_Data  [0..*]  Element containing essential Investment Statement Line data   
Attachment_Data  Financials_Attachment_Data  [0..*]  Encapsulating element containing all Business Document Attachment data. 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Validation Description
The sum of line amounts must equal the difference between the beginning and ending balance, [amount].  The sum of line amounts must equal the difference between the beginning and ending balance. 
Investment Statement already exists for this statement date.  Investment Statement already exists for this statement date. 
You cannot create or modify an Investment Statement with a Statement Date that is prior to any existing Investment Statements.  You cannot create or modify an Investment Statement with a Statement Date that is prior to any existing Investment Statements. 
Statement Beginning Date must be earlier than Statement Ending Date.   
You cannot update cancelled investment statements.  You cannot update cancelled investment statements. 
top
 

Investment_ProfileObject

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

Investment_ProfileObjectID

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

part of: Investment_Statement_Data
Element containing essential Investment Statement Line data
 
Parameter name Type/Value Cardinality Description Validations
Investment_Statement_Line_Type_Reference  Investment_Statement_Line_TypeObject  [1..1]  Reference to an Investment Statement Line Type, which links the amount to a spend or revenue category   
Amount  decimal (26, 6)   [0..1]  Line Amount   
Memo  string  [0..1]  Memo for the Investment Statement Line   
top
 

Investment_Statement_Line_TypeObject

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

Investment_Statement_Line_TypeObjectID

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

Financials_Attachment_Data

part of: Investment_Statement_Data
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

Investment_StatementReferenceEnumeration

part of: Investment_StatementObjectID
Base Type
string
top
 

Investment_ProfileReferenceEnumeration

part of: Investment_ProfileObjectID
Base Type
string
top
 

Investment_Statement_Line_TypeReferenceEnumeration

part of: Investment_Statement_Line_TypeObjectID
Base Type
string
top