Results for “oe_prepayment_pvt”

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

Overview

The APPS.OE_PREPAYMENT_PVT package is a private (PVT) PL/SQL API within the Oracle Order Management (OM) module of Oracle E-Business Suite. Its purpose is to manage prepayment processing on order headers, converting authorized prepayment amounts into Oracle Receivables receipts, applying and releasing holds associated with prepaid orders, submitting refund requests to Receivables, and coordinating payment assurance, split payment, and payment receipt printing activities. The package is defined with AUTHID CURRENT_USER, and its header carries the version marker $Header: OEXVPPYS.pls 120.10.12020000.1 2012/06/26, indicating ongoing maintenance through the later R12 releases covered by 12.1.1 and 12.2.2.

The package exists to bridge Order Management and Receivables: an order entered in OM with prepayment terms must result in a receipt in AR, and any reversal of that transaction must result in a refund. The package encapsulates that orchestration so that the Order Management forms and concurrent programs do not invoke the AR APIs directly.

Key Procedures and Functions

The ETRM metadata documents 22 procedures and functions. The central operations are:

• CALCULATE_PENDING_AMOUNT — a function accepting an order header record that returns the pending amount to be processed, incorporating the threshold factor defined for prepayment eligibility.
• CREATE_RECEIPT — calls the Oracle Receivables API to create a receipt for the specified amount. It is invoked from PROCESS_PAYMENT, accepts a header record, amount, receipt method, bank account identifiers, a transaction extension identifier used for R12 credit card encryption, and returns payment set, receipt number, payment number, approval code, and standard message/return status outputs.
• REFUND_REQUEST — calls the AR API to submit a refund request for a specified amount against an order header.
• PROCESS_PREPAYMENT_ORDER — the top-level driver that evaluates a prepayment order and routes it through the appropriate processing path.
• Hold management procedures — ANY_PREPAYMENT_HOLD_EXISTS, RELEASE_PREPAYMENT_HOLD, APPLY_PREPAYMENT_HOLD, RELEASE_PAYMENT_HOLD, DELETE_PAYMENT_HOLD, and ANY_PAYMENT_HOLD_EXISTS — determine whether prepayment or payment holds are active and apply or remove them.
• Payment processing procedures — PROCESS_PAYMENTS, PROCESS_PAYMENT_ASSURANCE, PROCESS_PAYMENT_REFUND, SPLIT_PAYMENT, DELETE_PAYMENTS, UPDATE_HDR_PAYMENT, UPDATE_PAYMENT_NUMBERS, and CREATE_REFUND — handle the lifecycle of individual payment records linked to an order.
• GET_FORMAT_MASK and PRINT_PAYMENT_RECEIPT — support formatting and printing of the payment receipt.

The package stores a package-level state variable, g_process_pmt_req_logged, used to avoid duplicate logging of payment request activity.

Tables Accessed

Access to base tables is performed through APPS synonyms. The principal tables include OE_PAYMENTS, which holds the payment records created against orders; OE_ORDER_HEADERS and OE_ORDER_HEADERS_ALL, the order header records being processed; OE_HOLD_SOURCES_ALL, which defines the hold sources applied to prepaid orders; and MTL_SYSTEM_ITEMS, used to validate item detail where required. On the Receivables side the package references AR_RECEIPT_CLASSES, AR_RECEIPT_METHODS, and AR_RECEIPT_METHOD_ACCOUNTS to determine how a receipt should be created. Banking and payment instrument data are drawn from AP_BANK_ACCOUNTS, IBY_FNDCPT_TX_OPERATIONS, and IBY_TRXN_SUMMARIES_ALL, the latter supporting the R12 payments model and credit card encryption. Customer account and site information is read from HZ_CUST_ACCT_SITES_ALL and HZ_CUST_SITE_USES_ALL, while FND_CURRENCIES and RA_TERMS supply currency and payment terms validation.

Usage Notes

Because the package is classified as PVT, it is not intended as a public extension point and Oracle does not guarantee its signature across patches; custom code should generally call the public Order Management APIs instead. In standard operation the package is invoked indirectly through the Order Management sales order form and through Order Management concurrent programs that process prepayment, payment assurance, and refund workflows. The metadata records that the package is referenced by eight other packages, confirming that it sits below the public API layer. Values such as p_receipt_number and p_payment_number were added to support specific fixes (bugs 4724845 and 7559372), and the credit card encryption parameter p_trxn_extension_id reflects R12 payment instrument handling. When troubleshooting prepayment receipts, refunds, or stuck prepayment holds, the package's hold and payment procedures are the usual starting point for diagnosis.