Search Results fa_retirement_pub




Overview
Explore in AI Chat

Overview

FA_RETIREMENT_PUB is a public PL/SQL API package owned by the APPS schema in Oracle E-Business Suite Assets. It encapsulates the core business logic for retiring fixed assets and for reinstating assets that were previously retired. The package is classified as a PUB (public) API, meaning it is intended to be called by other Oracle EBS modules, standard concurrent programs, and customer-written extensions rather than being restricted to internal use. It is a central component of the asset lifecycle: when a capitalized asset is taken out of service, transferred to a non-depreciating status, or otherwise disposed of through retirement, the transactions flow through this package. Equally important, FA_RETIREMENT_PUB supports the reverse operations, allowing an incorrectly processed retirement to be undone or a retired asset to be placed back in service.

The dependency footprint demonstrates the package's role as a shared service. FA_RETIREMENT_PUB depends on the standard FND_API and FND_GLOBAL packages, on FA_API_TYPES for its record and table type definitions, and on the SYS.STANDARD package. In turn, it is referenced by nine other packages, including FA_MASSCP_PKG, FA_MASS_REINS_PKG, FA_TRANS_API_PUB, FA_AFE_TRANSACTIONS_PKG, and the CUA (customer user assistance) wrapper packages FA_CUA_HR_RETIREMENTS_PKG and FA_CUA_HR_REINSTATEMENTS_PKG, as well as Oracle Lease Management packages OKL_AM_ASSET_DISPOSE_PVT and OKL_SPLIT_ASSET_PVT. The package status is VALID, confirming it is compiled and available in the APPS schema.

Key Procedures and Functions

The documented public interface consists of four procedures, which form two logical pairs of forward and reversing operations:

  • DO_RETIREMENT — Performs the retirement of one or more assets. It applies the retirement transaction, updates depreciation and book balances, and records the event in asset history. This is the primary entry point for processing an asset retirement.
  • UNDO_RETIREMENT — Reverses a previously processed retirement, restoring the asset to its pre-retirement state. This is used for correction of erroneous retirements and for reinstatement workflows that begin from the retirement side.
  • DO_REINSTATEMENT — Reinstates a retired asset, bringing it back into service and resuming depreciation according to the applicable rules. This supports the business scenario in which an asset is restored to active use.
  • UNDO_REINSTATEMENT — Reverses a previously processed reinstatement, returning the asset to the retired state. This supports correction of reinstatement transactions.

Only the procedure names and purposes are documented; parameter signatures are not part of the supplied metadata and should be confirmed against the package specification in the target environment before use.

Tables Accessed

The package reads and writes a broad set of Assets base tables through APPS synonyms. Key tables include FA_ADDITIONS_B, which holds the asset definition and descriptive information; FA_BOOKS and FA_BOOKS_SUMMARY, which store asset cost, depreciation, and book-level balances; and FA_BOOK_CONTROLS and FA_DEPRN_PERIODS, which govern period status and depreciation processing. Retirement and reinstatement activity is recorded in FA_ASSET_HISTORY and reflected in FA_ADJUSTMENTS. Supporting reference data includes FA_CATEGORY_BOOK_DEFAULTS, FA_CONVENTIONS, FA_DEPRN_BASIS_RULES, FA_DEPRN_RULE_DETAILS, FA_DEPRN_OVERRIDE, FA_CEILINGS, FA_CALENDAR_PERIODS, and FA_ASSET_INVOICES. Collectively these tables allow the package to validate the transaction, apply the correct depreciation rules, update balances, and maintain a complete audit trail.

Usage Notes

FA_RETIREMENT_PUB is normally invoked indirectly rather than from end-user code. In standard EBS usage it is called by the Assets forms and concurrent programs that process retirements, mass retirements, mass reinstatements, and transfers, and by Oracle Lease Management when an asset is disposed of or split. Custom extensions should call it only after initializing the FND global context (application, responsibility, and user) and after validating that the relevant depreciation period is open. Because the package performs the accounting and balance updates internally, callers should not attempt to duplicate those writes. Any modification should be tested through the standard retirement and reinstatement flows to confirm that asset history, book balances, and depreciation outcomes remain consistent.