Service Directory > v32.1 > Cash_Management > Get_Bank_Statement_Files
 

Operation: Get_Bank_Statement_Files

This service operation will get all Bank Statement Files for the specified criteria. The response will include specific information about the Bank Statement Files such as the Bank Statement File References, File Creation Date, File Identification Number, Receiver Identification, Sender Identification, and Bank Statement References.


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

Top level 'Get' Web Service to request Bank Statement Files that have been posted.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Bank_Statement_File_Request_References  [0..1]  Element constaining all of the requested Bank Statement Files.   
Request_Criteria [Choice]   Bank_Statement_File_Request_Criteria  [0..1]  Filter the returned Bank Statement Files retrieved using the following 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_Group  Bank_Statement_File_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Bank Statement File response. If this element is not included then ALL of the Response Groups are included in the response.   
top
 

Response Element: Get_Bank_Statement_Files_Response

Top level 'Get' Web Service method that affords for queries against Bank Statement File Data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Bank_Statement_File_Request_References  [0..1]  Element constaining all of the requested Bank Statement Files.   
Request_Criteria  Bank_Statement_File_Request_Criteria  [0..1]  Filter the returned Bank Statement Files retrieved using the following 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_Group  Bank_Statement_File_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Bank Statement File response. If this element is not included then ALL of the Response Groups are included in the response.   
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  Bank_Statement_File_Response_Data  [0..1]  Element containing all instances of Bank Statement File.   
top
 

Bank_Statement_File_Request_References

part of: Get_Bank_Statement_File_Request, Get_Bank_Statement_Files_Response
Element constaining all of the requested Bank Statement Files.
 
Parameter name Type/Value Cardinality Description Validations
Bank_Statement_File_Request_Reference  Bank_Statement_FileObject  [1..*]  Bank Statement File Request Reference.   
top
 

Bank_Statement_FileObject

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

Bank_Statement_FileObjectID

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

Bank_Statement_File_Request_Criteria

part of: Get_Bank_Statement_File_Request, Get_Bank_Statement_Files_Response
Filter the returned Bank Statement Files retrieved using the following criteria.
 
Parameter name Type/Value Cardinality Description Validations
File_Creation_Date_From  date  [0..1]  File Creation Date From.   
File_Creation_Date_To  date  [0..1]  File Creation Date To.   
top
 

Response_Filter

part of: Get_Bank_Statement_File_Request, Get_Bank_Statement_Files_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
 

Bank_Statement_File_Response_Group

part of: Get_Bank_Statement_File_Request, Get_Bank_Statement_Files_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Bank Statement File response. If this element is not included then ALL of the Response Groups are included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Bank Statement File Reference data is to be included in the response.   
Include_Bank_Statement_File_Data  boolean  [0..1]  Flag indicating if the Bank Statements File data is to be included in the response.   
top
 

Response_Results

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

Bank_Statement_File_Response_Data

part of: Get_Bank_Statement_Files_Response
Element containing all instances of Bank Statement File.
 
Parameter name Type/Value Cardinality Description Validations
Bank_Statement_File  Bank_Statement_File  [0..*]  Element containing an instance of Bank Statement File.   
top
 

Bank_Statement_File

part of: Bank_Statement_File_Response_Data
Element containing an instance of Bank Statement File.
 
Parameter name Type/Value Cardinality Description Validations
Bank_Statement_File_Reference  Bank_Statement_FileObject  [0..1]  Reference to Bank Statement File.   
Bank_Statement_File_Data  Bank_Statement_File_Data  [0..*]  Element contailing an instance of Bank Statement File Data 
Validation Description
Bank Statement File is a duplicate.   
 
top
 

Bank_Statement_File_Data

part of: Bank_Statement_File
Element contailing an instance of Bank Statement File Data
 
Parameter name Type/Value Cardinality Description Validations
Bank_Statement_File_Reference_ID  string  [0..1]  Bank Statement File Reference ID. This field is a unique identifier.   
Sender_Identification  string  [0..1]  Sender Identification.   
Receiver_Identification  string  [0..1]  Receiver Identification.   
File_Creation_Date  date  [0..1]  File Creation Date.   
File_Identification_Number  string  [0..1]  File Identification Number.   
Skip_Validations  boolean  [0..1]  Skips duplicate file validation.   
Validation Description
Bank Statement File is a duplicate.   
top
 

Bank_Statement_FileReferenceEnumeration

part of: Bank_Statement_FileObjectID
Base Type
string
top