Search Results arw_cm_cover




Overview
Explore in AI Chat

Overview

ARW_CM_COVER is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that supports the creation of credit memo transactions within Oracle Receivables. It is part of the ARW module library, a family of packages used by Receivables-based features that programmatically generate or stage customer transaction records. The package is documented as VALID in ETRM for both 12.1.1 and 12.2.2 and is classified as an "OTHER" API rather than a formally published public interface, which indicates it is intended primarily for internal consumption by other Oracle components. Its core responsibility is to construct the header and line records required for a credit memo, together with the document sequencing information needed to assign a transaction number consistent with Receivables' numbering rules.

Key Procedures and Functions

The ETRM metadata documents three procedures or functions for this package:

  • GET_DOC_SEQ — Retrieves the applicable document sequence information used when assigning a transaction number to a credit memo. This ensures that generated transactions respect the document sequencing configuration defined for the relevant transaction type and batch source.
  • CREATE_HEADER_CM — Creates the header portion of a credit memo transaction, populating the primary RA_CUSTOMER_TRX record and associated attributes such as transaction type, currency, and batch assignment.
  • CREATE_LINE_CM — Creates the line-level detail for the credit memo, writing the corresponding records in RA_CUSTOMER_TRX_LINES and the related accounting distribution rows in RA_CUST_TRX_LINE_GL_DIST.

No parameter lists are published in the available metadata; the descriptions above reflect the documented object names and their evident role in the credit memo creation flow.

Tables Accessed

ARW_CM_COVER references the following tables through APPS synonyms:

  • RA_CUSTOMER_TRX and RA_CUSTOMER_TRX_LINES — the primary Receivables transaction header and line tables where the credit memo is written.
  • RA_CUST_TRX_LINE_GL_DIST — stores the accounting distributions generated for each credit memo line.
  • RA_CUST_TRX_TYPES — provides the transaction type definition, including the credit memo class and associated accounting rules.
  • RA_BATCHES and RA_BATCH_SOURCES — supply and reference the batch and batch source context in which the transaction is created.
  • FND_CURRENCIES — validates and supplies currency information for the transaction.
  • AR_PAYMENT_SCHEDULES — records the payment schedule installments associated with the credit memo.
  • AR_SYSTEM_PARAMETERS — provides Receivables system-level defaults that influence transaction creation.
  • PLITBLM — an APPS utility table used for PL/SQL table (index-by table) handling within the package logic.

Validation of the transaction data is delegated to ARP_TRX_VALIDATE, which the package references.

Usage Notes

ARW_CM_COVER is referenced by ARW_CMREQ_COVER, indicating that it is invoked as part of a higher-level credit memo request or cover-letter processing flow rather than being called directly from a standard Oracle form. It is not exposed as a public API and should not be considered a supported extension point for customizations. Custom code that calls it must ensure the environment is properly initialized, since the package depends on valid transaction types, batch sources, and system parameter settings. When invoked, it is expected to run within the transaction scope established by its caller, relying on the caller to supply the batch and credit memo context. Its reliance on document sequencing means that any environment using it must have document sequences defined and enabled for the relevant Receivables transaction types to avoid transaction numbering errors.