Results for “get_payee_all_instruments”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

IBY_DISBURSEMENT_SETUP_PUB is a public PL/SQL package in the Oracle Payments (IBY) module of Oracle E-Business Suite. It provides the programmatic interface for defining and maintaining the payment setup data associated with external payees — the parties, party sites, supplier sites, and payment instruments that determine how disbursements are routed and executed. In release 12.1.1 and 12.2.2, the package functions as the authoritative API layer for the records housed in IBY_EXTERNAL_PAYEES_ALL, rather than requiring direct DML against those tables.

Operationally, the package answers the question of whether a given payee may receive payment under a given payment function, using a given instrument, for a given payer organization, over a specified date range. It is therefore central to payment processing, funds disbursement, and the validation performed before a payment instruction is created or released. The validate_external_payee search term maps directly to the documented VALIDATE_EXTERNAL_PAYEE procedure, which is the entry point most frequently explored by developers troubleshooting payment setup errors.

Key Procedures and Functions

The package exposes nine documented public procedures and functions:

• CREATE_EXTERNAL_PAYEE — Creates a new external payee record, including party, party site, supplier site, payer organization context, and payment instrument attributes.
• UPDATE_EXTERNAL_PAYEE — Modifies an existing external payee record, including payee level, default payment method, and bank charge bearer information.
• VALIDATE_EXTERNAL_PAYEE — Validates a supplied external payee definition or lookup request, returning a status constant such as SUCCESS, INVALID_PARTY_CONTEXT, INVALID_INSTRUMENT, INVALID_BEGIN_END_RANGE, or INVALID_LOOKUP_VALUE.
• SET_PAYEE_INSTR_ASSIGNMENT — Establishes or updates the assignment of payment instruments to a payee.
• GET_PAYEE_INSTR_ASSIGNMENTS — Retrieves the instrument assignments currently associated with a payee.
• GET_PAYEE_ALL_INSTRUMENTS — Returns the complete set of payment instruments available to a payee, irrespective of prior assignment.
• CREATE_TEMP_EXT_BANK_ACCT — Creates a temporary external bank account record for a payee before it is validated and persisted.
• VALIDATE_TEMP_EXT_BANK_ACCT — Validates the temporary bank account, typically against instrument and format rules.

The package also declares the record type External_Payee_Rec_Type, which mirrors the columns of IBY_EXTERNAL_PAYEES_ALL and is used to pass payee data between these APIs. Constants such as G_PAYEE_LEVEL_PARTY, G_PAYEE_LEVEL_SITE, G_PAYEE_LEVEL_SITE_ORG, G_PAYEE_LEVEL_SUPP_SITE, and G_PAYEE_EMP_SITE define the supported payee-level granularity.

Tables Accessed

The package reads and writes the following documented tables through APPS synonyms:

• IBY_EXTERNAL_PAYEES_ALL (with sequence IBY_EXTERNAL_PAYEES_ALL_S) — the primary persistence table for external payee definitions.
• IBY_PAYMENT_METHODS_B and IBY_FORMATS_B — source payment method codes and payment format definitions.
• IBY_ACCOUNT_OWNERS and IBY_CREDITCARD — account ownership and credit card instrument data.
• AP_SUPPLIERS and AP_SUPPLIER_SITES_ALL — supplier and supplier site attributes referenced at supplier-site payee level.
• HZ_PARTIES, HZ_PARTY_SITES, HZ_CUST_ACCOUNTS, HZ_CUST_ACCT_SITES_ALL, HZ_CUST_SITE_USES_ALL, and HZ_LOCATIONS — Trading Community Architecture party, site, and location data.
• FND_NEW_MESSAGES — message text for validation errors returned to the caller.

Usage Notes

IBY_DISBURSEMENT_SETUP_PUB is normally invoked indirectly. The Oracle Payments setup forms, payment process request flows, and related concurrent programs call these APIs rather than performing direct table maintenance. Custom extensions that create or maintain third-party payee records should likewise call the public APIs so that validation rules, message handling, and dependent instrument assignments remain consistent.

Because the package is referenced by eighteen other packages, changes to its behavior can cascade across payment processing, supplier payment, and disbursement logic. The recommended pattern for custom code is to construct an External_Payee_Rec_Type record, call VALIDATE_EXTERNAL_PAYEE, and branch on the returned status constant before attempting CREATE_EXTERNAL_PAYEE or UPDATE_EXTERNAL_PAYEE. Temporary bank accounts should be handled through CREATE_TEMP_EXT_BANK_ACCT followed by VALIDATE_TEMP_EXT_BANK_ACCT. This sequence keeps error diagnosis aligned with the messages surfaced through FND_NEW_MESSAGES.