Results for “igi_ap_cancel_pkg”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

IGI_AP_CANCEL_PKG is a PL/SQL package owned by the APPS schema in Oracle E-Business Suite. It provides the server-side logic used to cancel Payables invoices within the Oracle Financials product family, specifically serving the functionality surfaced in the EBS user interface under the invoice cancellation action (the query term "ap_cancel_invoices" corresponds directly to the package's public procedure of the same name). The package is declared with AUTHID CURRENT_USER, meaning its unqualified references resolve against the invoking schema's privilege set rather than the definer's, and it is classified in the ETRM repository under API classification OTHER, indicating it is an internal helper rather than a formally published public API such as the AP_INVOICES_PKG family.

The shipped header comment identifies the source file as igicancs.pls at version 115.6, last modified 2002/11/18. This indicates the package originates from the former Oracle Financials for Government/Public Sector (IGI) product line and has been frozen at that release level, while remaining available for invocation in the 12.1.1 and 12.2.2 code lines.

Key Procedures and Functions

The ETRM metadata documents two callable units within the package:

• AP_CANCEL_SINGLE_INVOICE — A function that cancels one invoice identified by its invoice identifier. It accepts the standard audit and context inputs (last updated by, last update login, set of books, accounting date, period name) plus a calling sequence string, and returns a BOOLEAN success indicator. It returns a rich set of OUT parameters describing the outcome: a message name, invoice amount, base amount, tax amount, temporary cancelled amount, cancelled-by identifier, cancelled amount, cancelled date, last update date, and original prepayment amount. The presence of the prepayment output and the temporary cancelled amount suggests the routine is designed to handle prepayment application reversals and to report partial cancellation results.
• AP_CANCEL_INVOICES — A procedure that performs cancellation across a group of invoices rather than a single record. It takes a check identifier (P_CHECK_ID) along with the same audit and context inputs, and returns only two counters as OUT parameters: the number successfully cancelled and the number not cancelled. This signature indicates a batch or payment-oriented cancellation operation where the check identifier scopes the set of invoices to be processed.

Tables Accessed

The ETRM excerpt supplied for this object does not enumerate the base tables referenced through APPS synonyms. Given the function and procedure semantics — invoice cancellation, prepayment tracking, and check-level grouping — the package logically operates against the Payables invoice and payment tables (AP_INVOICES_ALL family, AP_PAYMENT_SCHEDULES_ALL, AP_INVOICE_PAYMENTS_ALL, and the check/payment tables) together with the associated distribution and accounting entry tables. Because the package is declared AUTHID CURRENT_USER, all such references are resolved under the calling user's privileges. Consumers should confirm the exact base table list by inspecting the package body source (igicancs.pls) in the target instance rather than relying on the header listing alone.

Usage Notes

This package is not a published Oracle API and is not referenced by any other documented package in the ETRM repository (referenced by 0 other packages). It is therefore typically invoked indirectly — from Oracle Forms-based invoice entry or adjustment screens that expose a cancellation action, or from internal processing paths that cancel invoices in response to payment or check processing. Custom code and extensions may call AP_CANCEL_INVOICES when implementing bulk cancellation logic scoped by check identifier, or AP_CANCEL_SINGLE_INVOICE for record-level operations.

Two practical cautions apply. First, because the package is ORACLE-owned internal code frozen since 2002, it is not covered by standard API compatibility commitments; upgrade testing is advised before relying on it in customization. Second, callers must supply correct audit columns (P_LAST_UPDATED_BY, P_LAST_UPDATE_LOGIN) and a meaningful P_CALLING_SEQUENCE to preserve traceability. Callers should also handle the BOOLEAN return of AP_CANCEL_SINGLE_INVOICE explicitly, as Boolean values cannot be consumed directly from SQL or non-PL/SQL tools. Where a sanctioned, documented cancellation API exists in the target release, that API should be preferred over direct invocation of this legacy package.