Service Directory > v31.2 > Cash_Management > Submit_Bank_Account_Transfer_Template
 

Operation: Submit_Bank_Account_Transfer_Template

Creates and submit a new Bank Account Transfer Template with the information supplied in the request. This service operation will submit Bank Account Transfer Template


@ - 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: Submit_Bank_Account_Transfer_Template_Request

The request object for Submit Bank Account Transfer Template request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Submit  boolean  [0..1]  Whether to submit or save for later   
Bank_Account_Transfer_Template_Reference  Bank_Account_Transfer_TemplateObject  [0..1]  Bank Account Transfer Template record reference   
Business_Process_Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Bank_Account_Transfer_Template_Data  Bank_Account_Transfer_Template_Data  [1..1]  Bank Account Transfer Template data element 
Validation Description
[non-allowed worktags message]   
[missing worktags message]   
[missing worktags message from account]   
From and To Bank Account can not be the same.   
[non-allowed worktags message]   
 
Validation Description
The Web Service is set to Add Only; but the Bank Account Transfer Template already exists.   
top
 

Response Element: Submit_Bank_Account_Transfer_Template_Response

Submit Bank Account Transfer Template Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Bank_Account_Transfer_Template_Reference  Bank_Account_Transfer_TemplateObject  [0..1]  Reference to Bank Account Transfer Template instance   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element containing Exceptions Data   
Bank_Account_Transfer_Template_Event_Reference  Unique_IdentifierObject  [0..1]  Reference to the Bank Account Transfer Template Event.   
top
 

Bank_Account_Transfer_TemplateObject

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

Bank_Account_Transfer_TemplateObjectID

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

Business_Process_Comment_Data

part of: Submit_Bank_Account_Transfer_Template_Request
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

WorkerObjectID

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

part of: Submit_Bank_Account_Transfer_Template_Request
Bank Account Transfer Template data element
 
Parameter name Type/Value Cardinality Description Validations
Bank_Account_Transaction_Template_ID  string  [0..1]  Reference ID   
Name  string  [1..1]  Bank Account Transfer Template Name 
Validation Description
There is an existing Bank Account Transfer Template by this name. Please provide a unique name.   
 
Currency_Reference  CurrencyObject  [1..1]  Transaction Currency 
Validation Description
Enter a Transaction Currency that matches the currency used for either the From or To Bank Account for the bank account transfer.   
Enter a valid Currency for the from account.   
Enter a valid Currency for the to account.   
 
Eliminate_Foreign_Exchange_Gain_or_Loss  boolean  [0..1]  Whether to eliminate fx gain or loss   
Memo  string  [0..1]  Bank Account Transfer Template transaction memo   
Inactive  boolean  [0..1]  Inactivate the Bank Account Transfer Template 
Validation Description
You cannot create a Bank Account Transfer Template with an inactive status.   
 
From_Company_Reference  CompanyObject  [1..1]  The from company for the Bank Account Transfer Template   
From_Financial_Account_Reference  Financial_AccountObject  [1..1]  The from bank account for the Bank Account Transfer Template 
Validation Description
Bank Account is not valid for Company.   
 
From_Account_Currency_Reference  CurrencyObject  [0..1]  Currency for the from bank account   
From_Currency_Rate_Type_Reference  Currency_Rate_TypeObject  [0..1]  The from currency rate for the Bank Account Transfer Template 
Validation Description
Currency Rate Type not enterable for the from account since the transaction currency & the bank account currency are the same.   
 
From_Balancing_Worktag_Reference  Balancing_WorktagObject  [0..1]  Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize. Each transaction can include one value for each worktag type and is subject to configurable validation when submitted for approval. 
Validation Description
Worktag setup not activated, hence not allowed.   
A balancing worktag is required if worktag balancing has been enabled for the tenant.   
Select a Balancing Worktag of the type [tenant type].   
The [type] is/are not available for use with the company/s: [partitionable] [company]   
 
Optional_Balancing_Worktags_from_Account_Reference  Accounting_WorktagObject  [0..*]  Optional Balancing Worktag from Account 
Validation Description
The [type] is/are not available for use with the company/s: [partitionable] [company]   
Only one worktag of each type is allowed   
 
To_Company_Reference  CompanyObject  [1..1]  The to company for the Bank Account Transfer Template 
Validation Description
To Company is not a member of Intercompany Affiliates.   
 
To_Financial_Account_Reference  Financial_AccountObject  [1..1]  The to bank account for the Bank Account Transfer Template 
Validation Description
To Bank Account is not valid for company.   
 
To_Account_Currency_Reference  CurrencyObject  [0..1]  Currency for the to bank account   
To_Currency_Rate_Type_Reference  Currency_Rate_TypeObject  [0..1]  The to currency rate for the Bank Account Transfer Template 
Validation Description
Currency Rate Type not enterable for the to account since the transaction currency & the bank account currency are the same.   
 
To_Balancing_Worktag_Reference  Balancing_WorktagObject  [0..1]  Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize. Each transaction can include one value for each worktag type and is subject to configurable validation when submitted for approval. 
Validation Description
Worktag setup not activated, hence not allowed.   
The [type] is/are not available for use with the company/s: [partitionable] [company]   
A balancing worktag is required if worktag balancing has been enabled for the tenant.   
Select a Balancing Worktag of the type [tenant type].   
 
Optional_Balancing_Worktags_To_Account_Reference  Accounting_WorktagObject  [0..*]  Optional Balancing Worktag to Account 
Validation Description
Only one worktag of each type is allowed   
The [type] is/are not available for use with the company/s: [partitionable] [company]   
 
Validation Description
[non-allowed worktags message]   
[missing worktags message]   
[missing worktags message from account]   
From and To Bank Account can not be the same.   
[non-allowed worktags message]   
top
 

CurrencyObject

part of: Bank_Account_Transfer_Template_Data, Bank_Account_Transfer_Template_Data, Bank_Account_Transfer_Template_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
 

CompanyObject

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

CompanyObjectID

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

Currency_Rate_TypeObject

part of: Bank_Account_Transfer_Template_Data, Bank_Account_Transfer_Template_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
 

Balancing_WorktagObject

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

Balancing_WorktagObjectID

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

Accounting_WorktagObject

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

Accounting_WorktagObjectID

part of: Accounting_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_ID, Program_of_Study_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_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
 

Application_Instance_Related_Exceptions_Data

part of: Submit_Bank_Account_Transfer_Template_Response
Element containing Exceptions Data
 
Parameter name Type/Value Cardinality Description Validations
Exceptions_Data  Application_Instance_Exceptions_Data  [0..*]  Exceptions Data   
top
 

Application_Instance_Exceptions_Data

part of: Application_Instance_Related_Exceptions_Data
Element containing application related exceptions data
 
Parameter name Type/Value Cardinality Description Validations
Exception_Data  Exception_Data  [0..*]  Exception Data   
top
 

Exception_Data

part of: Application_Instance_Exceptions_Data
Exception (Errors and Warning) associated with the transaction.
 
Parameter name Type/Value Cardinality Description Validations
Classification  string  [0..1]  Exception Classification (Error or Warning)   
Message  string  [0..1]  Exception Detail   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

part of: Bank_Account_Transfer_TemplateObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Financial_AccountReferenceEnumeration

part of: Financial_AccountObjectID
Base Type
string
top
 

Currency_Rate_TypeReferenceEnumeration

part of: Currency_Rate_TypeObjectID
Base Type
string
top
 

Balancing_WorktagReferenceEnumeration

part of: Balancing_WorktagObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top