Search Results do_liquidate

Overview

APPS.PO_DOCUMENT_FUNDS_GRP is the grouping (wrapper) API layer for funds control and encumbrance processing in Oracle Purchasing. It exposes a consolidated, user-facing interface over the private implementation package PO_DOCUMENT_FUNDS_PVT, which holds the actual business logic for reservation, encumbrance, liquidation, and adjustment of funds against purchasing documents. The package is defined with AUTHID CURRENT_USER, meaning its SQL statements execute under the privilege domain of the calling schema rather than the APPS schema.

The package participates in the Oracle E-Business Suite funds control model used by Purchasing, iProcurement, and Public Sector Financials. It governs the encumbrance lifecycle across requisitions, purchase orders, blanket purchase agreements, releases, and mixed purchase order/release documents. Three encumbrance modes are supported — reservation (commitment accounting at document creation), encumbrance at invoice/final close, and no encumbrance — and the package's procedures enforce the correct mode for each document level. The header block declares typed constants for document types, document subtypes, document levels (HEADER, LINE, SHIPMENT, DISTRIBUTION), and distribution types, all inherited from PO_DOCUMENT_FUNDS_PVT. These constants keep callers from passing literal values and allow the underlying private package to redefine them centrally.

Key Procedures and Functions

• DO_RESERVE — Creates the funds reservation against a purchasing document, encumbering the appropriate budget for the document type and level.
• DO_UNRESERVE — Releases a previously created reservation without liquidating it against an actual expenditure.
• DO_LIQUIDATE — The procedure of interest to requesters searching "do_liquidate". It converts an existing reservation into a permanent encumbrance when the referenced document (or its final-close event) is processed, matching the reservation to the resulting obligation.
• DO_RETURN — Returns or reverses reserved funds, restoring the original budget availability.
• DO_REJECT — Rejects a reservation request, typically driven by approval or workflow failure conditions.
• DO_CANCEL — Cancels the encumbrance associated with a document that has been cancelled.
• DO_ADJUST — Adjusts the reserved or encumbered amount, for example when a document is modified or a price change is applied.
• DO_FINAL_CLOSE — Performs the encumbrance processing required when a purchasing document reaches final close, including liquidation of any remaining reservation.
• CHECK_RESERVE / CHECK_ADJUST — Validation routines that determine whether a reservation or adjustment request is permissible before the corresponding DO_ procedure is executed.
• REINSTATE_PO_ENCUMBRANCE — Restores an encumbrance that was previously reversed or cancelled, re-establishing the commitment against the budget.
• IS_RESERVABLE / IS_UNRESERVABLE / IS_AGREEMENT_ENCUMBERED — Predicate functions that report the funds-control state of a document, used by callers to branch their processing logic.
• POPULATE_ENCUMBRANCE_GT — Populates the PO_ENCUMBRANCE_GT global temporary table, typically as a preprocessing step for reports or mass encumbrance operations.
• GET_ONLINE_REPORT_ID — Retrieves the identifier of the online report associated with a funds operation, used for request tracking and audit purposes.

Tables Accessed

• PO_DOCUMENT_TYPES — Source of the document type codes used by the declared constants and by type-checking logic.
• PO_HEADERS_ALL — Provides the purchasing document header, its type lookup codes, and the document context required for encumbrance determination.
• PO_RELEASES_ALL — Supplies release type information for blanket and scheduled releases.
• PO_REQUISITION_HEADERS_ALL — Supplies requisition context when funds processing originates from a requisition.
• PO_DISTRIBUTIONS_ALL — Carries the accounting distributions against which reservation, liquidation, and adjustment are applied.
• PO_ENCUMBRANCE_GT — Global temporary table populated by POPULATE_ENCUMBRANCE_GT for batch and reporting operations.
• PLITBLM — The standard Oracle Applications PL/SQL table of line-level messages used to return error and warning information to callers.

Usage Notes

PO_DOCUMENT_FUNDS_GRP is not intended for direct interactive invocation. It is called from Purchasing forms when a user reserves, adjusts, cancels, or final-closes a document, from the concurrent programs that perform encumbrance and funds checking, and from other PL/SQL packages — seven packages are documented as referencing it. Because it is a GRP layer, custom code should call these procedures rather than the PVT layer so that validation and messaging remain consistent with standard Oracle behavior. Callers should invoke the CHECK_ routines first, then the corresponding DO_ routine, and inspect the PLITBLM message table for outcome. Funds control prerequisites, including the relevant budgetary control and encumbrance options, must be enabled for the operating unit before liquidation or reservation will produce accounting entries. The AUTHID CURRENT_USER declaration means the calling schema must hold the necessary grants on the referenced tables, which are normally accessed through APPS synonyms.