Service Directory > v32.1 > Financial_Management > Get_Funds
 

Operation: Get_Funds

This service operation will get Funds. This service will return the Fund and its associated information. The request criteria can be for a single transaction based on Reference, or all transactions can be retrieved if no Reference is specified.


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

Contains request reference, criteria, filter and response group for getting Fund data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Fund_Request_References  [0..1]  Get Funds Request References   
Request_Criteria [Choice]   Fund_Request_Criteria  [0..1]  Get Funds Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Funds Response FIlter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Funds_Response

Element containing Fund response elements including received criteria, references, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Fund_Request_References  [0..1]  Element containing reference instances for a Fund   
Request_Criteria  Fund_Request_Criteria  [0..1]  Element containing Fund request criteria   
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_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  Fund_Response_Data  [0..1]  Get Funds Response Data   
top
 

Fund_Request_References

part of: Get_Funds_Request, Get_Funds_Response
Element containing reference instances for a Fund
 
Parameter name Type/Value Cardinality Description Validations
Fund_Reference  FundObject  [1..*]  Reference to an existing Fund.   
top
 

FundObject

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

FundObjectID

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

Fund_Request_Criteria

part of: Get_Funds_Request, Get_Funds_Response
Element containing Fund request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Funds_Request, Get_Funds_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
 

Response_Results

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

Fund_Response_Data

part of: Get_Funds_Response
Wrapper Element that includes Fund Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Fund  Fund  [0..*]  Fund Data   
top
 

Fund

part of: Fund_Response_Data
Wrapper Element that includes Fund Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Fund_Reference  FundObject  [0..1]  Reference to an existing Fund.   
Fund_Data  Fund_Data  [0..*]  Fund Data   
top
 

Fund_Data

part of: Fund
Element containing all Fund Data.
 
Parameter name Type/Value Cardinality Description Validations
Fund_ID  string  [0..1]  Fund Reference ID. This is the Fund unique identifier.   
Fund_Name  string  [1..1]  Fund Name.   
Include_Fund_ID_in_Name  boolean  [0..1]  Boolean flag which when set to true will include the Fund ID in the Fund Name.   
Fund_Type_Reference  Fund_TypeObject  [0..1]  Reference to an existing Fund Type.   
Fund_is_Inactive  boolean  [0..1]  Boolean Flag which when set to true inactivates the Fund.   
top
 

Fund_TypeObject

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

Fund_TypeObjectID

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

FundReferenceEnumeration

part of: FundObjectID
Base Type
string
top
 

Fund_TypeReferenceEnumeration

part of: Fund_TypeObjectID
Base Type
string
top