Service Directory > v32.1 > Cash_Management > Get_Bank_Fee_Service_Contracts
 

Operation: Get_Bank_Fee_Service_Contracts

Get Bank Fee Service Contracts


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

Get Bank Fee Service Contracts Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Bank_Fee_Service_Contract_Request_References  [0..1]  Get Bank Fee Service Contracts Request   
Request_Criteria [Choice]   Bank_Fee_Service_Contract_Request_Criteria  [0..1]  Get Bank Fee Service Contracts Request   
Response_Filter  Response_Filter  [0..1]  Get Bank Fee Service Contracts Request 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Bank_Fee_Service_Contracts_Response

Get Bank Fee Service Contract Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Bank_Fee_Service_Contract_Request_References  [0..1]  Get Bank Fee Service Contract Response   
Request_Criteria  Bank_Fee_Service_Contract_Request_Criteria  [0..1]  Get Bank Fee Service Contract Response   
Response_Filter  Response_Filter  [0..1]  Get Bank Fee Service Contract Response 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Get Bank Fee Service Contract Response   
Response_Data  Bank_Fee_Service_Contract_Response_Data  [0..1]  Get Bank Fee Service Contract Response   
top
 

Bank_Fee_Service_Contract_Request_References

part of: Get_Bank_Fee_Service_Contracts_Response, Get_Bank_Fee_Service_Contracts_Request
Get Bank Fee Service Contract Reference
 
Parameter name Type/Value Cardinality Description Validations
Service_Contract_Reference  Bank_Fee_Service_ContractObject  [1..*]  Get Bank Fee Service Contract Reference   
top
 

Bank_Fee_Service_ContractObject

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

Bank_Fee_Service_ContractObjectID

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

part of: Get_Bank_Fee_Service_Contracts_Response, Get_Bank_Fee_Service_Contracts_Request
Bank Fee Service Contract Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Bank_Fee_Service_Contracts_Response, Get_Bank_Fee_Service_Contracts_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_Bank_Fee_Service_Contracts_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_Service_Contract_Response_Data

part of: Get_Bank_Fee_Service_Contracts_Response
Get Bank Fee Service Contract Response
 
Parameter name Type/Value Cardinality Description Validations
Bank_Fee_Service_Contract  Bank_Fee_Service_Contract  [0..*]  Get Bank Fee Service Contract Response   
top
 

Bank_Fee_Service_Contract

part of: Bank_Fee_Service_Contract_Response_Data
Get Bank Fee Service Contract Response
 
Parameter name Type/Value Cardinality Description Validations
Service_Contract_Reference  Bank_Fee_Service_ContractObject  [0..1]  Get Bank Fee Service Contract Response   
Bank_Fee_Service_Contract_Data  Bank_Fee_Service_Contract_Data  [0..*]  Data for the incoming Service Contract.   
top
 

Bank_Fee_Service_Contract_Data

part of: Bank_Fee_Service_Contract
Data for the incoming Service Contract.
 
Parameter name Type/Value Cardinality Description Validations
Bank_Fee_Service_Contract_ID  string  [0..1]  The reference ID for the Bank Fee Service Contract.   
Financial_Institution_Reference  Financial_InstitutionObject  [1..1]  The financial institution reference for the service contract. 
Validation Description
The service contract already exists, the financial institution cannot be changed.   
 
Bank_Accounts_Reference  Bank_AccountObject  [1..*]  The bank accounts associated with the service contract. 
Validation Description
You cannot assign a bank account to more than 1 service contract.   
Bank account does not belong to the financial institution selected.   
 
Service_Contract_Description  string  [1..1]  The service contract description.   
Bank_Fee_Service_Contract_Lines_Data  Bank_Fee_Service_Contract_Line_Data  [0..*]  The element container of the bank fee service contract line data. 
Validation Description
If the pricing type is not threshold, threshold pricing should be empty.   
If the pricing type is not tiered, tiered pricing should be empty.   
Select 1 Pricing Type for the Bank Fee Service Code: [code].   
Service Codes with the Threshold pricing type must have at least 1 Pricing Threshold.   
Service Codes with the Tiered pricing type must have at least 1 Pricing Tier.   
Select 1 Pricing Currency for the Bank Fee Service Code: [code] already uses [currency].   
 
