Search Results ap_web_payments_pkg




Overview
Explore in AI Chat

Overview

APPS.AP_WEB_PAYMENTS_PKG is a PL/SQL package body in the Oracle E-Business Suite Payables (AP) module, delivered under the APPS schema and documented as VALID in both 12.1.1 and 12.2.2. It supports the Oracle iSupplier Portal and Web Expenses payment inquiry functionality, providing the data-access layer behind self-service pages where suppliers, employees, and internal users view payment status, payment history, and prepayment balances without direct access to Payables base tables. The package encapsulates query logic against AP_CHECKS, AP_INVOICE_PAYMENTS, and related invoice and expense report tables, returning summarized payment information suitable for web rendering. It is classified as OTHER in the ETRM API classification, indicating it is an internal implementation package rather than a formally published public API. Its declared dependencies include AP_CHECKS, AP_EXPENSE_REPORT_HEADERS, AP_INVOICES, AP_INVOICE_DISTRIBUTIONS, AP_INVOICE_LINES, AP_INVOICE_PAYMENTS, and AP_LOOKUP_CODES, with FND_PROFILE used for profile-option-driven behavior such as organizational and security context.

Key Procedures and Functions

The ETRM metadata documents seven procedures and functions within this package body:

  • GET_PAID_BY_LIST — Returns the list of payment entities or paid-by values associated with a supplier's or employee's payments, used to populate selection lists on the web payment pages.
  • GET_TOTAL_PAYMENTS_MADE — Calculates the aggregate amount of payments made, typically for display as a summary total on the payment inquiry page.
  • GET_CHECKID — Retrieves the check identifier (AP_CHECKS.CHECK_ID) for a given payment, enabling drill-down from the summary view to payment detail.
  • GET_LAST_PAYMENT_DATE — Returns the most recent payment date for the entity in context, supporting "last paid" indicators on the inquiry screens.
  • GET_PREPAY_AMOUNT_REMAINING — Returns the remaining unapplied amount on a prepayment, reflecting the net of the original prepayment and its applications.
  • GET_PREPAY_BALANCE — Returns the prepayment balance at the supplier or payment level, used in balance inquiry displays.
  • GET_LINE_PREPAY_BALANCE — Returns the prepayment balance at the invoice line level, supporting line-level prepayment application visibility.

No parameter lists are documented in the ETRM extract; signatures should be confirmed against the deployed source in the target environment before direct invocation.

Tables Accessed

The package reads from the following Payables tables through APPS synonyms:

  • AP_CHECKS — Source of payment records, including check identifiers, payment dates, and payment amounts.
  • AP_INVOICE_PAYMENTS — Links invoices to their payments; central to total-paid and last-payment-date calculations.
  • AP_INVOICES — Provides invoice header context for payment and prepayment queries.
  • AP_INVOICE_LINES — Supplies line-level detail required by GET_LINE_PREPAY_BALANCE.
  • AP_INVOICE_DISTRIBUTIONS — Supports distribution-level aggregation where prepayment accounting is derived.
  • AP_EXPENSE_REPORT_HEADERS — Extends payment inquiry to employee expense reports routed through Payables.
  • AP_LOOKUP_CODES — Resolves lookup values for display, such as payment method or status descriptions.

FND_PROFILE is also referenced, indicating the package observes profile options such as MO: Operating Unit or security profiles to scope query results.

Usage Notes

AP_WEB_PAYMENTS_PKG is an internal helper package invoked by Oracle's seeded web-based Payables and iSupplier payment inquiry pages, and by any database object that requires pre-formatted payment summaries. It is not referenced by any other database object per the ETRM dependency listing, and it is not a supported public API, so direct calls from custom code are discouraged. Customizations that require payment or prepayment balance data should preferentially use documented public Payables APIs or views such as AP_INVOICE_PAYMENTS_V or the Payment API, falling back to this package only when the seeded inquiry behavior must be replicated exactly. Because the package is delivered in VALID status and is not wrapped in a public interface, Oracle may change its internal logic without notice during patching or upgrade; any dependency on it should be re-validated after applying 12.1.1 or 12.2.2 patch bundles. Version-specific behavior differences between 12.1.1 and 12.2.2 are limited to OAF page integration and should be verified against the deployed package source.