Search Results activity_unapplication

Overview

The APPS.AR_CM_APPLICATION_PUB package body provides the public API layer through which Oracle Receivables applies and unapplies credit memos against transactions and payment schedules. It is a published (PUB) API in the Oracle E-Business Suite Accounts Receivable module, meaning it is intended for invocation by external callers such as Oracle Forms, concurrent programs, and custom extensions. The package encapsulates the business logic required to create, adjust, and reverse rows in the receivable applications tables, ensuring that payment schedules, transaction balances, and general ledger distributions remain consistent with the underlying credit memo activity. The header comment identifies it as the "Credit Memo Application API" with the stated function of applying and unapplying credit memos. The original header revision dates to January 2005, with the most recent version reference in the source dating to August 2008, reflecting the code line carried forward into the 12.1.1 and 12.2.2 releases.

Key Procedures and Functions

• ACTIVITY_APPLICATION — The core entry point for applying a credit memo. It accepts standard API control parameters (API version, initialization of the message list, commit flag, validation level, and the return status/message count/message data out parameters) alongside credit memo application parameters that identify the customer transaction, the amount applied, the applied payment schedule, the receivables transaction type, the apply date, the apply GL date, and the USSGL transaction code. Its out parameters report success or failure through the standard FND_MSG_PUB message stack.
• ACTIVITY_UNAPPLICATION — The complementary procedure that reverses a previously applied credit memo activity, restoring the associated payment schedule and transaction balances.
• UNAPPLY_REGULAR_CM — A specialized routine that handles the unapplication of a regular credit memo, providing the reversal logic specific to that credit memo class.

Together these three documented procedures form the apply/unapply lifecycle for credit memos exposed by this package.

Tables Accessed

• AR_RECEIVABLE_APPLICATIONS — The primary table written and read; it stores the application rows created or reversed by the API.
• AR_PAYMENT_SCHEDULES — Updated to reflect amounts applied and remaining balances on the transaction's payment schedule.
• RA_CUSTOMER_TRX — Read to validate the credit memo transaction being applied and to update transaction-level balances.
• AR_CASH_RECEIPTS — Referenced when the application activity is associated with a receipt.
• HZ_PARTIES and HZ_PARTY_SITES — Provide customer and site context for validation.
• FND_CURRENCIES — Supplies currency attributes used during validation and conversion.
• IBY_EXT_BANK_ACCOUNTS, AP_INVOICES, and AP_INVOICES_INTERFACE — Accessed in connection with related payment and refund processing flows.

Usage Notes

The package is typically invoked from Oracle Receivables forms and concurrent programs that perform credit memo application and unapplication, and it is also the supported interface for custom PL/SQL code that must replicate or automate this activity. Callers should supply a valid API version, request message list initialization when required, and choose the commit behavior appropriate to the calling context—FND_API.G_TRUE for standalone automation or FND_API.G_FALSE when the caller manages the transaction. Because the package relies on the standard message stack, callers should always inspect x_return_status and retrieve messages via FND_MSG_PUB utilities when the status is not FND_API.G_RET_STS_SUCCESS. One other package references this API, confirming its role as a shared service within the Receivables application.