Search Results po_document_funds_grp




Overview
Explore in AI Chat

Overview

PO_DOCUMENT_FUNDS_GRP is a group-type PL/SQL package body owned by the APPS schema in Oracle E-Business Suite. It provides the funds control and encumbrance processing layer for the Oracle Purchasing (PO) module in releases 12.1.1 and 12.2.2. Its primary business purpose is to manage the reservation, encumbrance, liquidation, adjustment, and release of budgetary funds associated with purchasing documents — purchase orders, releases, and requisitions — when the deploying organization has enabled budgetary control and encumbrance accounting.

The package is classified as a GRP package, meaning it acts as a group coordinator rather than the primary business object. Internally it delegates the bulk of funds logic to PO_DOCUMENT_FUNDS_PVT (the private worker package), while PO_DOCUMENT_FUNDS_GRP exposes the higher-level orchestration routines invoked by the Purchasing forms, workflow, and concurrent processes. It depends on the standard EBS utility packages FND_API, FND_MSG_PUB, PO_DEBUG, and PO_LOG for error handling, message stacking, and diagnostic logging, and on PO_FCOUT_TYPE, PO_TBL_NUMBER, PO_TBL_VARCHAR1, PO_TBL_VARCHAR5, and PLITBLM for record and table type definitions and list processing. The package body is reported as VALID and is not referenced by any database object directly, though it is referenced by seven other packages.

Key Procedures and Functions

The documented API surface contains sixteen procedures and functions grouped by business purpose:

  • Reservation and validation: CHECK_RESERVE validates whether funds can be reserved before execution; DO_RESERVE performs the actual reservation; IS_RESERVABLE and IS_UNRESERVABLE are predicate functions returning whether a document or distribution is eligible or ineligible for reservation.
  • Release and reversal: DO_UNRESERVE reverses a previously established reservation; DO_RETURN handles funds returned to their source; REINSTATE_PO_ENCUMBRANCE restores encumbrance entries previously relieved.
  • Liquidation and adjustment: DO_LIQUIDATE applies final or partial liquidation against existing encumbrances; CHECK_ADJUST validates whether an adjustment is permissible; DO_ADJUST executes the adjustment to an existing reservation or encumbrance.
  • Rejection and cancellation: DO_REJECT processes a rejected document so funds are released appropriately; DO_CANCEL handles cancellation-driven funds reversal.
  • Closing: DO_FINAL_CLOSE manages the final close of a document from a funds-control perspective, ensuring no residual encumbrance remains.
  • Reporting and utility: POPULATE_ENCUMBRANCE_GT loads data into the PO_ENCUMBRANCE_GT global temporary table for batch processing; GET_ONLINE_REPORT_ID retrieves the concurrent report identifier used for online funds reporting; IS_AGREEMENT_ENCUMBERED determines whether an agreement (such as a blanket or contract) carries encumbrance entries.

Tables Accessed

Through APPS synonyms, PO_DOCUMENT_FUNDS_GRP references PO_DISTRIBUTIONS_ALL, PO_DOCUMENT_TYPES, PO_ENCUMBRANCE_GT, PO_HEADERS_ALL, PO_RELEASES_ALL, PO_REQUISITION_HEADERS_ALL, and PLITBLM. PO_HEADERS_ALL, PO_RELEASES_ALL, and PO_REQUISITION_HEADERS_ALL supply the document headers whose funds status is being evaluated or manipulated. PO_DISTRIBUTIONS_ALL provides the distribution-level detail needed to determine encumbrance amounts by accounting distribution. PO_DOCUMENT_TYPES identifies the document class, which governs whether reservation or encumbrance logic applies. PO_ENCUMBRANCE_GT is the global temporary table populated for batch encumbrance processing. PLITBLM is the standard EBS list table used for passing multi-value lists.

Usage Notes

This package is an internal Purchasing funds-control component and is not intended as a public integration API. It is typically invoked indirectly by the Purchasing forms (POXPOEPO, POXPOERL, POXPOERQ), the Purchasing document approval workflow, and concurrent programs that perform encumbrance, reservation, liquidation, and final-close processing. Custom code should generally call the documented PVT worker package or the supported funds-control APIs rather than invoking PO_DOCUMENT_FUNDS_GRP directly. Because it emits diagnostics through PO_DEBUG and PO_LOG, trace output can be enabled when diagnosing funds-control errors in 12.1.1 and 12.2.2 environments with budgetary control enabled.