Search Results ar_br_cancel_unpaid_api_pub




Overview
Explore in AI Chat

Overview

The APPS.AR_BR_CANCEL_UNPAID_API_PUB package is a public PL/SQL API within the Oracle E-Business Suite Receivables module, delivered in the APPS schema and validated as VALID in both Oracle EBS 12.1.1 and 12.2.2. Its designated purpose is to reverse or cancel the "unpaid" designation applied to a receivables transaction or receipt, restoring the record so that subsequent collection or settlement processing can proceed. The "BR" infix indicates that the package belongs to the Brazil localizations family of Receivables APIs, which address country-specific fiscal, tax, and banking requirements. In Brazilian operations, the clearing and reversal of unpaid items frequently intersects with bank return processing, corrective remittance events, and fiscal reporting obligations, so a dedicated public API is exposed rather than requiring direct table manipulation. The _PUB suffix confirms that the package is classified as a public API and is therefore a supported programmatic entry point for extensions and integrations. As a child of the Oracle Application Object Library standards, it depends on FND_API for its standard API error-handling and message-buffer infrastructure.

Key Procedures and Functions

The documented ETRM metadata exposes a single public program unit: CANCEL_OR_UNPAID. As the name implies, this procedure performs the cancellation or reversal of the unpaid status on the target Receivables entity. Its responsibilities typically include validating that the record is eligible for the operation, applying the reversal of the unpaid marker, updating the affected transaction or receipt rows, and returning success or failure through the standard FND_API return status convention. Parameter lists are not published in the available metadata and are deliberately not reproduced here; callers should obtain the authoritative signature directly from the package specification. Because the procedure is grouped under the public API classification, it is intended to be called by external code rather than being reserved for internal package use.

Tables Accessed

The ETRM metadata for this package does not enumerate specific base tables, and table-level dependencies are recorded only indirectly. All table access performed by the package occurs through APPS synonyms resolved against the Oracle Receivables and Oracle Cash Management data model, which is the standard pattern for public Receivables APIs. The package therefore reads and writes the AR transaction and receipt tables that carry the unpaid flag, together with associated adjustment and application records required to keep the accounting consistent. It also relies on the FND_API and STANDARD dependencies for error handling. Because of the Brazil localization context, related localization tables may be touched. The absence of documented table references should be treated as a limitation of the indexed metadata rather than as evidence that the package performs no data manipulation.

Usage Notes

AR_BR_CANCEL_UNPAID_API_PUB is normally invoked programmatically. The most common contexts are Brazilian localization concurrent programs and bank return or lockbox processing flows that must undo an unpaid determination, and custom PL/SQL extensions that need to reconcile a receipt or transaction after an external banking event. It is not invoked from standard Oracle Receivables forms in the base (non-localized) application. Callers must use the FND_API return status and message stack to detect errors, and because the operation affects transactional balances, it should be invoked within a controlled transaction boundary with appropriate rollback handling. When troubleshooting, resolve the package body and the referenced FND_API and STANDARD objects using the ETRM "show dependent code" links, and confirm that the target record is eligible before calling CANCEL_OR_UNPAID.