Service Directory > v31.2 > Cash_Management > Get_Bank_Fee_Statements
 

Operation: Get_Bank_Fee_Statements

Retrieves the Bank Fee Statements and filters by request criteria if any are given.


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

Element containing the request data for Bank Fee Statements.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Bank_Fee_Statement_Request_References  [0..1]  Element containing the Bank Fee Statement reference.   
Request_Criteria [Choice]   Bank_Fee_Statement_Request_Criteria  [0..1]  Element containing criteria used to filter Bank Fee 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  Bank_Fee_Statement_Response_Group  [0..1]  Element containing flags that determine the amount of data that is included in the Bank Fee Statements response. If this element is not included then ALL of the Response Groups are included in the response.   
top
 

Response Element: Get_Bank_Fee_Statements_Response

Element containing the Bank Fee Statement response data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Bank_Fee_Statement_Request_References  [0..1]  Element containing the Bank Fee Statement reference.   
Request_Criteria  Bank_Fee_Statement_Request_Criteria  [0..1]  Element containing criteria used to filter Bank Fee 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  Bank_Fee_Statement_Response_Group  [0..1]  Element containing flags that determine the amount of data that is included in the Bank Fee 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_Fee_Statement_Response_Data  [0..1]  Wrapper element containing the Bank Fee Statement reference and its data.   
top
 

Bank_Fee_Statement_Request_References

part of: Get_Bank_Fee_Statements_Request, Get_Bank_Fee_Statements_Response
Element containing the Bank Fee Statement reference.
 
Parameter name Type/Value Cardinality Description Validations
Bank_Fee_Statement_Reference  Bank_Fee_StatementObject  [1..*]  Reference to an existing Bank Fee Statement.   
top
 

Bank_Fee_StatementObject

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

Bank_Fee_StatementObjectID

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

Bank_Fee_Statement_Request_Criteria

part of: Get_Bank_Fee_Statements_Request, Get_Bank_Fee_Statements_Response
Element containing criteria used to filter Bank Fee Statements.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  OrganizationObject  [0..*]  The Company that the Bank Fee Statement is recorded for.   
Financial_Account_Reference  Financial_AccountObject  [0..*]  The Bank Account that the Bank Fee Statement is recorded for.   
Statement_Date_From  date  [0..1]  The beginning date range to filter the Statement date.   
Statement_Date_To  date  [0..1]  The ending date range to filter the Statement date.   
top
 

OrganizationObject

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

OrganizationObjectID

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

Financial_AccountObject

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

Response_Filter

part of: Get_Bank_Fee_Statements_Request, Get_Bank_Fee_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_Fee_Statement_Response_Group

part of: Get_Bank_Fee_Statements_Request, Get_Bank_Fee_Statements_Response
Element containing flags that determine the amount of data that is included in the Bank Fee 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]  If set to true, the Bank Fee Statement Reference data is included in the response.   
Include_Bank_Fee_Statement_Data  boolean  [0..1]  If set to true, the Bank Fee Statement data is included in the response.   
top
 

Response_Results

part of: Get_Bank_Fee_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_Fee_Statement_Response_Data

part of: Get_Bank_Fee_Statements_Response
Wrapper element containing the Bank Fee Statement reference and its data.
 
Parameter name Type/Value Cardinality Description Validations
Bank_Fee_Statement  Bank_Fee_Statement  [0..*]  Wrapper element containing the Bank Fee Statement reference and its data.   
top
 

Bank_Fee_Statement

part of: Bank_Fee_Statement_Response_Data
Wrapper element containing the Bank Fee Statement reference and its data.
 
Parameter name Type/Value Cardinality Description Validations
Bank_Fee_Statement_Reference  Bank_Fee_StatementObject  [0..1]  Reference to an existing Bank Fee Statement.   
Bank_Fee_Statement_Data  Bank_Fee_Statement_Data  [0..*]  Element containing all Bank Fee Statement data.   
top
 

Bank_Fee_Statement_Data

part of: Bank_Fee_Statement
Element containing all Bank Fee Statement data.
 
Parameter name Type/Value Cardinality Description Validations
Bank_Fee_Statement_ID  string  [0..1]  This is the Bank Fee Statement unique identifier.   
Bank_Fee_Statement_File_Reference  Bank_Fee_Statement_FileObject  [0..1]  Bank Fee Statement File reference which contains data about when the statement is uploaded.   
Statement_Date  date  [0..1]  The date on which the Bank Fee Statement is entered.   
Statement_Begin_Date  date  [0..1]  The start date for the Bank Fee Statement period.   
Statement_End_Date  date  [0..1]  The end date for the Bank Fee Statement period.   
Customer_Account_Number  string  [0..1]  Customer Account Number.   
Tax_Currency_Reference  CurrencyObject  [0..1]  Host Currency for tax purposes.   
Settlement_Currency_Reference  CurrencyObject  [0..1]  The agreed upon Currency for payment.   
Tax_Region  string  [0..1]  The Tax Region name.   
Bank_Fee_Statement_Currency_Conversion_Rate_Data  Bank_Fee_Statement_Currency_Conversion_Rate_Data  [0..*]  Specifies details related to currency exchange data.   
Bank_Fee_Statement_Compensation_Data  Bank_Fee_Statement_Compensation_Data  [0..*]  Element containing the compensation data, rate information.   
Bank_Fee_Statement_Transaction_Data  Bank_Fee_Statement_Transaction_Data  [0..*]  Element containing the Bank Fee Statement line data.   
top
 