Attachment_Data  Financials_Attachment_Data  [0..*]  Encapsulating element containing all Business Document Attachment data. 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
top
 

Financial_InstitutionObject

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

Financial_InstitutionObjectID

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

Bank_Fee_Service_Contract_Line_Data

part of: Bank_Fee_Service_Contract_Data
The element container for the service contract line data.
 
Parameter name Type/Value Cardinality Description Validations
Service_Contract_Pricing_Reference  Bank_Fee_Service_Contract_PricingObject  [0..1]  The reference for service contract pricing. 
Validation Description
Contract Pricing Reference cannot be processed as the Contract Pricing Reference does not belong to the Service Contract.   
 
Bank_Fee_Service_Code_Reference  Bank_Fee_Service_CodeObject  [0..1]  The reference for the service contract code. 
Validation Description
Select a service code or create a new service code that is available for the financial institution and service contract.   
 
Service_Code  string  [1..1]  The bank fee service code for the service contract.   
Service_Code_Description  string  [0..1]  The description of the service contract.   
Bank_Fee_Pricing_Type_Reference  Bank_Fee_Pricing_TypeObject  [1..1]  The pricing type reference.   
Service_Contract_Pricing_Currency_Reference  CurrencyObject  [1..1]  The currency of the service contract.   
Base_Fee  decimal (26, 6) >0   [0..1]  The service code base fee. 
Validation Description
Base Fee should only be 0 if Flat pricing type selected.   
 
Minimum_Fee  decimal (26, 6) >0   [0..1]  The service code min fee. 
Validation Description
Minimum Fee should only be 0 if Flat pricing type selected.   
 
Maximum_Fee  decimal (26, 6) >0   [0..1]  The service code max fee. 
Validation Description
Enter a Maximum Fee that is greater than the Minimum Fee.   
Maximum Fee should only be 0 if Flat pricing type selected.   
 
Fixed_Price  decimal (26, 6) >0   [0..1]  The service code fixed price. 
Validation Description
The fixed price cannot be 0 if fixed pricing type selected.   
If the pricing type is not fixed, fixed price should be 0.   
 
Flat_Price  decimal (36, 6) >0   [0..1]  The service code flat price. 
Validation Description
The flat price cannot be 0 if flat pricing type selected.   
If the pricing type is not flat, flat price should be 0.   
 
Service_Contract_Tier_Pricing_Data  Bank_Fee_Service_Contract_Pricing_Tier_Data  [0..*]  The element container for tier pricing. 
Validation Description
The Tier Minimum level must be 1 more than the previous Tier Maximum level.   
Enter a Pricing Tier range that doesn’t overlap with the previous Pricing Tier range.   
The Pricing Tier level selected exceeds the amount of Pricing Tiers.   
You cannot use a Tier Level for more than 1 Pricing Tier.   
 
Service_Contract_Threshold_Pricing_Data  Bank_Fee_Service_Contract_Pricing_Threshold_Data  [0..*]  The element container for the threshold pricing. 
Validation Description
Enter a Pricing Threshold that isn’t already in use.   
 
Validation Description
If the pricing type is not threshold, threshold pricing should be empty.   
If the pricing type is not tiered, tiered pricing should be empty.   
Select 1 Pricing Type for the Bank Fee Service Code: [code].   
Service Codes with the Threshold pricing type must have at least 1 Pricing Threshold.   
Service Codes with the Tiered pricing type must have at least 1 Pricing Tier.   
Select 1 Pricing Currency for the Bank Fee Service Code: [code] already uses [currency].   
top
 

Bank_Fee_Service_Contract_PricingObject

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

Bank_Fee_Service_Contract_PricingObjectID

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

part of: Bank_Fee_Service_Contract_Line_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_Service_Contract_Line_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
 

