My Oracle Support Banner

Oracle Assets Retirement Adjustment API Documentation Supplement (Doc ID 1433793.1)

Last updated on MARCH 17, 2020

Applies to:

Oracle Assets - Version 11.5.10.2 and later
Information in this document applies to any platform.

Purpose

Oracle Assets Retirement Adjustment API


You can use this API if you have a custom interface that makes it difficult to use with the existing interfaces in Oracle Assets. The Retirement Adjustment API allows you to enter the cost of removal and proceeds of sale directly to the group asset.

MRC

If you have set up Multiple Reporting Currencies (MRC), when you add or modify assets using an Oracle Assets API,  the API copies the transactions to all the reporting books for MRC automatically.
Invoice rounding issues are avoided by using the API to drive the accounting for both the primary and reporting currencies.

Scope

Retirement Adjustment API Description

The Retirement Adjustment API procedure is called: FA_RETIREMENT_ADJUSTMENT_PUB.DO_RETIREMENT_ADJUSTMENT().
The following table provides the arguments, types, value, and descriptions of the elements of the FA_RETIREMENT_ADJUSTMENT_PUB.DO_RETIREMENT_ADJUSTMENT() procedure.
Each argument has a prefix of P, X, or PX. These prefixes mean the following:

P - indicates an In argument
X - indicates an Out argument
PX - indicates an argument that is both In and Out

ArgumentTypeValueDescription
P_API_VERSION NUMBER Internal use only Version of the API in use.
P_INIT_MSG_LIST VARCHAR2(1) FND_API.G_TRUE -Initialize the message stack.
FND_API.G_FALSE - Do not initialize the message stack (Default).
Determines whether the messages stack should be initialized
and cleared.
P_COMMIT VARCHAR2(1) FND_API.G_TRUE -Commit
automatically.
FND_API.G_FALSE -Do not commit automatically (Default)
Commits the transaction.
P_VALIDATION_LEVEL NUMBER FND_API.G_VALID_LEVEL_NONE - Low level validation for a transaction.
FND_API.G_VALID_LEVEL_FULL - High level validation for a transaction (Default).
Asset validation by
the API.
P_CALLING_FN VARCHAR2(30)   Function calling the
API
X_RETURN_STATUS VARCHAR2(1) FND_API.G_RET_STS_ SUCCESS -
Indicates a success.
FND_API.G_RET_STS_ ERROR - Indicates a failed transaction.
FND_API.G_RET_STS_UNEXP_ERROR - Indicates an unexpected error.
Determines the API
success.
X_MSG_COUNT NUMBER   Number of messages
on the message stack.
X_MSG_DATA VARCHAR2(1024)   Message stack
PX_TRANS_REC FA_API_TYPES.
TRANS_REC_TYPE
  Describes the
transaction taking
place.
PX_ASSET_HDR_REC FA_API_TYPES.
ASSET_HDR_REC_TYPE
  Unique identifiers for
the assets.
P_COST_OF_REMOVAL NUMBER (Defaults to NULL)    
P_PROCEEDS NUMBER    
P_COST_OF_REMOVAL_CCID NUMBER (Defaults
to NULL)
   
P_PROCEEDS_CCID NUMBER (Defaults
to NULL)
   


TRANS_REC_TYPE Transaction Structure

The TRANS_REC_TYPE transaction structure contains information about the transaction, such as the transaction header ID and the transaction type code. The following table shows type and value information for each argument.

ArgumentRequired / OptionalTypeValue
WHO_INFO Required STANDARD_WHO_REC_TYPE Standard Who column
TRANSACTION_HEADER_ID Internal use only NUMBER(15) Optional OUT parameter
TRANSACTION_DATE_ENTERED Optional DATE Defaults to the date placed in service.Populate if you are performing a prior period retirement, else do nothing or set it to null.
TRANSACTION_NAME Optional VARCHAR2(20) Description of the transaction. This field
is the Comments field in the Asset Workbench.
MASS_REFERENCE_ID Optional NUMBER(15) Identifies the concurrent request that invokes the transaction if it is part
of a mass transaction.
AMORTIZATION_START_DATE Optional DATE Amortization start date.
CALLING_INTERFACE Optional VARCHAR2(30) Defaults to CUSTOM
DESC_FLEX Optional DESC_FLEX_ REC_TYPE Descriptive flexfield segments.


ASSET_HDR_REC_TYPE Asset Structure


The ASSET_HDR_REC_TYPE asset structure contains unique identification information for a given asset, such as the asset ID and book type code. The following table shows type and value information for each argument.

ArgumentRequired / OptionalTypeValue
ASSET_ID Required NUMBER(15) Asset identification number.
BOOK_TYPE_CODE Required VARCHAR2(15) Book name.

Details

To view full details, sign in with your My Oracle Support account.

Don't have a My Oracle Support account? Click to get started!


In this Document
Purpose
Scope
Details

My Oracle Support provides customers with access to over a million knowledge articles and a vibrant support community of peers and Oracle experts.