External Bank Account

Relationships

The following table describes how this service data object is related to other service data objects or business object services.

Relationship Type	Object or Service
Handles	External Bank Account SDO
Handles	External Bank Account Owner SDO
Handles	Intermediary Bank Account Owner SDO
Handles	External Bank Account SDO

confirmBankAccountExistence

An operation that confirms whether the bank account already exists.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
bankId	string	A parameter that specifies the bank identifier that confirms the existence of the bank account.
branchId	decimal	A parameter that specifies the branch identifier that confirms the existence of the bank account.
bankAccountNumber	string	A parameter that specifies the bank account number that confirms the existence of the bank account.
accountName	string	A parameter that specifies the bank account name that confirms the existence of the bank account.
currency	string	A parameter that specifies the currency code that confirms the existence of the bank account.
countryCode	string	A parameter that specifies the country code of the bank account that confirms the existence of the bank account.

Response Payload

Element Name	Type	Description
result	long	A parameter that returns the bank account identifier that confirms the existence of the bank account.

getExternalBankAccountOwnerRemote

An operation that retrieves the external bank account owner details.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
accountOwnerId	long	A parameter that specifies the account owner identifier of the external bank account owner to be retrieved.

Response Payload

Element Name	Type	Description
result	External Bank Account Owner	A parameter that returns the external bank account owner that matches the account owner.

findExternalBankAccountOwnerRemote

An operation that searches for the remote external bank account owner using specified criteria.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	A parameter that specifies the search criteria for the remote external bank account owner and the maximum records returned at a time.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	A parameter that controls the search for the remote external bank account owner.

Response Payload

Element Name	Type	Description
result	External Bank Account Owner	A parameter that returns the remote external bank account owner that satisfies the search criteria.

getIntermediaryBankAccountRemote

An operation that retrieves a specific remote intermediary bank account.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
intermediaryAccountId	long	A parameter that specifies the identifier for the remote intermediary bank account to be retrieved.

Response Payload

Element Name	Type	Description
result	Intermediary Bank Account Owner	A parameter that returns the remote intermediary bank account that matches the intermediary bank account identifier.

findIntermediaryBankAccountRemote

An operation that searches a remote intermediary bank account using specified criteria.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	A parameter that specifies the search criteria for remote intermediary bank accounts and the maximum records returned at a time.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	A parameter that controls the search for a remote intermediary bank account.

Response Payload

Element Name	Type	Description
result	Intermediary Bank Account Owner	A parameter that returns the remote intermediary bank account that satisfies the search criteria.

getExternalBankAccountDetails

An operation that retrieves a specific external bank account.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
externalBankAccountId	long	A parameter that specifies the identifier of the external bank account to be retrieved.

Response Payload

Element Name	Type	Description
result	External Bank Account	A parameter that returns the external bank account details that matches the external bank account identifier.

processExternalBankAccount

An operation that creates or updates an external bank account of the supplier or customer.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
externalBankAccount	External Bank Account	A parameter that specifies the external bank account that is to be created or updated.

Response Payload

Element Name	Type	Description
result	External Bank Account	A parameter that returns the newly created or updated external bank account.

findExternalBankAccount

An operation that searches for external bank accounts using specified criteria.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	A parameter that specifies the search criteria for external bank accounts and the maximum records returned at a time.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	A parameter that controls the search for external bank accounts.

Response Payload

Element Name	Type	Description
result	External Bank Account	A parameter that returns the external bank account.

getDfltObjAttrHints

An operation that retrieves the default object attribute hints.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
viewName	string	A parameter that specifies the name of the view for the default object attribute hints to be retrieved.
localeName	string	A parameter that specifies the locale name of the view for the default object attribute hints to be retrieved.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints	A parameter that returns the default object attribute hints that matches the view and local name.

getServiceLastUpdateTime

An operation that retrieves the last update time of the service.

Life Cycle Status: Active

Request Payload

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp	A parameter that returns the last update time of the service.

getEntityList

An operation that retrieves the entity list.

Life Cycle Status: Active

Request Payload

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo	A parameter that returns the entity list.

Security

The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.

Service Operations to Privileges Mapping

Operation Name	Privilege Code	Privilege Name	Privilege Description
All Operations	IBY_MANAGE_EXTERNAL_PAYER_PAYMENT_DETAILS_PRIV	Manage External Payer Payment Details	Allows management of payer payment details.
All Operations	IBY_MANAGE_THIRD_PARTY_BANK_ACCOUNT_PRIV	Manage Third Party Bank Account	Allows update of external bank accounts.

Privileges to Duty Roles Mapping

