Search Results get_paid_by_list

Overview

POS_AP_INVOICE_PAYMENTS_PKG is a public PL/SQL package owned by the APPS schema in Oracle E-Business Suite. It resides in the Oracle Payables (AP) product family and is associated with the payment-to-invoice relationship maintained by Payables. The package is classified as OTHER within the ETRM API classification scheme, indicating that it is not part of a formally versioned open interface or public API set, but rather a supporting utility package invoked internally by other Payables components.

The package is declared with the AUTHID CURRENT_USER clause, meaning that its SQL statements execute under the privileges of the invoking user rather than the package owner. This is a design characteristic typical of APPS-owned utility code that relies on APPS synonyms to resolve object names at runtime. The header comment dates the source to release 11.5.x lineage, and the package continues to be shipped in Oracle EBS 12.1.1 and 12.2.2 without documented signature changes.

The single documented function, GET_PAID_BY_LIST, returns a VARCHAR2 value. Its stated purpose is to derive a textual description of the payment or payments associated with a given invoice and payment number. This supports presentation of payment information to end users without requiring the calling form or report to join the payment tables directly.

Key Procedures and Functions

The package exposes exactly one documented program unit.

• GET_PAID_BY_LIST — A function returning VARCHAR2. It accepts two input values: an invoice identifier and a payment number, and returns a formatted character string describing the payment context for that invoice. The exact concatenation format is not exposed in the documented metadata and should be treated as implementation detail. The function carries the PRAGMA RESTRICT_REFERENCES(..., WNDS) directive, asserting that it writes no database state. This makes it safe for use inside SQL statements and guarantees no side effects on persisted data.

No other procedures or functions are documented in the ETRM record. The package is therefore narrow in scope and should not be regarded as a general-purpose payment API.

Tables Accessed

The package resolves the following objects through APPS synonyms:

• AP_INVOICES and AP_INVOICES_ALL — Invoice header information, consulted to identify the invoice being described.
• AP_INVOICE_PAYMENTS and AP_INVOICE_PAYMENTS_ALL — The association between invoices and the payments applied against them, forming the core input to the returned payment list.
• AP_CHECKS and AP_CHECKS_ALL — Payment documents, used to obtain payment numbers, dates, and related attributes for the descriptive string.

Because the function is declared with WNDS and returns a scalar, the access pattern is read-only against these tables. The _ALL variants are the multi-org enabled base objects in Release 12, while the non-_ALL names are compatibility views; the package's dependence on both reflects its 11.5.x origin and continued operation under the 12.x data model.

Usage Notes

POS_AP_INVOICE_PAYMENTS_PKG is referenced by two other packages in the ETRM dependency graph, confirming that it is an internal helper rather than an entry point invoked directly by end users. Typical invocation occurs from Payables forms, reports, or enclosing PL/SQL packages that need to render a readable summary of payments applied to an invoice.

Because GET_PAID_BY_LIST is restricted with WNDS, it may be called from SQL as well as PL/SQL. Customizations should nevertheless treat the package as unsupported: it is classified as OTHER, carries no public API guarantee, and its return format is not documented. Extensions should call it only where the returned string is displayed, never parsed. Where an organization requires a stable, documented interface to payment-invoice data, the supported Payables public APIs and views should be used instead.