Search Results remove_documents_payable




Overview

The IBY_DISBURSE_UI_API_PUB_PKG_W package is a public wrapper package in the Oracle E-Business Suite Payments (IBY) module. Its name follows the standard Oracle EBS convention for public API wrappers, where the trailing _W denotes a lightweight wrapper that exposes the underlying business logic of IBY_DISBURSE_UI_API_PUB_PKG to external callers. This package provides the programmatic interface through which the Payments user interface and other calling components manipulate disbursement documents and payments during the payment processing lifecycle. In Releases 12.1.1 and 12.2.2, the package is owned by APPS and is classified as an OTHER API type within the ETRM registry, meaning it is not a canonical open-interface API but rather a supporting utility package.

Key Procedures and Functions

The documented interface exposes 33 procedures. The majority are Rosetta-generated table conversion routines used to marshal PL/SQL collection types across the Java/PLSQL boundary that the Payments forms and OAF-based disbursement pages rely upon:

  • ROSETTA_TABLE_COPY_IN_P0 / _OUT_P0 through ROSETTA_TABLE_COPY_IN_P8 / _OUT_P8 — paired procedures that copy data into and out of strongly typed collection parameters (DOCPAYIDTAB, DOCPAYSTATUSTAB, PMTIDTAB, PMTSTATUSTAB, PMTDOCSTAB, PAPERDOCNUMTAB, PAPERDOCUSEREASONTAB, APPNAMESTAB, and others). The _IN_ variants populate a package-defined record table from a generic JTF_NUMBER_TABLE or JTF_VARCHAR2_TABLE_100; the _OUT_ variants perform the reverse mapping.
  • REMOVE_DOCUMENTS_PAYABLE — the specific routine returned for the search term "remove_documents_payable." It removes the association between payable documents and their payment, effectively detaching documents from a disbursement during payment modification or voiding.
  • REMOVE_PAYMENTS — removes payment records, supporting reversal, void, or re-issue processing flows initiated from the UI.

No parameter lists are reproduced here; callers must consult the package specification directly, as the Rosetta conversion signatures depend on the collection type definitions in the underlying IBY_DISBURSE_UI_API_PUB_PKG.

Tables Accessed

The only table documented via APPS synonyms is PLITBLM, the PL/SQL index-by table used by the Rosetta layer to shuttle tabular data between the Java middle tier and the database session. Direct manipulation of the payments and payment documents tables (IBY_PAYMENTS, IBY_DOCS_PAYABLE_ALL) occurs inside the underlying package invoked by this wrapper, not in the wrapper itself.

Usage Notes

This package is normally invoked implicitly rather than directly. It surfaces in the Payments workbench and disbursement OAF pages when a user removes documents payable from a payment or deletes a payment record. Because the ETRM metadata records zero referencing packages, custom code should treat the wrapper as an internal implementation detail: Oracle does not guarantee a stable public signature across patches. Developers requiring equivalent functionality are advised to call the supported open APIs in the IBY module rather than depending on these Rosetta conversion routines, whose $Header indicates the spec has been frozen since 2006 and is marked noship. Any custom integration that does call it must supply the JTF collection types and expect behavior tied to the active user's payment session.