Service Directory > v31.2 > Cash_Management > Get_Cash_Pools
 

Operation: Get_Cash_Pools

Retrieves the referenced Cash Pool. If there is no referenced Cash Pool, retrieves all Cash Pools.


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

The request to retrieve Cash Pools.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Cash_Pool_Request_References  [0..1]  Contains the reference to the Cash Pool.   
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. 
 
top
 

Response Element: Get_Cash_Pools_Response

The response which contains the Cash Pool data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Cash_Pool_Request_References  [0..1]  Contains the reference to the Cash Pool.   
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  Cash_Pool_Response_Data  [0..1]  Wrapper containing the response data.   
top
 

Cash_Pool_Request_References

part of: Get_Cash_Pools_Response, Get_Cash_Pools_Request
Contains the reference to the Cash Pool.
 
Parameter name Type/Value Cardinality Description Validations
Cash_Pool_Reference  Cash_PoolObject  [1..*]  Reference to the Cash Pool   
top
 

Cash_PoolObject

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

Cash_PoolObjectID

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

Response_Filter

part of: Get_Cash_Pools_Response, Get_Cash_Pools_Request
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_Cash_Pools_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
 

Cash_Pool_Response_Data

part of: Get_Cash_Pools_Response
Wrapper containing the response data.
 
Parameter name Type/Value Cardinality Description Validations
Cash_Pool  Cash_Pool  [0..*]  Response data containing the reference and data items.   
top
 

Cash_Pool

part of: Cash_Pool_Response_Data
Response data containing the reference and data items.
 
Parameter name Type/Value Cardinality Description Validations
Cash_Pool_Reference  Cash_PoolObject  [0..1]  Reference to the Cash Pool   
Cash_Pool_Data  Cash_Pool_Data  [0..*]  Cash Pool data.   
top
 

Cash_Pool_Data

part of: Cash_Pool
Cash Pool data.
 
Parameter name Type/Value Cardinality Description Validations
Cash_Pool_ID  string  [0..1]  This is the Cash Pool unique identifier. 
Validation Description
The Web Service is set to 'Add Only,' but the Cash Pool already exists.   
 
Name  string  [1..1]  The name for this Cash Pool 
Validation Description
There is an existing Cash Pool by this name. Please provide a unique name.   
 
Description  string  [0..1]  The description for this Cash Pool   
Inactive  boolean  [0..1]  This is to mark the Cash Pool as inactive. 
Validation Description
You cannot create a cash pool as Inactive.   
 
Master_Bank_Account_Reference  Financial_AccountObject  [1..1]  Reference to the Bank Account to be used as the master account for this Cash Pool.   
Sub_Bank_Accounts_Data  Sub_Bank_Accounts_Data  [0..*]  Sub Bank Accounts data. 
Validation Description
Sub account must be unique in a cash pool.   
 
top
 

Financial_AccountObject

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

Financial_AccountObjectID

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

Sub_Bank_Accounts_Data

part of: Cash_Pool_Data
Sub Bank Accounts data.
 
Parameter name Type/Value Cardinality Description Validations
Sub_Bank_Account_Reference  Financial_AccountObject  [1..1]  Reference to a Bank Account to be used as a sub account for this Cash Pool. 
Validation Description
A sub account cannot be the same as the master account.   
 
Validation Description
Sub account must be unique in a cash pool.   
top
 

Cash_PoolReferenceEnumeration

part of: Cash_PoolObjectID
Base Type
string
top
 

Financial_AccountReferenceEnumeration

part of: Financial_AccountObjectID
Base Type
string
top