Search Results ap_retainage_release_pkg




Overview
Explore in AI Chat

Overview

AP_RETAINAGE_RELEASE_PKG is an Oracle Payables PL/SQL package owned by the APPS schema that supports the retainage release process within Oracle E-Business Suite. Retainage is a portion of a supplier invoice withheld until satisfactory completion of contracted work, most commonly associated with purchase order and project-related expenditures. The package provides the programmatic logic required to create the invoice structure that releases previously withheld retainage amounts back to the supplier, tying together purchasing, Payables, and accounting data. In the documented ETRM metadata the package carries an API classification of OTHER and exposes a single documented procedure, CREATE_RELEASE. Its dependency graph is compact: it references the AP and PO base tables and is referenced by AP_MATCHING_PKG, indicating that the retainage release logic interoperates closely with Payables matching functionality.

Key Procedures and Functions

The documented interface for this package consists of one procedure, CREATE_RELEASE. Its purpose is to construct the Payables invoice records needed to release retainage held against prior invoices and purchase order commitments. Rather than maintaining a broad public API surface, the package relies on this single entry point to generate the release invoice and its related lines and distributions. No parameter lists are documented in the ETRM metadata, so the call signature should be confirmed against the deployed package specification prior to use in custom code.

Tables Accessed

The package operates across the invoicing, purchasing, and accounting data model. AP_INVOICES_ALL and AP_INVOICE_LINES_ALL hold the invoice headers and lines that the release process reads and writes, while AP_INVOICE_DISTRIBUTIONS_ALL, AP_INVOICE_DISTRIBUTIONS, and AP_INVOICE_DISTRIBUTIONS_S provide the accounting distributions and their sequence support. AP_INVOICES and AP_INVOICE_LINES supply base invoice information. PO_LINE_LOCATIONS_ALL and PO_LINES_ALL provide the purchase order schedule and line detail against which retainage was originally accrued, and PLITBLM is a purchasing line table used during that lookup. AP_SYSTEM_PARAMETERS contributes Payables configuration, GL_PERIOD_STATUSES is consulted to validate accounting period state, and FND_PRODUCT_INSTALLATIONS is used to determine installed products. Together these references reflect the need to reconcile the original commitment with the eventual release document.

Usage Notes

AP_RETAINAGE_RELEASE_PKG is typically invoked in the context of the Payables automated and manual invoice creation flow rather than being called directly by end users. Because AP_MATCHING_PKG references this package, the retainage release logic is reached through the standard matching and invoice generation paths in Oracle Payables, including the concurrent programs that build invoices from purchase orders. Customizations that need to trigger a retainage release should call CREATE_RELEASE from their own PL/SQL rather than manipulating the underlying AP invoice tables, since the procedure manages the dependent line and distribution records and preserves referential integrity. When extending or debugging retainage behavior, verify the effective package specification in the target environment, as the public signature is not captured in the ETRM extract. Testing should account for period status, system parameter configuration, and the linkage between the original retained amount and the release invoice.