Service Directory > v31.2 > Cash_Management > Get_Bank_Statements
 

Operation: Get_Bank_Statements

This service operation will get all Bank Statement Files for the specified criteria. The response will include specific information about Bank Statements.


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

Top level 'Get' Web Service to request Bank Statements Files matching the filter criteria.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Bank_Statements_Request_References  [0..1]  Bank Statements Reference element contains the specific instance set containing the requested Bank Statements.   
Request_Criteria [Choice]   Bank_Statements_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the Bank Statements Request specific criteria needed to search for instances. All of the elements are "AND" conditions. There are currently no elements.   
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_Statements_Request_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Bank Statements response. If this element is not included then ALL of the Response Groups are included in the response.   
top
 

Response Element: Get_Bank_Statements_Response

Element containing Bank Statements response elements including echoed request data and request result data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Bank_Statements_Request_References  [0..1]  Bank Statements Reference element contains the specific instance set containing the requested Bank Statements.   
Request_Criteria  Bank_Statements_Request_Criteria  [0..1]  This element is the wrapper around a list of elements representing the Bank Statements Request specific criteria needed to search for instances. All of the elements are "AND" conditions. There are currently no elements.   
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_Statements_Request_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Bank Statements 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_Response_Data  [0..1]  This element content contains the Bank Statements Response Data element.   
top
 

Bank_Statements_Request_References

part of: Get_Bank_Statements_Request, Get_Bank_Statements_Response
Bank Statements Reference element contains the specific instance set containing the requested Bank Statements.
 
Parameter name Type/Value Cardinality Description Validations
Bank_Statements_Request_Reference  Bank_StatementObject  [1..*]  Instance set containing the Bank Statements object.   
top
 

Bank_StatementObject

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

Bank_StatementObjectID

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

part of: Get_Bank_Statements_Request, Get_Bank_Statements_Response
This element is the wrapper around a list of elements representing the Bank Statements Request specific criteria needed to search for instances. All of the elements are "AND" conditions. There are currently no elements.
 
Parameter name Type/Value Cardinality Description Validations
Statement_Date_From  date  [0..1]  Date to Filter Bank Statement From   
Statement_Date_To  date  [0..1]  Date to Filter Bank Statement To   
top
 

Response_Filter

part of: Get_Bank_Statements_Request, Get_Bank_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
 

Bank_Statements_Request_Response_Group

part of: Get_Bank_Statements_Request, Get_Bank_Statements_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Bank Statements 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 Statements Reference data is to be included in the response.   
Include_Bank_Statement_Data  boolean  [0..1]  Flag indicating if the Bank Statements data is to be included in the response.   
top
 

Response_Results

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

Bank_Statement_Response_Data

part of: Get_Bank_Statements_Response
This element content contains the Bank Statements Response Data element.
 
Parameter name Type/Value Cardinality Description Validations
Bank_Statement  Bank_Statement  [0..*]  Wrapper element that includes Bank Statement instances and data.   
top
 

Bank_Statement

part of: Bank_Statement_Response_Data
Wrapper element that includes Bank Statement instances and data.
 
Parameter name Type/Value Cardinality Description Validations
Bank_Statement_Reference  Bank_StatementObject  [0..1]  Bank Statement Reference   
Bank_Statement_Data  Bank_Statement_Data  [0..*]  Element containing all Bank Statement Data 
Validation Description
Cannot determine Company from Bank Account Number ([acct_num]) and Routing Number ([bank_id]).   
Cannot determine Bank Account from Bank Account Number ([acct_num]) and Routing Number ([bank_id]).   
If the currency is specified, it must match the currency for Bank Account.   
User does not have access on the Process: Bank Reconciliation domain for the Company and Bank Account for Bank Account Number ([acct_num]) and Routing Number ([bank_id]).   
A non-canceled Bank Statement already exists for account number ([acct_num]) and Statement Date ([date]).   
 
top
 

Bank_Statement_Data

part of: Bank_Statement
Element containing all Bank Statement data
 
Parameter name Type/Value Cardinality Description Validations
Bank_Statement_Reference_ID  string  [0..1]  Bank Statement Reference ID. This is the Bank Statement Data unique identifier.   
Bank_Statement_File_Reference  Bank_Statement_FileObject  [0..1]  Bank Statement File Reference.   
Customer_Account_Number  string  [0..1]  Customer Account Number.   
Routing_Number  string  [0..1]  Routing Number.   
Bank_Account_Reference  Bank_AccountObject  [0..1]  Bank Account Reference   
Statement_Begin_Date  date  [0..1]  Statement Begin Date.   
Statement_End_Date  date  [0..1]  Statement End Date.   
Same_Day_Bank_Statement  boolean  [0..1]  Same Day Bank Statement?   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference.   
Bank_Statement_Summary_Data  Bank_Statement_Summary_Data  [0..*]  Bank Statement Summary Data.   
Bank_Statement_Transaction_Data  Bank_Statement_Transaction_Data  [0..*]  Bank Statement Transaction Data   
Bank_Identification_Code  string  [0..1]  Bank Identification Code   
IBAN  string  [0..1]  IBAN   
Validation Description
Cannot determine Company from Bank Account Number ([acct_num]) and Routing Number ([bank_id]).   
Cannot determine Bank Account from Bank Account Number ([acct_num]) and Routing Number ([bank_id]).   
If the currency is specified, it must match the currency for Bank Account.   
User does not have access on the Process: Bank Reconciliation domain for the Company and Bank Account for Bank Account Number ([acct_num]) and Routing Number ([bank_id]).   
A non-canceled Bank Statement already exists for account number ([acct_num]) and Statement Date ([date]).   
top
 

