Search Results book_rma_order

Overview

APPS.OZF_OM_PAYMENT_PVT is a private PL/SQL package within the Oracle E-Business Suite Trade Management (formerly Oracle Trade Management / Oracle Channel Revenue Management) schema. In EBS 12.1.1 and 12.2.2, Oracle reserves the PVT suffix for private implementation packages that support public APIs, and OZF_OM_PAYMENT_PVT fulfills that role for the Order Management (OM) payment flow tied to trade claim settlement. Its principal business function is to create and manage the Order Management payment transactions (RMA orders) that are generated when a customer claim or deduction is approved and settled under the Trade Management claims process. When a claim is approved and a settlement method of order-based credit is selected, this package constructs the supporting sales order in Order Management, drives that order through the booking and completion lifecycle, and returns the resulting order and claim references to the calling settlement routine. The package is classified in the ETRM metadata as an API-classification PVT object owned by APPS, and it is designated VALID, confirming it is deployed and usable in the documented environment.

Key Procedures and Functions

The ETRM metadata documents five procedures and functions within this package. Their purposes, based on the documented names and the surrounding claims/OM context, are:

• CREATE_OM_PAYMENT — Creates the Order Management payment entity that corresponds to an approved trade claim. This is the primary entry point for generating the RMA order used to settle a customer claim, and it establishes the linkage between the claim record and the resulting order.
• COMPLETE_RMA_ORDER — Completes an RMA order that was previously created and booked. Completion finalizes the return/credit flow so the order is no longer open for changes and the credit can be processed.
• BOOK_RMA_ORDER — Books the RMA order, transitioning it from an entered state to a booked state so that Order Management processing (shipping, receiving, credit) can proceed.
• QUERY_CLAIM — Retrieves claim-level information, providing the claim header data needed to drive or validate the OM payment creation process.
• QUERY_CLAIM_LINE — Retrieves claim line-level detail, supplying the individual line records that determine what the OM payment order should contain.

Tables Accessed

The package operates across trade management, order management, pricing, and receivables tables via APPS synonyms. The OZF_CLAIMS, OZF_CLAIMS_ALL, OZF_CLAIM_LINES, and OZF_CLAIM_LINES_ALL tables hold the claim header and line records that drive payment creation and are queried by QUERY_CLAIM and QUERY_CLAIM_LINE. OE_ORDER_LINES and OE_ORDER_LINES_ALL store the RMA order lines written during CREATE_OM_PAYMENT, while OE_ORDER_SOURCES identifies the order source used when the RMA order is instantiated. QP_LIST_LINES and QP_PRICING_ATTRIBUTES support pricing and qualifier handling applied to the order. HZ_CUST_ACCOUNT_ROLES provides the customer account role context for the transaction. RA_CUSTOMER_TRX_LINES links the payment activity back to receivables transactions, and PLITBLM is a standard EBS PL/SQL table type used for internal list processing.

Usage Notes

OZF_OM_PAYMENT_PVT is a private package and is not intended for direct invocation by customer code; it is called internally by public-facing packages in the Trade Management claims flow. The ETRM dependency listing confirms it references FND_API, OZF_CLAIM_PVT, and OZF_CLAIM_LINE_PVT, and is referenced by OZF_CLAIM_SETTLEMENT_PVT, OZF_OM_VALIDATION_PVT, and itself. The most frequent invocation path is OZF_CLAIM_SETTLEMENT_PVT during claim settlement, where CREATE_OM_PAYMENT, BOOK_RMA_ORDER, and COMPLETE_RMA_ORDER are executed in sequence to produce and finalize the RMA credit order. OZF_OM_VALIDATION_PVT calls into the package to validate that a claim is eligible for OM payment before settlement proceeds. In practice the package is triggered through the Trade Management claim settlement UI and associated concurrent programs rather than being called from forms or custom code directly. Because it is a PVT object, its signatures are not part of Oracle's supported public API surface and are subject to change between patch levels; any custom code should invoke the public claim settlement APIs instead.