CurrencyObject

part of: Bank_Fee_Service_Contract_Line_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_Service_Contract_Pricing_Tier_Data

part of: Bank_Fee_Service_Contract_Line_Data
The element container for the contract line.
 
Parameter name Type/Value Cardinality Description Validations
Service_Contract_Tiered_Pricing_Reference  Bank_Fee_Service_Contract_Tiered_PricingObject  [0..1]  The tier pricing reference. 
Validation Description
Tiered Pricing Reference cannot be processed as the Tiered Pricing does not belong to the Service Contract.   
 
Service_Contract_Pricing_Tier_Level_Reference  Bank_Fee_Tier_Pricing_LevelObject  [0..1]  The tier pricing level 
Validation Description
Tier Level is required when pricing type is Tiered. Cannot be empty.   
 
Minimum_Quantity  decimal (20, 0) >0   [0..1]  The minimum amount for the current tier. 
Validation Description
The pricing type is tiered, therefore the tiered minimum is required.   
 
Maximum_Quantity  decimal (20, 0) >0   [0..1]  The maximum amount for the current tier. 
Validation Description
The pricing type is tiered, therefore the tiered maximum is required.   
Enter a Maximum Quantity that is greater than or equal to the Minimum Quantity.   
 
Tier_Price  decimal (26, 6) >0   [0..1]  The price for the current tier. 
Validation Description
The pricing type is tiered, therefore the tiered price is required.   
 
Validation Description
The Tier Minimum level must be 1 more than the previous Tier Maximum level.   
Enter a Pricing Tier range that doesn’t overlap with the previous Pricing Tier range.   
The Pricing Tier level selected exceeds the amount of Pricing Tiers.   
You cannot use a Tier Level for more than 1 Pricing Tier.   
top
 

Bank_Fee_Service_Contract_Tiered_PricingObject

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

Bank_Fee_Service_Contract_Tiered_PricingObjectID

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

part of: Bank_Fee_Service_Contract_Line_Data
The element container for the Service Contract Threshold Data
 
Parameter name Type/Value Cardinality Description Validations
Service_Contract_Threshold_Pricing_Reference  Bank_Fee_Service_Contract_Threshold_PricingObject  [0..1]  The threshold pricing reference. 
Validation Description
Threshold Pricing Reference cannot be processed as the Threshold Pricing does not belong to the Service Contract   
 
Threshold_Minimum  decimal (20, 0) >0   [0..1]  The threshold's minimum price. 
Validation Description
The pricing type is threshold, therefore the threshold min is required.   
 
Threshold_Price  decimal (26, 6) >0   [0..1]  The threshold's price. 
Validation Description
The pricing type is threshold, therefore the threshold price is required.   
 
Validation Description
Enter a Pricing Threshold that isn’t already in use.   
top
 

Bank_Fee_Service_Contract_Threshold_PricingObject

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

Bank_Fee_Service_Contract_Threshold_PricingObjectID

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

Financials_Attachment_Data

part of: Bank_Fee_Service_Contract_Data
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

Bank_Fee_Service_ContractReferenceEnumeration

part of: Bank_Fee_Service_ContractObjectID
Base Type
string
top
 

Financial_InstitutionReferenceEnumeration

part of: Financial_InstitutionObjectID
Base Type
string
top
 

Bank_AccountReferenceEnumeration

part of: Bank_AccountObjectID
Base Type
string
top
 

Bank_Fee_Service_Contract_PricingReferenceEnumeration

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

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Bank_Fee_Service_Contract_Tiered_PricingReferenceEnumeration

part of: Bank_Fee_Service_Contract_Tiered_PricingObjectID
Base Type
string
top
 

Bank_Fee_Tier_Pricing_LevelReferenceEnumeration

part of: Bank_Fee_Tier_Pricing_LevelObjectID
Base Type
string
top
 

Bank_Fee_Service_Contract_Threshold_PricingReferenceEnumeration

part of: Bank_Fee_Service_Contract_Threshold_PricingObjectID
Base Type
string
top