Bank_Statement_FileObject

part of: Bank_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  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_AccountObject

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

Bank_AccountObjectID

part of: Bank_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  [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: Bank_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  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
 

Bank_Statement_Summary_Data

part of: Bank_Statement_Data
Bank Statement Summary Data.
 
Parameter name Type/Value Cardinality Description Validations
Bank_Statement_Balance_Type_Reference  Bank_Statement_Balance_Type_Reference  [0..1]  Bank Statement Balance Type Reference.   
Amount  decimal (18, 3)   [0..1]  Balance Amount.   
Item_Count  decimal (20, 0) >0   [0..1]  Balance Item Count.   
Funds_Availability_Data  Funds_Availability_Data  [0..*]  Funds Availability Data.   
Alternate_Balance_Type_Code  string  [0..1]  Alternate Balance Type Code   
Debit  boolean  [0..1]  Indicates the Credit/Debit status of the Summary or Balance entry.   
top
 

Bank_Statement_Balance_Type_Reference

part of: Bank_Statement_Summary_Data
Bank Statement Balance Type Reference.
 
Parameter name Type/Value Cardinality Description Validations
Type_Code  string  [0..1]  Bank Statement Balance Type Code.   
top
 

Funds_Availability_Data

part of: Bank_Statement_Summary_Data, Bank_Statement_Transaction_Data
Funds Availability Data.
 
Parameter name Type/Value Cardinality Description Validations
Amount  decimal (18, 3)   [0..1]  Funds Availability Amount.   
Availability_Date_Time  dateTime  [0..1]  Funds Availability Date Time.   
Number_of_Days_until_Available  decimal (12, 0) >0   [0..1]  Days until Funds are Available.   
Unknown_Number_of_Days  boolean  [0..1]  Unknown Number of Days.   
top
 

Bank_Statement_Transaction_Data

part of: Bank_Statement_Data
Bank Statement Transaction Data.
 
Parameter name Type/Value Cardinality Description Validations
Bank_Statement_Transaction_Type_Reference  Bank_Statement_Transaction_Type_Reference  [0..1]  Bank Statement Transaction Type Reference.   
Transaction_Date  date  [0..1]  Bank Statement Line Date.   
Amount  decimal (18, 3)   [0..1]  Bank Statement Line Amount.   
Bank_Reference_Number  string  [0..1]  Bank Reference Number.   
Customer_Reference_Number  string  [0..1]  Customer Reference Number.   
Text  string  [0..1]  Text.   
Funds_Availability_Data  Funds_Availability_Data  [0..*]  Funds Availability Data.   
Alternate_Transaction_Type_Code  string  [0..1]  Alternate Transaction Type Code   
Originating_Currency_Amount  decimal (18, 3)   [0..1]  Originating Currency Amount   
Originating_Currency  string  [0..1]  Originating Currency.   
Currency_Exchange_Rate  decimal (18, 6) >0   [0..1]  Currency Exchange Rate   
Debit  boolean  [0..1]  Credit/Debit Indicator   
Value_Date  date  [0..1]  Value Date   
Reversal_Indicator  boolean  [0..1]  Reversal Transaction   
Additional_Reference_Field_1  string  [0..1]  Additional Reference Field #1   
Additional_Reference_Field_2  string  [0..1]  Additional Reference Field #2   
Additional_Reference_Field_3  string  [0..1]  Additional Reference Field #3   
Additional_Reference_Field_4  string  [0..1]  Additional Reference Field #4   
Additional_Reference_Field_5  string  [0..1]  Additional Reference Field #5   
top
 

Bank_Statement_Transaction_Type_Reference

part of: Bank_Statement_Transaction_Data
Bank Statement Transaction Type Reference.
 
Parameter name Type/Value Cardinality Description Validations
Type_Code  string  [0..1]  Bank Statement Transaction Type Code.   
top
 

Bank_StatementReferenceEnumeration

part of: Bank_StatementObjectID
Base Type
string
top
 

Bank_Statement_FileReferenceEnumeration

part of: Bank_Statement_FileObjectID
Base Type
string
top
 

Bank_AccountReferenceEnumeration

part of: Bank_AccountObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top