Search Results cancel_refund

Overview

AR_REFUNDS_PVT is an internal private PL/SQL package in the Oracle Receivables (AR) module of Oracle E-Business Suite, owned by the APPS schema and classified as a PVT (private) API. It encapsulates the core business logic that governs customer refund processing, one of the mandatory credit management functions within the Order to Cash cycle. A refund in Receivables represents the return of customer funds that were previously received as an unapplied or on-account cash receipt, or that arise from overpayment against an invoice. The package provides the procedural foundation for creating a refund against an existing receipt and for cancelling a previously created refund when the business decision is reversed.

As a private package, AR_REFUNDS_PVT is not intended to be called directly by external integrations or custom code. It is invoked by the public Receivables APIs and by the refund-related forms and concurrent processes that present the user-facing transaction. The package status is VALID in the documented ETRM metadata for both 12.1.1 and 12.2.2, confirming it as an active component of the Receivables codebase.

Key Procedures and Functions

Two documented procedures constitute the public surface of this package:

• CREATE_REFUND — Validates and processes the creation of a customer refund. It applies the requisite validation logic against the source cash receipt, determines the refundable amount, and writes the resulting refund transaction records, including the corresponding payable invoice interface records used to remit funds to the customer or payee.
• CANCEL_REFUND — Reverses a previously created refund. It restores the status of the associated payment, reverses the accounting impact of the original refund transaction, and returns the source receipt to its prior applied or unapplied balance state.

The package is referenced by AR_REFUNDS_PVT itself (recursive internal calls), ARP_REVERSE_RECEIPT, AR_CM_APPLICATION_PUB, and AR_RECEIPT_API_PUB, meaning public receipt APIs and reversal logic delegate refund activity to this private layer rather than manipulating refund tables directly.

Tables Accessed

Documented table references (via APPS synonyms) reflect the cross-module nature of refund processing:

• AR_CASH_RECEIPTS — the source receipt from which refundable funds are derived and whose status is updated on creation or cancellation.
• AR_RECEIVABLE_APPLICATIONS — applied amounts that determine the refundable balance and are reversed when a refund is cancelled.
• AP_INVOICES and AP_INVOICES_INTERFACE (including AP_INVOICES_INTERFACE_S and AP_INVOICE_LINES_INTERFACE_S) — refunds are disbursed through Payables, so the package writes interface records that create the payable invoice to the payee.
• HZ_PARTIES and HZ_PARTY_SITES — source the customer or payee party and the remit-to site information for the refund.
• FND_CURRENCIES and FND_LOOKUPS — currency validation and lookup-driven validation of refund attributes.
• GL_CODE_COMBINATIONS and AP_PRODUCT_SETUP — accounting flexfield and Payables setup validation.
• FND_NEW_MESSAGES, DUAL, and PLITBLM — message retrieval, scalar expressions, and the PL/SQL index-by table of messages used for error reporting.

Usage Notes

AR_REFUNDS_PVT should never be called directly in custom code. It is normally entered through the Receipts workbench when a user creates a refund against an existing receipt, through the AR_RECEIPT_API_PUB public API for programmatic receipt and refund processing, and through AR_CM_APPLICATION_PUB and ARP_REVERSE_RECEIPT when receipts are reversed. Customizations requiring refund functionality should target the supported public APIs that internally invoke this package. Direct modification of the underlying refund and cash receipt tables is not supported and bypasses the validation and accounting logic centralised here.