Search Results fa_retirement_pvt




Overview

FA_RETIREMENT_PVT is a private PL/SQL package in the APPS schema that encapsulates the core business logic for asset retirements and reinstatements in Oracle Assets (Oracle E-Business Suite 12.1.1 and 12.2.2). It is the internal implementation layer behind the public API FA_RETIREMENT_PUB and is classified as a PVT (private) API object, meaning it is not intended for direct invocation by external or customer code. The package handles the full retirement lifecycle: executing a retirement, generating the associated terminal gain or loss accounting, propagating the retirement into the corporate/general ledger (CGL) and multiple reporting currencies, undoing a retirement reinstatement, and allocating retirement cost across distribution lines. Because it is referenced by five peer packages — including FA_RETIREMENT_PUB, FA_GAINLOSS_RET_PKG, FA_GAINLOSS_UND_PKG, FA_GROUP_RECLASS2_PVT, and FA_PROCESS_GROUPS_PKG — it functions as the shared transactional engine for all retirement processing in the application.

Key Procedures and Functions

The package exposes eight documented procedures and functions, all oriented around retirement and reinstatement processing:

  • DO_RETIREMENT — Performs the primary retirement transaction, updating asset cost and book balances for the retired portion.
  • UNDO_RETIREMENT_REINSTATEMENT — Reverses a previously executed reinstatement, restoring the pre-reinstatement state.
  • DO_REINSTATEMENT — Reinstates a previously retired asset or retirement portion.
  • DO_RETIREMENT_IN_CGL — Posts and processes the retirement accounting in the corporate/general ledger context.
  • DO_REINSTATEMENT_IN_CGL — Posts the corresponding reinstatement accounting to the corporate/general ledger.
  • DO_TERMINAL_GAIN_LOSS — Calculates and records the terminal gain or loss arising from the retirement.
  • CHECK_TERMINAL_GAIN_LOSS — Evaluates whether a terminal gain or loss condition applies before recognition.
  • DO_ALLOCATION — Allocates retirement amounts across the distribution lines associated with the asset.

Together these procedures provide a complete, ordered framework: validate gain/loss, allocate, retire, post to CGL, and support reversal through reinstatement.

Tables Accessed

The package reads and writes a broad set of Oracle Assets base and summary tables through APPS synonyms. FA_ADDITIONS and FA_ADDITIONS_B hold the asset definition and descriptive attributes, while FA_BOOKS, FA_BOOKS_SUMMARY, and FA_BOOK_CONTROLS provide the book-level financial balances and control parameters against which retirements are applied. FA_ADJUSTMENTS and FA_MC_ADJUSTMENTS store the transactional adjustments, including multiple-currency entries, generated by the retirement. FA_DEPRN_PERIODS, FA_CALENDAR_TYPES, FA_DEPRN_BASIS_RULES, FA_DEPRN_RULE_DETAILS, and FA_CATEGORY_BOOKS supply the depreciation calendar, basis, and category-book rules needed to compute correct period and gain/loss treatment. FA_DISTRIBUTION_HISTORY and FA_DISTRIBUTION_HISTORY_S capture the distribution line detail used by DO_ALLOCATION, and FA_ASSET_HISTORY records the audit trail of the retirement and reinstatement actions.

Usage Notes

FA_RETIREMENT_PVT is an internal dependency and should not be called directly; external or custom integrations must use FA_RETIREMENT_PUB, which in turn delegates to this package. Typical invocation paths include the Oracle Assets retirement forms, the retirement and reinstatement concurrent programs, and the group processing and gain/loss packages listed in its dependency graph. Because it manipulates core financial tables and participates in ledger posting, any direct call risks bypassing validation, security context (FND_GLOBAL), and accounting integrity. Customers requiring custom retirement behavior should extend through the public API or documented extension points rather than invoking PVT procedures.