Search Results ap_holds_pkg




Overview
Explore in AI Chat

Overview

AP_HOLDS_PKG is the core PL/SQL package that Oracle Payables uses to manage invoice holds within Oracle E-Business Suite. Its primary business function is to apply, maintain, and release holds on supplier invoices, which control whether an invoice can proceed to validation, approval, and payment. Holds act as a gating mechanism in the Payables lifecycle: a held invoice cannot be paid until every hold is released. This package therefore sits at the intersection of invoice entry, approval workflow, and payment processing.

The package body is owned by the APPS schema and is documented as VALID in ETRM 12.2.2 metadata. It is classified as an OTHER API rather than a formally published open interface, meaning Oracle does not guarantee it as a supported public API. It exposes seven documented procedures and is referenced by four other packages, making it an internal dependency of broader Payables functionality rather than a leaf-level utility.

Key Procedures and Functions

The documented procedures fall into two groups: generic table maintenance routines and hold-specific business operations.

  • INSERT_ROW — Inserts a new hold record, establishing a hold against an invoice at the row level.
  • LOCK_ROW — Obtains a lock on an existing hold row, typically to serialize concurrent modifications.
  • UPDATE_ROW — Updates the attributes of an existing hold record.
  • DELETE_ROW — Physically removes a hold record.
  • INSERT_SINGLE_HOLD — Applies a single named hold to an invoice. This is the business-level entry point most commonly called by forms and workflow.
  • RELEASE_SINGLE_HOLD — Releases one specific hold from an invoice, allowing that hold's blocking effect to be lifted.
  • QUICK_RELEASE — Releases all releasable holds on an invoice in a single operation, supporting the "Release All Holds" style of action.

The four ROW procedures (INSERT, LOCK, UPDATE, DELETE) follow the standard Oracle table-handler pattern and are lower-level building blocks; the three hold-specific procedures carry the substantive business logic. Parameter lists are not documented and should not be assumed.

Tables Accessed

The package operates across a set of Payables date-tracked and reference tables, accessed through APPS synonyms.

  • AP_HOLDS / AP_HOLDS_ALL — The base and multi-org views of the invoice hold table. These are the principal read/write targets, holding the association between an invoice and its applied holds.
  • AP_HOLDS_S — The shadow table used for date-tracked (multi-org) column maintenance.
  • AP_HOLD_CODES — The hold code definition table, supplying valid hold names and their attributes.
  • AP_INVOICES / AP_INVOICES_ALL — The invoice header tables, read to validate the target invoice and, where releasable holds are permitted, to support hold logic.
  • AP_INVOICE_DISTRIBUTIONS — Invoice line distributions, consulted where hold handling interacts with distribution-level processing.
  • DUAL and PLITBLM — Utility references for scalar evaluation and PL/SQL table bulk operations.

Usage Notes

AP_HOLDS_PKG is invoked primarily by the Payables Invoice Workbench and by the Payables approval workflow, where applying and releasing holds is part of the invoice-to-payment cycle. It is also called from concurrent programs that process or validate invoices in bulk, and internally by the four packages documented as referencing it. Dependency metadata shows additional coupling to AP_INVOICES_PKG, AP_WORKFLOW_PKG, AP_DBI_PKG, AP_ETAX_PKG, AP_ETAX_SERVICES_PKG, and the FND_MESSAGE, FND_MSG_PUB, FND_LOG, and FND_GLOBAL utilities for messaging, logging, and session context.

Because it is not published as a supported public API, customizations should avoid calling it directly where possible; use the documented open interfaces or supported Payables APIs instead. Where direct use is unavoidable, developers must preserve multi-org context and expect behavior to differ between 12.1.1 and 12.2.2 across the AP_HOLDS_ALL and AP_HOLDS_S structures.