Search Results create_header_cm




Overview

ARW_CM_COVER is a private PL/SQL package body owned by APPS in the Oracle E-Business Suite Receivables module. Its name and internal naming conventions indicate that it provides the underlying implementation for credit memo creation within the Receivables credit transaction workflow. The package is declared as PACKAGE BODY arw_cm_cover and carries a header reference dating to Release 12.1.1 (ARWCMCVB.pls 120.19.12010000.1). It is classified in ETRM as an OTHER API rather than a published public API, which confirms that it is intended for internal consumption by other Receivables components rather than as a customer-facing integration interface. The package encapsulates document sequencing logic for credit memos alongside the header and line creation routines, wrapping them with standardized FND message handling and debug tracing through FND_MSG_PUB and ARP_UTIL.

Key Procedures and Functions

Three documented procedures constitute the package's functionality:

  • GET_DOC_SEQ — Retrieves the next document sequence value and sequence identifier for a credit memo. The source excerpt shows it patterned after the get_doc_seq routine in ARXPRELB.pls and driven by the document sequence categories documented as A (Always Used), P (Partially Used), and N (Not Used). It also honors a package-level unique_seq_numbers flag introduced under Bug 3041195.
  • CREATE_HEADER_CM — Creates the credit memo header record, populating the RA_CUSTOMER_TRX structure along with associated currency and transaction type attributes.
  • CREATE_LINE_CM — Creates the credit memo line records and their corresponding accounting distributions, completing the transaction document structure.

All three procedures follow the ETRM-standard error reporting model using p_errors style output parameters and FND message levels, with return status conveyed through FND_API.G_RET_STS_SUCCESS.

Tables Accessed

The package reads and writes the following tables through APPS synonyms:

  • RA_CUSTOMER_TRX and RA_CUSTOMER_TRX_LINES — the primary transaction header and line tables populated by the create procedures.
  • RA_CUST_TRX_LINE_GL_DIST — receives the accounting distributions generated for each credit memo line.
  • RA_CUST_TRX_TYPES, RA_BATCH_SOURCES, and RA_BATCHES — supply the transaction type, batch source, and batch context required when creating credit memos.
  • AR_PAYMENT_SCHEDULES — stores the payment schedule rows generated for the new transaction.
  • AR_SYSTEM_PARAMETERS — provides Receivables system option values that govern defaulting behavior.
  • FND_CURRENCIES — validates and resolves currency attributes for the transaction.
  • PLITBLM — the standard Oracle Applications temporary table used for messaging and list processing.

Usage Notes

ARW_CM_COVER is invoked internally by one other documented package and is not exposed as a standalone concurrent program or form-level API. Its document sequencing routine may be called independently when the calling process requires only sequence allocation, while the two creation routines are invoked together to build a complete credit memo. Custom code that calls this package directly should treat it as an unsupported interface, as it lacks the formal API contract of a published PL/SQL API. Debug output is controlled through the AFLOG_ENABLED profile option, and error information is returned through the standard p_errors-style output parameters and FND message stack.