Search Results payment_instruction_unclearing




Overview
Explore in AI Chat

Overview

The APPS.IBY_CE_BATCH_RECON_PKG package is a payments reconciliation API in Oracle E-Business Suite that supports batch-level clearing of R12 payment instructions against bank statement data in Oracle Cash Management. Its header comment describes it as an API called by Cash Management for reconciliation at the batch level with Release 12 IBY payment instructions. It is explicitly modeled on AP_RECONCILIATION_PKG.Recon_Payment_History(), the corresponding Accounts Payable batch clearing routine. The package performs proration in the same manner as Payables, then invokes product-level APIs at the transaction (payment) level so each owning application can execute its own business logic and update its tables.

The package declaration uses AUTHID CURRENT_USER, meaning it executes with the privileges of the calling user rather than the definer. This is consistent with an internal integration point invoked from the Cash Management reconciliation flow rather than a publicly callable interface, and the ETRM classification for the package is OTHER.

Key Procedures and Functions

Two procedures are documented in the package specification:

  • PAYMENT_INSTRUCTION_CLEARING — Performs the clearing reconciliation for a single payment instruction. It accepts the payment instruction identifier along with clearing, accounting, transaction, error, and charge amounts, currency and exchange rate context (rate type, rate date, rate between payment and functional currency), matched flag, actual value date, and a set of passed-back Cash Management parameters including the pass-in mode, statement line identifier, statement line type, logical group reference, and calling sequence. Standard audit columns (last update, created by, creation date, program and request identifiers) are also passed. Internally the procedure prorates amounts, following the Payables batch clearing model, and calls downstream product APIs at payment level.
  • PAYMENT_INSTRUCTION_UNCLEARING — Reverses a previously applied clearing. It accepts the payment instruction identifier, accounting date, matched flag, last update attributes, and related audit and calling context, restoring the affected records to their uncleared state.

Tables Accessed

Access is through APPS synonyms. The package reads and writes IBY payment instruction and payment data (IBY_PAYMENTS_ALL, IBY_PAY_INSTRUCTIONS_ALL, IBY_PAY_SERVICE_REQUESTS), and interacts with Cash Management reconciliation and cashflow structures (CE_CASHFLOWS, CE_CASHFLOW_ACCT_H, CE_PAYMENT_TRANSACTIONS, CE_SECURITY_PROFILES_GT). It also references Payables-side tables, including AP_CHECKS and AP_CHECKS_ALL for payment records, AP_PAYMENT_HISTORY for clearing history, and AP_SYSTEM_PARAMETERS for system-level configuration governing reconciliation behavior. The Cash Management tables supply statement line and cashflow context; the IBY tables supply the payment instruction and payment objects being reconciled; the AP tables are updated as part of the clearing and unclearing outcomes.

Usage Notes

The package is intended to be invoked by Oracle Cash Management during bank statement reconciliation, executing in batch at the payment instruction level, and it is documented as referenced by one other package. Because it is an internal integration API, it is invoked programmatically from the Cash Management reconciliation flow rather than from a standalone form or directly by end users; Cash Management passes the statement line and pass-in mode context and receives the pass-back values. Where the metadata is limited, the parameters in the specification should be treated as the authoritative contract, and callers should not assume additional public entry points beyond PAYMENT_INSTRUCTION_CLEARING and PAYMENT_INSTRUCTION_UNCLEARING. Custom code that reproduces clearing logic should call these procedures rather than updating the underlying tables directly, so that product-level business logic runs correctly.