Search Results remove_payment
Overview
IBY_DISBURSE_UI_API_PUB_PKG is the public PL/SQL API in the Oracle Payments (IBY) module that exposes disbursement and payment lifecycle operations to the E-Business Suite user interface, concurrent programs, and integration code. Its role is to serve as the single supported entry point through which callers perform actions against an existing payment or payment instruction — stopping, voiding, terminating, resubmitting, or reprinting — without direct manipulation of the underlying IBY and Oracle Payables base tables. The package belongs to the APPS schema and is classified as a public API, which means its procedures are intended for external consumption by both Oracle-delivered and customer-written code. In the EBS 12.1.1 and 12.2.2 technology stacks the package is VALID and compiled against the standard dependencies of FND_API and FND_LOG (for the common API error-handling and debug-messaging conventions) and the SYS STANDARD package. The package forms part of the disbursement engine that drives Oracle Payments integration with Payables, where the Payments workbench and the Payables payment forms invoke it to translate user actions into validated, logged database operations. Customers searching for "iby_validationsets_pub" will note that IBY_VALIDATIONSETS_PUB depends on IBY_DISBURSE_UI_API_PUB_PKG, reflecting the fact that validation-set processing ultimately calls into this disbursement API when validating payment and payment-instruction records.
Key Procedures and Functions
The package exposes sixty-two documented subprograms. The principal groups are as follows.
- Payment stop operations: PAYMENT_STOP_REQUEST, PAYMENT_STOP_RELEASE, STOP_PAYMENT, and STOP_PAYMENTS initiate or release stop requests against one or more payments.
- Void operations: VOID_PAYMENT, VOID_PMT_INTERNAL, and VOID_PMTS_INTERNAL perform the voiding of payment records; IS_VOID_ALLOWED determines whether a given payment is in a state that permits voiding, supporting UI enablement decisions.
- Document payable maintenance: REMOVE_DOCUMENT_PAYABLE and REMOVE_DOCUMENTS_PAYABLE detach documents payable from a payment or instruction prior to re-disbursement.
- Payment and request removal: REMOVE_PAYMENT, REMOVE_PAYMENTS, and REMOVE_PAYMENT_REQUEST delete or detach payment and associated request records as part of rework handling.
- Instruction termination and resubmission: TERMINATE_PMT_INSTRUCTION and TERMINATE_PMT_REQUEST stop payment instructions and requests; RESUBMIT_PMT_REQUEST and RESUBMIT_INSTRUCTION return them to the disbursement flow.
- Validation and document numbering: VALIDATE_PAPER_DOC_NUMBER and VALIDATE_PAYMENT_DOCUMENT verify paper document and payment document data ahead of printing or creation.
- Reprint: REPRINT_PRENUM_PMT_DOCUMENTS regenerates prenumbered payment documents when reprinting is required.
The metadata does not document parameter lists; callers should obtain exact signatures from the package specification rather than inferring them.
Tables Accessed
Through APPS synonyms the package reads and writes the core disbursement tables, including IBY_PAYMENTS_ALL, IBY_PAY_INSTRUCTIONS_ALL, IBY_DOCS_PAYABLE_ALL, IBY_PAY_SERVICE_REQUESTS, IBY_PROCESS_CONC_REQUESTS, IBY_PROCESS_FUNCTIONS, IBY_PROCESS_ORGS, IBY_FORMATS_B, IBY_COMPLETED_PMTS_GROUP_S, and IBY_EXTERNAL_PAYEES_ALL. Payment document and bank account data are sourced from CE_PAYMENT_DOCUMENTS and IBY_EXT_BANK_ACCOUNTS, supplier context from AP_SUPPLIERS, and application and concurrent-request context from FND_APPLICATION and FND_CONCURRENT_REQUESTS. These accesses support status transitions, instruction grouping, document numbering, format resolution, and concurrent request tracking during stop, void, terminate, resubmit, and reprint operations.
Usage Notes
IBY_DISBURSE_UI_API_PUB_PKG is referenced by thirteen packages, including AP_AUTOSELECT_PKG, AP_PAYMENT_UTIL_PKG, AP_PAY_SINGLE_INVOICE_PKG, AP_VOID_PKG, IBY_DISBURSE_SUBMIT_PUB_PKG, IBY_BUILD_INSTRUCTIONS_PUB_PKG, IBY_PAYGROUP_PUB, IBY_VALIDATIONSETS_PUB, IBY_EXTRACTGEN_PVT, IBY_CHECKNUMBER_PUB, IBY_FD_USER_API_PUB, and IBY_FD_POST_PICP_PROGS_PVT. It is therefore invoked broadly from Payables payment forms and void flows, from the Payments workbench, from validation-set processing, and from concurrent programs; the accompanying wrapper package IBY_DISBURSE_UI_API_PUB_PKG_W exists to support form-based invocation. Custom code should call the public API rather than the internal procedures, honouring the FND_API error-handling conventions and enabling FND_LOG diagnostics where troubleshooting is required. Because the package mutates payment state, callers must commit or roll back within their own transaction boundaries as directed by the surrounding application flow.