Oracle Assets Tax Reserve Adjustment API

This appendix covers the following topics:

Introduction

You can use this API if you have a custom interface that makes it difficult to use with the existing interfaces in Oracle Assets. You can use the Tax Reserve Adjustment API interfaces for adjusting attributes of a single asset. Oracle Assets also allows you to adjust assets using any of the following methods:

Alternate Ledger Currency

If you have set up alternate ledger currency , when you add or modify assets using an Oracle Assets API, the API copies the transactions to the reporting currencies automatically. Invoice rounding issues are avoided by using the API to drive the alternate ledger currency accounting for both the ledger and reporting currencies.

Related Topics

Tax Reserve Adjustment API Description

Sample Script: Using the Tax Reserve Adjustment API

Tax Reserve Adjustment API Description

The Tax Reserve Adjustment API procedure is called: FA_TAX_RSV_ADJ_PUB.DO_TAX_RSV_ADJ ().

The following table provides the arguments, types, value, and descriptions of the elements of the FA_TAX_RSV_ADJ_PUB.DO_TAX_RSV_ADJ () procedure.

Each argument has a prefix of P, X, or PX. These prefixes mean the following:

Argument Type Value Description
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.
X_RETURN_STATUS VARCHAR2(1) FND_API.G_RET_STS_ SUCCESS - Indicates a successful transaction.
FND_API.G_RET_STS_ ERROR - Indicates a failed transaction.
FND_API.G_RET_STS_ UNEXP_ERROR - Indicates an unexpected error.
Determines if the API is successful.
X_MSG_COUNT NUMBER   Number of messages on the message stack.
X_MSG_DATA VARCHAR2(1024)   Message stack.
P_CALLING_FN VARCHAR2(30)   Function calling the API
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_ASSET_TAX_RSV_ADJ_REC FA_API_TYPES.ASSET_TAX_RSV_ADJ_REC_TYPE    

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.

Argument Required / Optional Type Value
TRANSACTION_HEADER_ ID Internal use only NUMBER(15) Optional OUT parameter
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.
CALLING_INTERFACE Optional VARCHAR2(30) Defaults to CUSTOM
DESC_FLEX Optional DESC_FLEX_REC_TYPE Descriptive flexfield segments.
WHO_INFO Required STANDARD_WHO_REC_TYPE Standard Who column.

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.

Argument Required / Optional Type Value
ASSET_ID Required NUMBER(15) Asset identification number.
BOOK_TYPE_CODE Required VARCHAR2(15) Book name.

ASSET_TAX_RSV_ADJ_REC Adjustment Structure

The ASSET_TAX_RSV_ADJ_REC adjustment structure contains information for which an asset given asset, such as the asset ID and book type code. The following table shows type and value information for each argument.

Argument Required / Optional Type Value
FISCAL_YEAR Required NUMBER(4) Fiscal year for which reserve adjustment is required.
ADJUSTED_YTD_DEPRN Required Date Delta reserve amount for which adjustment is required.

Sample Script: Using the Tax Reserve Adjustment API

set serveroutput on size 999999    

declare

   l_TRANS_REC               FA_API_TYPES.TRANS_REC_TYPE;
   l_ASSET_HDR_REC           FA_API_TYPES.ASSET_HDR_REC_TYPE;
   l_ASSET_TAX_RSV_ADJ_REC   FA_API_TYPES.ASSET_TAX_RSV_ADJ_REC_TYPE;

   l_return_status           VARCHAR2(1);
   l_mesg_count              number;
   l_mesg                    varchar2(4000);

Begin

   dbms_output.enable(1000000);

   FA_SRVR_MSG.Init_Server_Message;

   l_TRANS_REC.TRANSACTION_TYPE_CODE          := 'TAX';
   l_TRANS_REC.TRANSACTION_DATE_ENTERED       := sysdate;
   l_ASSET_HDR_REC.ASSET_ID                   := &asset_id
   l_ASSET_HDR_REC.BOOK_TYPE_CODE             := '&book_type';
   l_ASSET_TAX_RSV_ADJ_REC.FISCAL_YEAR        := &fiscal_year
   l_ASSET_TAX_RSV_ADJ_REC.adjusted_ytd_deprn := &delta_reserve

   FA_TAX_RSV_ADJ_PUB.do_tax_rsv_adj(
           -- std parameters
           p_api_version           => 1.0,
           p_init_msg_list         => FND_API.G_FALSE,
           p_commit                => FND_API.G_FALSE,
           p_validation_level      => FND_API.G_VALID_LEVEL_FULL,
           p_calling_fn            => NULL,
           x_return_status         => l_return_status,
           x_msg_count             => l_mesg_count,
           x_msg_data              => l_mesg,
           -- api parameters
           PX_TRANS_REC            => l_TRANS_REC,
           PX_ASSET_HDR_REC        => l_ASSET_HDR_REC,
           P_ASSET_TAX_RSV_ADJ_REC => l_ASSET_TAX_RSV_ADJ_REC);


   --dump messages
   l_mesg_count := fnd_msg_pub.count_msg;

   if l_mesg_count > 0 then

      l_mesg := chr(10) || substr(fnd_msg_pub.get
                                    (fnd_msg_pub.G_FIRST, fnd_api.G_FALSE),
                                     1, 250);
      dbms_output.put_line(l_mesg);

      for i in 1..(l_mesg_count - 1) loop
         l_mesg :=
                     substr(fnd_msg_pub.get
                            (fnd_msg_pub.G_NEXT,
                             fnd_api.G_FALSE), 1, 250);

         dbms_output.put_line(l_mesg);
      end loop;

      fnd_msg_pub.delete_msg();

   end if;

   if (l_return_status <> FND_API.G_RET_STS_SUCCESS) then
     dbms_output.put_line('FAILURE');
   else
     dbms_output.put_line('SUCCESS');
     dbms_output.put_line('THID' ||
                          to_char(l_TRANS_REC.TRANSACTION_HEADER_ID));
   end if;

End;
/