Search Results get_encumbered_flag

Overview

APPS.AP_INVOICE_LINES_UTILITY_PKG is a utility package in the Oracle Payables (AP) module that centralizes the query and validation logic applied to invoice lines. Its primary business function is to expose stateless helper functions that answer specific questions about a given invoice line — for example, whether the line is encumbered, what its posting and approval statuses are, whether it can be discarded or deleted, and whether its distributions have been transferred to or referenced by other subledgers such as Fixed Assets or Projects. By encapsulating these rules in one package, Oracle Payables ensures that forms, concurrent programs, and internal APIs apply the same criteria when they evaluate a line's eligibility for deletion, discard, or further processing. The package is classified as OTHER within the ETRM metadata and is owned by the APPS schema, with source header information placing it in the 12.1.x code line (version 120.13). It is referenced by eleven other packages, which confirms its role as a shared low-level dependency rather than an end-user-facing API. The user's search term, get_encumbered_flag, corresponds to one of the package's twenty-five documented functions, which reports whether a particular line is subject to encumbrance accounting.

Key Procedures and Functions

The documented functions fall into several functional groups. The most commonly referenced group deals with line status retrieval:

• GET_ENCUMBERED_FLAG — returns a flag indicating whether the specified invoice line is encumbered, allowing callers to branch on encumbrance accounting behavior.
• GET_POSTING_STATUS — returns the posting status of the line, indicating whether accounting events have been created or posted.
• GET_APPROVAL_STATUS — returns the approval status for the line, used by forms and validation routines.
• GET_PACKET_ID — returns the packet identifier associated with the line, relevant to payment batch or grouping logic.

A second group governs whether a line may be removed or discarded:

• IS_LINE_DISCARDABLE — determines whether the line can be discarded, returning an error code through an OUT parameter.
• CAN_LINE_BE_DELETED — determines whether the line can be deleted, again returning an explanatory error code.

A third group answers existence and cross-module reference questions:

• ALLOCATION_EXISTS and OUTSTANDING_ALLOC_EXISTS — detect allocations, including outstanding ones, for a line.
• INV_REVERSED_VIA_QC — indicates whether the invoice was reversed through QuickCheck.
• IS_LINE_DISTS_TRANS_FA and LINE_DISTS_TRANS_PA — test whether line distributions have been transferred to Fixed Assets or Projects.
• LINE_DISTS_ACCT_EVENT_CREATED — tests whether an accounting event exists for the line distributions.
• LINE_REFERRED_BY_CORR, LINE_DISTS_REFERRED_BY_OTHER, IS_LINE_A_CORRECTION, and LINE_REFERRED_BY_ADJUSTMENT — detect references created by corrections, adjustments, or other lines.

A fourth group covers distribution and amount validation:

• IS_LINE_FULLY_DISTRIBUTED and IS_INVOICE_FULLY_DISTRIBUTED — verify that line and invoice amounts are fully distributed.
• IS_PO_RCV_AMOUNT_EXCEEDED — checks whether a purchase order or receipt amount tolerance has been exceeded.
• PENDING_ALLOC_EXISTS_CHRG_LINE — checks for pending allocations on a charge line.

Tables Accessed

The package queries and, in some cases, evaluates data from a broad set of Payables and general ledger tables through APPS synonyms. Invoice line and header data is read from AP_INVOICE_LINES, AP_INVOICE_LINES_ALL, AP_INVOICES, and AP_INVOICES_ALL. Distribution information is sourced from AP_INVOICE_DISTRIBUTIONS and AP_INVOICE_DISTRIBUTIONS_ALL. Allocation logic relies on AP_ALLOCATION_RULES and AP_ALLOCATION_RULE_LINES. Hold information is read from AP_HOLDS_ALL, while payment scheduling data comes from AP_PAYMENT_SCHEDULES and AP_PAYMENT_SCHEDULES_ALL. System configuration and accounting calendar context are drawn from AP_SYSTEM_PARAMETERS_ALL, FINANCIALS_SYSTEM_PARAMS_ALL, GL_CODE_COMBINATIONS, and GL_PERIOD_STATUSES. These tables support the status checks, existence tests, and cross-module reference validations described above.

Usage Notes

Because the package exposes small, stateless functions, it is typically invoked from Payables forms, concurrent programs, and custom extensions rather than being called directly by end users. The get_encumbered_flag function, for example, is commonly used in custom validation or reporting code to determine encumbrance treatment for a line before performing further processing. All functions operate on an invoice identifier and line number, and several accept a calling sequence parameter for error tracing. Developers integrating with this package should treat it as an internal utility: its behavior is governed by the current state of the invoice tables, and any custom code should call the documented functions rather than reading the underlying tables directly to preserve consistency with Oracle's standard validation logic. Given its version history (120.13), the package is present in both 12.1.1 and 12.2.2 environments, and the same functional contract applies across both releases.