Oracle Assets Additions API
|
Subject: |
Oracle Assets Additions API Documentation Supplement, Jan 2003 | |||
|
|
Doc ID: |
206473.1 |
Type: |
REFERENCE |
|
|
Modified Date : |
21-APR-2005 |
Status: |
PUBLISHED |
You can use the Additions API to add assets directly via PL/SQL rather than through the normal Oracle Assets interfaces. The Additions API uses the FA_ADDITION_PUB.DO_ADDITION procedure. You can use this API if you have a custom interface that makes it difficult to use with the existing asset additions interfaces in Oracle Assets.
Oracle Assets also allows you to add assets using any of the following methods:
o QuickAdditions: You use the QuickAdditions process to quickly enter ordinary assets when you must enter them manually. You can enter minimal information in the QuickAdditions window, and the remaining asset information defaults from the asset category, book, and the date placed in service.
o Detail Additions: You use the Detail Additions process to manuallyadd complex assets which the QuickAdditions process does not handle, for example, assets that have a salvage value or assets with more than one assignments.
o Mass Additions: You use the Mass Additions process to add assets automatically from an external source. Create assets from one or more invoice distribution lines in Oracle Payables, CIP asset lines in Oracle Projects, asset information from another assets system, or information from any other feeder system using the interface.
CIP Assets
If you have checked the Allow CIP Assets check box on the Book Controls window of a tax book, when you add CIP assets using the Additions API, the API automatically adds those CIP assets to that tax book at the same time that they are added to the corporate book.
MRC
If you have set up Multiple Reporting Currencies (MRC), when you add assets using the Additions API, the API automatically copies the assets to the reporting books.
Passing Null Values
You must pass special values in order to null the values of BONUS_RULE, CEILING_NAME, or GROUP_ASSET_ID. If you pass a NULL value directly for these values, the API will automatically default to the value setup for the category. The table below shows the value that must be passed for the field value to be NULL.
|
Field |
Value to Pass for NULL Field |
|
BONUS_RULE |
FND_API.G_MISS_CHAR |
|
CEILING_NAME |
FND_API.G_MISS_CHAR |
|
GROUP_ASSET_ID |
FND_API.G_MISS_NUM |
See Also
Sample Script: Using the Additions API via Invoices
Sample Script: Using the Additions API with No Invoices
The Additions API procedure is called: FA_ADDITION_PUB.DO_ADDITION ().
The following table provides the arguments, types, value, and descriptions of the elements of the FA_ADDITION_PUB.DO_ADDITION procedure.
Each argument has a prefix of P, X, or PX. These prefixes mean the following:
o P - indicates an In argument
o X - indicates an Out argument
o PX - indicates an argument that is both In and Out
|
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) |
Flag on whether to commit asset after processed. |
|
P_VALIDATION_LEVEL |
NUMBER |
FND_API.G_VALID_ LEVEL_NONE - Lowest level of validation possible for a transaction FND_API.G_VALID_ LEVEL_FULL - Highest level of validation possible for a transaction (Default) |
Check on whether the API should do the validation for the asset. |
|
X_RETURN_STATUS |
VARCHAR2(1) |
FND_API.G_RET_STS_ SUCCESS - Addition was a success FND_API.G_RET_STS_ ERROR - Addition failed FND_API.G_RET_STS_ UNEXP_ERROR - Unexpected error |
Determines whether or not the API completed successfully. |
|
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_DIST_TRANS_REC |
FA_API_TYPES. DIST_TRANS_REC_ TYPE |
|
Describes the distribution of the transaction. |
|
PX_ASSET_HDR_REC |
FA_API_TYPES. ASSET_HDR_REC_ TYPE |
|
Unique identifiers of the asset being added. |
|
PX_ASSET_DESC_REC |
FA_API_TYPES. ASSET_DESC_REC_ TYPE |
|
Description of the asset. |
|
PX_ASSET_TYPE_REC |
FA_API_TYPES. ASSET_TYPE_REC_ TYPE |
|
Asset type of the asset. |
|
PX_ASSET_CAT_REC |
FA_API_TYPES. ASSET_CAT_REC_ TYPE |
|
Category information of the asset. |
|
PX_ASSET_HIERARCHY_REC |
FA_API_TYPES. ASSET_HIERARCHY_REC_TYPE |
|
Hierarchy information of the asset. |
|
PX_ASSET_FIN_REC |
FA_API_TYPES. ASSET_FIN_REC_ TYPE |
|
Financial information of the asset. |
|
PX_ASSET_DEPRN_REC |
FA_API_TYPES. ASSET_DEPRN_ REC_TYPE |
|
Depreciation information of the asset. |
|
PX_ASSET_DIST_TBL |
FA_API_TYPES. ASSET_DIST_TBL_ TYPE |
|
Distribution information of the asset. |
|
PX_INV_TBL |
FA_API_TYPES. INV_TBL_TYPE |
|
Invoices for the asset. |
|
PX_INV_RATE_TBL |
FA_API_TYPES. INV_RATE_TBL_ TYPE |
|
Table of rates for the invoices for the asset for MRC. |
|
Table 1 - 1. (Page 2 of 2) | |||
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_DATE_ ENTERED |
Optional |
DATE |
Must be the same as the date placed in service, which it defaults to. |
|
TRANSACTION_NAME |
Optional |
VARCHAR2(20) |
Description of the transaction. |
|
MASS_REFERENCE_ID |
Optional |
NUMBER(15) |
Identifies concurrent request that invoked the mass transaction. |
|
TRANSACTION_SUBTYPE |
Optional |
VARCHAR2(9) |
AMORTIZED - Amortize NBV addition NULL - Regular addition |
|
AMORTIZATION_START_ DATE |
Optional |
DATE |
Amortization start date |
|
CALLING_INTERFACE |
Optional |
VARCHAR2(30) |
Defaults to CUSTOM |
|
DESC_FLEX |
Optional |
DESC_FLEX_ REC |
Descriptive flexfield segment |
|
WHO_INFO |
Required |
STANDARD_ WHO_REC |
Standard Who columns |
|
| |||
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 |
Internal use only for addition to Corporate book. Required for addition to tax book for asset already existing in Corporate book. For a tax addition, only the TRANS_REC_TYPE and the ASSET_HDR_REC_TYPE attributes are needed. The values in the other structures such as ASSET_DESC_REC_TYPE, ASSET_FIN_REC_TYPE, ASSET_TYPE_REC_TYPE, ASSET_CAT_REC_TYPE, etc, will default form the values of the Corporate book, |
NUMBER(15) |
Optional OUT parameter |
|
BOOK_TYPE_CODE |
Required |
VARCHAR2(15) |
Book name |
|
| |||
ASSET_DESC_REC_TYPE Asset Structure
The ASSET_DESC_REC_TYPE asset structure contains descriptive information about the asset, such as the tag number, serial number, and manufacturer name. The following table shows type and value information for each argument.
|
Argument |
Required / Optional |
Type |
Value |
|
ASSET_NUMBER |
Optional |
VARCHAR2(15) |
Defaults to asset_id. Optional OUT parameter. |
|
DESCRIPTION |
Required |
VARCHAR2(80) |
Description of the asset. |
|
TAG_NUMBER |
Optional |
VARCHAR2(15) |
Tag number of the asset. |
|
SERIAL_NUMBER |
Optional |
VARCHAR2(35) |
Serial number of the asset. |
|
ASSET_KEY_CCID |
Optional |
NUMBER(15) |
Identifies an asset key flexfield combination for the asset. |
|
PARENT_ASSET_ID |
Optional |
NUMBER(15) |
Identifies a parent asset for subcomponents. |
|
STATUS |
Optional |
VARCHAR2(150) |
Describes the status of the asset. (CRL Assets only) |
|
MANUFACTURER_NAME |
Optional |
VARCHAR2(30) |
Name of the manufacturer. |
|
MODEL_NUMBER |
Optional |
VARCHAR2(40) |
Model number of the asset. |
|
WARRANTY_ID |
Optional |
NUMBER(15) |
Warranty identification number. |
|
LEASE_ID |
Optional |
NUMBER(15) |
Lease identification number. |
|
IN_USE_FLAG |
Optional |
VARCHAR2(3) |
Indicates whether the asset is in use. YES - In use (default) NO - Not in use |
|
INVENTORIAL |
Optional |
VARCHAR2(3) |
YES - Include in physical inventory NO - Do not include in physical inventory Defaults to value in category |
|
PROPERTY_TYPE_CODE |
Optional |
VARCHAR2(10) |
Indicates the property type. Defaults to value in category |
|
PROPERTY_1245_1250_ CODE |
Optional |
VARCHAR2(4) |
1245 - Personal 1250 - Real Defaults to value in category |
|
OWNED_LEASED |
Optional |
VARCHAR2(15) |
OWNED - Owned (Default) LEASED - Leased Defaults to value in category |
|
NEW_USED |
Optional |
VARCHAR2(4) |
NEW - New (Default) USED - Used |
|
CURRENT_UNITS |
Required |
NUMBER |
Current number of units for the asset. |
|
LEASE_DESC_FLEX |
Optional |
DESC_FLEX_ REC_TYPE |
Lease descriptive flexfield segments. |
|
GLOBAL_DESC_FLEX |
Optional |
DESC_FLEX_ REC_TYPE |
Global descriptive flexfield segments. |
|
Table 1 - 2. (Page 2 of 2) | |||
ASSET_TYPE_REC_TYPE Asset Structure
The ASSET_TYPE_REC_TYPE asset structure contains information about the asset type: CIP, capitalized, or expensed. The following table shows type and value information for each argument.
|
Argument |
Required / Optional |
Type |
Value |
|
ASSET_TYPE |
Required |
VARCHAR2(15) |
CAPITALIZED - Capitalized asset (default) CIP - CIP asset EXPENSED - Expensed asset |
|
| |||
ASSET_CAT_REC_TYPE Asset Structure
The ASSET_CAT_REC_TYPE asset structure contains information about the asset category, such as the category ID and the category descriptive flexfield. The following table shows type and value information for each argument.
|
Argument |
Required / Optional |
Type |
Value |
|
CATEGORY_ID |
Required |
NUMBER(15) |
Identifies whether the asset is CIP, Capitalized, or Expensed. |
|
CATEGORY_DESC_FLEX |
Optional |
DESC_FLEX_ REC_TYPE |
Category descriptive flexfield segments. |
|
Table 1 - 3. (Page 1 of 1) | |||
ASSET_HIERARCHY_REC_TYPE Asset Structure
The ASSET_HIERARCHY_REC_TYPE asset structure contains information about whether the asset belongs to an asset hierarchy. This asset structure applies only to CRL Assets. The following table shows type and value information for each argument.
|
Argument |
Required / Optional |
Type |
Value |
|
PARENT_HIERARCHY_ID |
Optional |
NUMBER(15) |
Identifies the hierarchy to which the asset belongs. (CRL assets) |
|
Table 1 - 4. (Page 1 of 1) | |||
ASSET_FIN_REC_TYPE Asset Structure
The ASSET_FIN_REC_TYPE asset structure contains financial information for a given asset. The following table shows type and value information for each argument.
|
Argument |
Required / Optional |
Type |
Value |
|
DATE_PLACED_IN_ SERVICE |
Required (if no invoices were populated) |
DATE |
Date the asset was placed in service. |
|
DEPRN_METHOD_CODE |
Optional |
VARCHAR2(12) |
The name of the depreciation menthod. Defaults to value in category |
|
LIFE_IN_MONTHS |
Optional |
NUMBER(4) |
Life of the asset in total months. Defaults to value in category |
|
COST |
Required (if no invoices were populated) |
NUMBER |
Current cost of the asset. |
|
ORIGINAL_COST |
Optional |
NUMBER |
Original cost of the asset. Defaults to cost. |
|
SALVAGE_VALUE |
Optional |
NUMBER |
Asset salvage value. Defaults to value in category |
|
PRORATE_CONVENTION_ CODE |
Optional |
VARCHAR2(10) |
Depreciation prorate convention. Defaults to value in category |
|
DEPRECIATE_FLAG |
Required |
VARCHAR2(3) |
Indicates whether the asset is depreciating. YES - Asset is depreciating NO - Asset is not depreciating |
|
ITC_AMOUNT_ID |
Optional |
NUMBER(15) |
Identifies the ITC rate. |
|
BASIC_RATE |
Optional |
NUMBER |
Defaults to value in category |
|
ADJUSTED_RATE |
Optional |
NUMBER |
Defaults to value in category |
|
BONUS_RULE |
Optional |
NUMBER |
Bonus rule for an asset. Defaults to value in category. If a defualt value is defined, and you want the value to be NULL, you must pass FND_API.G_MISS_CHAR to the Addition API. |
|
CEILING_NAME |
Optional |
VARCHAR2(30) |
Identifies a deprecation ceiling to be used in calculating deprecation. Defaults to value in category. If a defualt value is defined, and you want the value to be NULL, you must pass FND_API.G_MISS_CHAR to the Addition API. |
|
PRODUCTION_CAPACITY |
Optional |
NUMBER |
Capacity of a units of production asset. Defaults to value in category |
|
UNIT_OF_MEASURE |
Optional |
VARCHAR2(25) |
Unit of measure of a units of production asset. Defaults to value in category. |
|
REVAL_CEILING |
Optional |
NUMBER |
Upper limit for revaluing asset cost. |
|
UNREVALUED_COST |
Optional |
NUMBER |
Cost without regard to any revaluation. |
|
SHORT_FISCAL_YEAR_ FLAG |
Optional |
VARCHAR2(3) |
YES - Asset is in a short fiscal year NO - Asset is not in a short fiscal year |
|
CONVERSION_DATE |
Optional |
DATE |
Date short tax year asset added to the acquiring company. |
|
ORIG_DEPRN_START_DATE |
Optional |
DATE |
Date short tax year asset begin depreciating in the acquired company's books. |
|
GROUP_ASSET_ID |
Optional |
NUMBER(15) |
Group asset identification number. (CRL Asset). If a defualt value is defined, and you want the value to be NULL, you must pass FND_API.G_MISS_NUM to the Addition API. |
|
GLOBAL_ATTRIBUTE1-20 |
Optional |
VARCHAR2(150) |
Reserved for country specific functionality. |
|
GLOBAL_ATTRIBUTE_ CATEGORY |
Optional |
VARCHAR2(30) |
Reserved for country specific functionality. |
|
Table 1 - 5. (Page 3 of 3) | |||
ASSET_DEPRN_REC_TYPE Asset Structure
The ASSET_DEPRN_REC_TYPE asset structure contains depreciation information for a given asset. The following table shows type and value information for each argument.
|
Argument |
Required / Optional |
Type |
Value |
|
YTD_DEPRN |
Optional |
NUMBER |
Year-to-date depreciation expense. |
|
DEPRN_RESERVE |
Optional |
NUMBER |
Total depreciation taken since the beginning of the asset's life. |
|
REVAL_DEPRN_RESERVE |
Optional |
NUMBER |
For a period in which this asset was revalued: The value is the change in net book value due to revaluation of asset cost, and sometimes also the revaluation of depreciation reserve. For all other periods: The value is the revaluation reserve amount after depreciation is run. |
|
Table 1 - 6. (Page 1 of 1) | |||
ASSET_DIST_REC_TYPE Asset Structure
The ASSET_DIST_REC_TYPE asset structure contains information that represents a single source or destination distribution line. All the ASSET_DIST_REC_TYPE records comprising a single transfer transaction are contained in the ASSET_DIST_TBL_TYPE table. At least one source line and at least one destination line are required for each transfer transaction. The following table shows type and value information for each argument.
|
Argument |
Required / Optional |
Type |
Value |
|
UNITS_ASSIGNED |
Required |
NUMBER |
Number of units assigned to the distribution. |
|
ASSIGNED_TO |
Optional |
NUMBER(15) |
Employee identification number. |
|
EXPENSE_CCID |
Required |
NUMBER(15) |
Depreciation expense account identification number. |
|
LOCATION_CCID |
Required |
NUMBER(15) |
Location flexfield identification number. |
|
Table 1 - 7. (Page 1 of 1) | |||
INV_REC_TYPE Invoice Structure
The INV_REC_TYPE invoice structure contains invoice information for a single invoice associated with an asset. The INV_TBL_TYPE is a table of INV_REC_TYPE records. These records contain all invoices that have been applied to the asset. The following table shows type and value information for each argument.
|
Argument |
Required / Optional |
Type |
Value |
|
FIXED_ASSETS_COST |
Required (only when the record is populated) |
NUMBER |
Cost of asset in Oracle Assets. |
|
PO_VENDOR_ID |
Optional |
NUMBER(15) |
Supplier identification number. |
|
PO_NUMBER |
Optional |
VARCHAR2(20) |
Purchase order number. |
|
INVOICE_NUMBER |
Optional |
VARCHAR2(50) |
Invoice number. |
|
PAYABLES_BATCH_NAME |
Optional |
VARCHAR2(50) |
Name of the payables batch that contained this invoice. |
|
PAYABLES_CODE_ COMBINATION_ID |
Optional |
NUMBER(15) |
Clearing account number to which this line was posted in accounts payable. |
|
FEEDER_SYSTEM_NAME |
Optional |
VARCHAR2(40) |
Name of the feeder system that created the FA_MASS_ADDITIONS row. |
|
CREATE_BATCH_DATE |
Optional |
DATE |
Date the mass additions batch was created for this row. |
|
CREATE_BATCH_ID |
Optional |
NUMBER(15) |
Mass additions create request identification number for this row. |
|
INVOICE_DATE |
Optional |
DATE |
Invoice date from accounts payable. |
|
PAYABLES_COST |
Optional |
NUMBER |
Invoice cost from accounts payable. |
|
POST_BATCH_ID |
Optional |
NUMBER(15) |
Mass Additions Post request identification number for this row. |
|
INVOICE_ID |
Optional |
NUMBER(15) |
Invoice identification number. |
|
AP_DISTRIBUTION_LINE_ NUMBER |
Optional |
NUMBER(15) |
Distribution line identification number. |
|
PAYABLES_UNITS |
Optional |
NUMBER |
Units from AP_INVOICE_ DISTRIBUTIONS row. |
|
DESCRIPTION |
Optional |
VARCHAR2(80) |
Invoice line description. |
|
DELETED_FLAG |
Optional |
VARCHAR2(3) |
Indicates whether this row has been deleted in the CIP Adjustments form. Defaults to NO, which it should be for all addition transactions. |
|
PROJECT_ASSET_LINE_ID |
Optional |
NUMBER(15) |
Identifier of the summarized asst cost line transferred from Oracle Projects to create this line. |
|
PROJECT_ID |
Optional |
NUMBER(15) |
Identifier of the project from which the costs are collected, summarized, and transferred from Oracle Projects. |
|
TASK_ID |
Optional |
NUMBER(15) |
Identifier of the task from which costs are collected, summarized, and transferred from Oracle Projects. This column is populated only if the costs were summarized by task. |
|
ATTRIBUTE1 |
Optional |
VARCHAR2(150) |
Descriptive flexfield segment. |
|
ATTRIBUTE2 |
Optional |
VARCHAR2(150) |
Descriptive flexfield segment. |
|
ATTRIBUTE3 |
Optional |
VARCHAR2(150) |
Descriptive flexfield segment. |
|
ATTRIBUTE4 |
Optional |
VARCHAR2(150) |
Descriptive flexfield segment. |
|
ATTRIBUTE5 |
Optional |
VARCHAR2(150) |
Descriptive flexfield segment. |
|
ATTRIBUTE6 |
Optional |
VARCHAR2(150) |
Descriptive flexfield segment. |
|
ATTRIBUTE7 |
Optional |
VARCHAR2(150) |
Descriptive flexfield segment. |
|
ATTRIBUTE8 |
Optional |
VARCHAR2(150) |
Descriptive flexfield segment. |
|
ATTRIBUTE9 |
Optional |
VARCHAR2(150) |
Descriptive flexfield segment. |
|
ATTRIBUTE10 |
Optional |
VARCHAR2(150) |
Descriptive flexfield segment. |
|
ATTRIBUTE11 |
Optional |
VARCHAR2(150) |
Descriptive flexfield segment. |
|
ATTRIBUTE12 |
Optional |
VARCHAR2(150) |
Descriptive flexfield segment. |
|
ATTRIBUTE13 |
Optional |
VARCHAR2(150) |
Descriptive flexfield segment. |
|
ATTRIBUTE14 |
Optional |
VARCHAR2(150) |
Descriptive flexfield segment. |
|
ATTRIBUTE15 |
Optional |
VARCHAR2(150) |
Descriptive flexfield segment. |
|
ATTRIBUTE_CATEGORY_ CODE |
Optional |
VARCHAR2(30) |
Descriptive flexfield structure defining column. |
|
INV_INDICATOR |
Required (only when this record is populated and using MRC and INV_RATE_REC) |
NUMBER |
Join to INV_RATE_REC. YTD_DEPRN NUMBER Year-to-date deprecation expense. |
|
YTD_DEPRN |
Optional |
NUMBER |
Year-to-date deprecation expense. |
|
DEPRN_RESERVE |
Optional |
NUMBER |
Total deprecation taken since beginning of asset life. |
|
BONUS_YTD_DEPRN |
Optional |
NUMBER |
Bonus year-to-date depreciation expense. |
|
BONUS_DEPRN_RESERVE |
Optional |
NUMBER |
Total bonus depreciation taken since beginning of asset life. |
|
REVAL_AMORTIZATION_ BASIS |
Optional |
NUMBER |
Revaluation reserve used in calculating amortization of revaluation reserve. Value is updated only when the asset is revalued or has an amortized adjustment. |
|
REVAL_YTD_DEPRN |
Optional |
NUMBER |
Year-to-date deprecation expense due to revaluation. |
|
REVAL_DEPRN_RESERVE |
Optional |
NUMBER |
For a period in which this asset was revalued: Change in net book value due to revaluation of asset cost and sometimes also revaluation of depreciation reserve. For all other periods: Revaluation reserve amount after depreciation run. |
|
Table 1 - 8. (Page 4 of 4) | |||
INV_RATE_REC_TYPE Invoice Structure
The INV_RATE_REC_TYPE invoice structure contains rate information for an invoice. Each INV_RATE_REC_TYPE record contains one conversion rate. The INV_RATE_TBL_TYPE is a table of INV_RATE_REC_TYPE records. This table is used by MRC reporting books to determine the conversion rates for an asset. The following table shows type and value information for each argument.
|
Argument |
Required / Optional |
Type |
Value |
|
INV_INDICATOR |
Optional - When using MRC, this value and record should generally be populated. If it is not populated, the daily rate is derived based on the transaction date. |
NUMBER |
Join to INV_REC. |
|
SET_OF_BOOKS_ID |
Required - Required when using MRC, and only needed when the record is populated. |
NUMBER(15) |
Set of books identification number for GL set of books. |
|
EXCHANGE_RATE |
Required - Required when using MRC, and only needed when the record is populated. |
NUMBER |
Exchange rate for the currency. |
|
Table 1 - 9. (Page 1 of 1) | |||
成长
/ | \
学习 总结 分享
QQ交流群：122230156