Bank_Fee_Statement_FileObject

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

Bank_Fee_Statement_FileObjectID

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

CurrencyObject

part of: Bank_Fee_Statement_Data, Bank_Fee_Statement_Data, Bank_Fee_Statement_Currency_Conversion_Rate_Data, Bank_Fee_Statement_Currency_Conversion_Rate_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_Fee_Statement_Currency_Conversion_Rate_Data

part of: Bank_Fee_Statement_Data
Specifies details related to currency exchange data.
 
Parameter name Type/Value Cardinality Description Validations
Currency_Rate_Type_Reference  Currency_Rate_TypeObject  [0..1]  Currency Rate Type Reference   
Source_Currency_Reference  CurrencyObject  [0..1]  Currency from which an amount is to be converted in a currency conversion.   
Target_Currency_Reference  CurrencyObject  [0..1]  Currency into which an amount is to be converted in a currency conversion.   
Currency_Exchange_Rate_Date  date  [0..1]  Date and time at which an exchange rate is quoted.   
Currency_Exchange_Rate  decimal (26, 6) >0   [0..1]  Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.   
Description  string  [0..1]  Unique identification to unambiguously identify the foreign exchange contract.   
Comments  string  [0..1]  Further information on the exchange rate.   
top
 

Currency_Rate_TypeObject

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

Currency_Rate_TypeObjectID

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

Bank_Fee_Statement_Compensation_Data

part of: Bank_Fee_Statement_Data
Element containing the compensation data, rate information.
 
Parameter name Type/Value Cardinality Description Validations
Bank_Fee_Compensation_Code_Data  Bank_Fee_Compensation_Code_Data  [0..*]  Element containing the Compensation Code data.   
Compensation_Amount  decimal (26, 6)   [0..1]  The amount for the code   
Compensation_Multiplier  decimal (26, 6) >0   [0..1]  Rate-based multiplier   
Days_in_Period  decimal (12, 0) >0   [0..1]  Rate-based days in period   
Days_in_Year  decimal (12, 0) >0   [0..1]  Rate-based days in year   
top
 

Bank_Fee_Compensation_Code_Data

part of: Bank_Fee_Statement_Compensation_Data
Element containing the Compensation Code data.
 
Parameter name Type/Value Cardinality Description Validations
Description  string  [0..1]  The description for the EDI / ISO code.   
EDI_Code  string  [0..1]  EDI Code   
ISO_Code  string  [0..1]  ISO Code   
Code_Type_Reference  Bank_Fee_Compensation_TypeObject  [0..1]  Code Type   
top
 

Bank_Fee_Compensation_TypeObject

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

Bank_Fee_Compensation_TypeObjectID

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

Bank_Fee_Statement_Transaction_Data

part of: Bank_Fee_Statement_Data
Element containing the Bank Fee Statement line data.
 
Parameter name Type/Value Cardinality Description Validations
AFP_Code  string  [0..1]  The standardized AFP code   
AFP_Code_Description  string  [0..1]  The description for the standardized AFP code   
Bank_Fee_Service_Code_Reference  Bank_Fee_Service_CodeObject  [0..1]  The bank service code   
Bank_Fee_Pricing_Type_Reference  Bank_Fee_Pricing_TypeObject  [0..1]  The pricing method used for the service   
Bank_Fee_Tier_Pricing_If_Tier_Selected_Reference  Bank_Fee_Tier_Pricing_LevelObject  [0..1]  If the pricing type "Tiered" is selected derive the Tier Level.   
Service_Unit_Price  decimal (26, 6)   [0..1]  The amount charged for one transaction of the service   
Service_Volume  decimal (26, 6)   [0..1]  The number of transactions of the service   
Service_Charge  decimal (26, 6)   [0..1]  The total service charge   
Taxes_Per_Service  decimal (26, 6)   [0..1]  The taxed amount for one transaction   
Total_Charges  decimal (26, 6)   [0..1]  The total amount charged for the service   
top
 

Bank_Fee_Service_CodeObject

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

Bank_Fee_Service_CodeObjectID

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

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

Bank_Fee_Pricing_TypeObjectID

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

Bank_Fee_Tier_Pricing_LevelObject

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

Bank_Fee_Tier_Pricing_LevelObjectID

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

part of: Bank_Fee_StatementObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Financial_AccountReferenceEnumeration

part of: Financial_AccountObjectID
Base Type
string
top
 

Bank_Fee_Statement_FileReferenceEnumeration

part of: Bank_Fee_Statement_FileObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Currency_Rate_TypeReferenceEnumeration

part of: Currency_Rate_TypeObjectID
Base Type
string
top
 

Bank_Fee_Compensation_TypeReferenceEnumeration

part of: Bank_Fee_Compensation_TypeObjectID
Base Type
string
top
 

Bank_Fee_Service_CodeReferenceEnumeration

part of: Bank_Fee_Service_CodeObjectID
Base Type
string
top
 

Bank_Fee_Pricing_TypeReferenceEnumeration

part of: Bank_Fee_Pricing_TypeObjectID
Base Type
string
top
 

Bank_Fee_Tier_Pricing_LevelReferenceEnumeration

part of: Bank_Fee_Tier_Pricing_LevelObjectID
Base Type
string
top