Oracle ERP Cloud Integration: How to Create and Assign Supplier Bank Accounts at Site Level

When integrating external systems with Oracle Fusion Cloud, one of the recurring challenges is not just calling the right REST API, but understanding which identifiers are required, where they come from, and how they relate to each other.

A common example is the creation or assignment of supplier bank accounts at supplier site level. Developers often have the supplier, the site, or the address information, but struggle to identify the correct PayeeId, PaymentInstrumentId, or BankAccountId required by the REST APIs.

In many scenarios, especially when the bank account needs to be associated with the supplier site, it is necessary to navigate through the following relationship:

Supplier -> Supplier Address / Site -> External Payee -> Instrument Assignment -> External Bank Account

Note: I’m not going to discuss how this solution will be implemented in the OIC; the purpose of this post is to present the mapping of the APIs and their respective payloads.

Before calling the APIs, it is important to understand the role of each identifier:

SupplierId: identifies the supplier record. SupplierPartyId: identifies the supplier as a party. SupplierAddressId: identifies the supplier address or site. PayeeId: identifies the external payee associated with the supplier/site. PaymentInstrumentId: identifies the assigned payment instrument. BankAccountId: identifies the external bank account.

Follow the steps below to identify the required information and prepare the payloads needed to create and assign a supplier bank account.

#1 Get SupplierAddressId

Target: Locate the correct supplier address. Expected result: SupplierAddressId.

GET /fscmRestApi/resources/latest/suppliers/{supplierId}/child/addresses?
q=AddressName={SupplierSiteName}

#2 Find the PayeeId associated with the address

Expected result: PayeeId.

We can highlight the following attribute mapping: PayeePartyIdentifier = SupplierPartyId (Available at the supplier header level) PayeePartySiteIdentifier = SupplierAddressId (Available at the address level, step 1)

GET /fscmRestApi/resources/latest/paymentsExternalPayees/?finder=ExternalPayeeSearch;Intent=Supplier,
PayeePartyIdentifier={SupplierPartyId}&
q=PayeePartySiteIdentifier={SupplierAddressId};
SupplierSiteCode={AddressName}

#3 Check the Bank Account Assigned to the PayeeId

Once you have the PayeeId, you can check whether any bank account is already assigned to that payee using the REST API below:

GET /fscmRestApi/resources/11.13.18.05/instrumentAssignments?finder=PaymentInstrumentAttributes;Intent=Supplier,
PaymentPartyId={PayeeId}&onlyData=true

#4 Create a Bank Account

At this point, you should already have the BankPartyId and BranchPartyId. If not, you can retrieve them using the following APIs:

POST /fscmRestApi/resources/latest/externalBankAccounts

Consider following attributes mapping:

BankIdentifier -> Bank Party Id BankBranchIdentifier -> BranchPartyId PartyId -> SupplierPartyId AccountOwnerPartyIdentifier -> SupplierPartyId

{
    "BankIdentifier": 30000000******,
    "BankAccountName": "341_1234567890",
    "BankBranchIdentifier": 30000000*****,
    "BankAccountNumber": "1234567890",
    "CurrencyCode": "USD",
    "CountryCode": "US",
    "AccountType": "CHECKING",
    "AllowInternationalPaymentIndicator": "Y",
    "Intent": "Supplier",
    "PartyId": 3000000****2963,
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 3000000****2963,
            "Intent": "Supplier"
        }
    ]
}

After bank account creation you will have BankAccountId (expected result).

POST /fscmRestApi/resources/11.13.18.05/instrumentAssignments

Consider following attributes mapping: PaymentPartyId -> PayeeId PaymentInstrumentId -> BankAccountId

{
  "PaymentPartyId": 300000011179707,
  "PaymentInstrumentId": 300000747176230,
  "PaymentFlow": "DISBURSEMENTS",
  "PaymentInstrumentType": "BANKACCOUNT",
  "Intent": "Supplier"
}

Working with supplier bank accounts in Oracle ERP Cloud requires more than knowing the endpoint names. The most important part is understanding how the identifiers are connected across Supplier, Address, External Payee, Instrument Assignment, and External Bank Account resources.

Once this relationship is clear, the integration becomes much easier to design, troubleshoot, and maintain.

This mapping is especially useful when implementing integrations through Oracle Integration Cloud or any external middleware that needs to create or update supplier payment information in Oracle ERP Cloud.