Privilege Code	Granted to Duty Role Code	Granted to Duty Role Name	Granted To Duty Role Description
IBY_MANAGE_THIRD_PARTY_BANK_ACCOUNT_PRIV	ORA_PAY_REST_SERVICE_ACCESS_WORKER_BANK_ACCOUNTS_FSCM	Use REST Service - Worker Bank Accounts	Allows the user to manage worker bank accounts using REST.
IBY_MANAGE_THIRD_PARTY_BANK_ACCOUNT_PRIV	ORA_IBY_PAYEE_BANK_ACCOUNT_MANAGEMENT_DUTY	Payee Bank Account Management	Manages supplier bank accounts and other payment details.
IBY_MANAGE_THIRD_PARTY_BANK_ACCOUNT_PRIV	ORA_POS_SUPPLIER_SELF_SERVICE_ADMINISTRATOR_ABSTRACT	Supplier Self Service Administrator	Manages the profile information for the supplier company. Primary tasks include updating supplier profile information and requesting user accounts to grant employees access to the supplier application.
IBY_MANAGE_THIRD_PARTY_BANK_ACCOUNT_PRIV	ORA_POS_SUPPLIER_SELF_SERVICE_CLERK_ABSTRACT	Supplier Self Service Clerk	Manages the profile information for the supplier company. Primary tasks include updating supplier profile information and requesting user accounts to grant employees access to the supplier application.
IBY_MANAGE_THIRD_PARTY_BANK_ACCOUNT_PRIV	ORA_POZ_SUPPLIER_PROFILE_INQUIRY_DUTY	Supplier Profile Inquiry	View supplier profile information.
IBY_MANAGE_THIRD_PARTY_BANK_ACCOUNT_PRIV	ORA_POS_SUPPLIER_ACCOUNTS_RECEIVABLE_SPECIALIST_JOB	Supplier Accounts Receivable Specialist	Manages invoices and payments for the supplier company. Primary tasks include submitting invoices as well as tracking invoice and payment status.
IBY_MANAGE_THIRD_PARTY_BANK_ACCOUNT_PRIV	ORA_IBY_CUSTOMER_PAYMENT_INSTRUMENT_MANAGEMENT_DUTY	Customer Payment Instrument Management	Manages customer bank accounts and credit cards and other payment details.
IBY_MANAGE_THIRD_PARTY_BANK_ACCOUNT_PRIV	ORA_IBY_EMPLOYEE_BANK_ACCOUNT_MANAGEMENT_DUTY	Employee Bank Account Management	Manages employee bank accounts and other payment details.
IBY_MANAGE_EXTERNAL_PAYER_PAYMENT_DETAILS_PRIV	ORA_IBY_CUSTOMER_PAYMENT_INSTRUMENT_MANAGEMENT_DUTY	Customer Payment Instrument Management	Manages customer bank accounts and credit cards and other payment details.

Duty Roles to Duty or Job Roles Mapping

Duty Role Code	Granted to Duty or Job Role Code	Granted to Duty or Job Role Name	Granted To Duty or Job Role Description
ORA_IBY_PAYEE_BANK_ACCOUNT_MANAGEMENT_DUTY	ORA_FUN_FSCM_LOAD_INTERFACE_ADMIN_DUTY	FSCM Load Interface Administration	Manages load interface file for import
ORA_POS_SUPPLIER_ACCOUNTS_RECEIVABLE_SPECIALIST_JOB	ORA_OKC_SUPPLIER_CONTRACT_MANAGE_DUTY	Manage Supplier Contracts in Supplier Portal	Manage supplier contracts in the Supplier Portal.
ORA_POS_SUPPLIER_ACCOUNTS_RECEIVABLE_SPECIALIST_JOB	ORA_AP_SELF_SERVICE_PAYABLES_INVOICE_ENTRY_DUTY	Self Service Payables Invoice Entry	Enters invoices using self-service functionality.
ORA_POS_SUPPLIER_SELF_SERVICE_ADMINISTRATOR_ABSTRACT	ORA_POZ_SUPPLIER_PROFILE_CHANGE_REQUEST_AS_SUPPLIER_DUTY	Supplier Profile Change Request as Supplier	Requests changes to supplier profile as a supplier user.
ORA_POS_SUPPLIER_SELF_SERVICE_CLERK_ABSTRACT	ORA_POZ_SUPPLIER_PROFILE_CHANGE_REQUEST_AS_SUPPLIER_DUTY	Supplier Profile Change Request as Supplier	Requests changes to supplier profile as a supplier user.
ORA_POS_SUPPLIER_SELF_SERVICE_ADMINISTRATOR_ABSTRACT	ORA_POZ_PROFILE_INQUIRY_AS_SUPPLIER_DUTY	Supplier Profile Inquiry as Supplier	Views non-bank account related supplier profile information as a supplier.
ORA_POS_SUPPLIER_ACCOUNTS_RECEIVABLE_SPECIALIST_JOB	ORA_POZ_PROFILE_INQUIRY_AS_SUPPLIER_DUTY	Supplier Profile Inquiry as Supplier	Views non-bank account related supplier profile information as a supplier.
ORA_POS_SUPPLIER_SELF_SERVICE_CLERK_ABSTRACT	ORA_POZ_PROFILE_INQUIRY_AS_SUPPLIER_DUTY	Supplier Profile Inquiry as Supplier	Views non-bank account related supplier profile information as a supplier.
ORA_POZ_SUPPLIER_PROFILE_INQUIRY_DUTY	ORA_POQ_SUPPLIER_QUALIFICATION_VIEWING_DUTY	Supplier Qualification Viewing	An enterprise user can search and view supplier qualifications.