Search Results interface_header_attribute

Overview

ARW_CMREQ_COVER is a public PL/SQL package body owned by APPS that implements the credit memo request engine for Oracle Receivables. It provides the business logic that allows users and programs to raise credit requests against existing transactions, automatically generate credit memos, and cancel pending credit memo requests. In Oracle EBS Release 12.1.1 and 12.2.2 it functions as the transactional backbone behind the Credit Memo Requests window and related concurrent processing. The package name itself indicates its role as a "cover" or façade layer: it exposes a stable, callable interface to credit memo request processing while delegating detailed validation, workflow initiation, and table maintenance to underlying packages. The header comment confirms ongoing maintenance across releases, with bug references such as Bug 3206020 (widening the comments column from 240 to 1760 characters) and Bug 9536019 (an added GL date parameter), reflecting the maturity of this component. The API is classified as OTHER in the ETRM repository, meaning it is not one of the flagship open interfaces such as ar_credit_memo_api, but it remains an important internal dependency referenced by ten other packages in the application.

Key Procedures and Functions

Three procedures and functions are documented for this package:

• AR_REQUEST_CM — A function that creates a credit memo request for a specified customer transaction. It accepts the transaction identifier, line credits flag, line, tax, and freight amounts, a collection of credit lines, a reason code, comments, and numerous optional parameters covering URLs, transaction references, tax exemption certificate number, workflow-skipping flag, credit method selections, batch source name, descriptive flexfield attribute records, dispute date, internal comment, and GL date. It returns a VARCHAR2 result indicating the request identifier or an error condition. Its parameter list is extensive because it must capture every attribute the Credit Memo Requests form can supply, including the flexfield record types that map to the transaction's descriptive and global attributes.
• AR_AUTOCREATE_CM — Automatically creates credit memos from eligible credit memo requests. This routine supports batch-style processing, typically invoked by concurrent programs that sweep pending requests and turn them into actual credit memo transactions in Receivables.
• CANCEL_CM_REQUEST — Reverses or cancels an existing credit memo request, updating the request's status and preventing further processing of the request through the workflow.

Tables Accessed

The package reads and writes the core Receivables credit memo request and transaction tables, all through APPS synonyms:

• RA_CM_REQUESTS, RA_CM_REQUESTS_ALL, RA_CM_REQUESTS_S, RA_CM_REQUEST_LINES — Store the credit memo request header, its translatable and secured variants, and its constituent lines.
• RA_CUSTOMER_TRX, RA_CUSTOMER_TRX_LINES — Provide the original transaction and line context against which the credit is requested, and eventually hold the generated credit memo.
• RA_BATCH_SOURCES, RA_BATCHES — Supply and validate the batch source for automatic credit memo creation and grouping.
• AR_PAYMENT_SCHEDULES and AR_SYSTEM_PARAMETERS — Support amount validation and system-level defaulting.
• WF_EVENT_T — Receives workflow events raised so the credit memo request approval process can be launched.
• FND_PROFILE_OPTION_VALUES and PLITBLM — Used for profile option lookups (for example AFLOG_ENABLED) and internal PL/SQL table handling.

Usage Notes

ARW_CMREQ_COVER is normally invoked indirectly. The Credit Memo Requests form and the automatic credit memo creation concurrent program call into this package rather than exposing its routines directly to users. Custom code should generally prefer the documented public API ar_credit_memo_api for creating credit memos, but when an implementation must replicate the exact behavior of the seeded Credit Memo Requests flow—including reason codes, dispute amounts, flexfield attributes, and workflow initiation—AR_REQUEST_CM is the appropriate entry point. AR_AUTOCREATE_CM should be scheduled as a concurrent job after requests have been entered, and CANCEL_CM_REQUEST is used when a request must be withdrawn before it converts into a credit memo. Because the package writes directly to RA_CM_REQUESTS and related tables and can raise workflow events, callers must ensure that transaction validation and period status are correct before invocation.