Oracle Assets Additions API.docx

Oracle Assets Additions API.docx

《Oracle Assets Additions API.docx》由会员分享，可在线阅读，更多相关《Oracle Assets Additions API.docx（25页珍藏版）》请在冰豆网上搜索。

OracleAssetsAdditionsAPI

OracleAssetsAdditionsAPI

Subject:

OracleAssetsAdditionsAPIDocumentationSupplement,Jan2003

DocID:

206473.1

Type:

REFERENCE

ModifiedDate:

21-APR-2005

Status:

PUBLISHED

YoucanusetheAdditionsAPItoaddassetsdirectlyviaPL/SQLratherthanthroughthenormalOracleAssetsinterfaces.TheAdditionsAPIusestheFA_ADDITION_PUB.DO_ADDITIONprocedure.YoucanusethisAPIifyouhaveacustominterfacethatmakesitdifficulttousewiththeexistingassetadditionsinterfacesinOracleAssets.

OracleAssetsalsoallowsyoutoaddassetsusinganyofthefollowingmethods:

o    QuickAdditions:

YouusetheQuickAdditionsprocesstoquicklyenterordinaryassetswhenyoumustenterthemmanually.YoucanenterminimalinformationintheQuickAdditionswindow,andtheremainingassetinformationdefaultsfromtheassetcategory,book,andthedateplacedinservice.

o    DetailAdditions:

YouusetheDetailAdditionsprocesstomanuallyaddcomplexassetswhichtheQuickAdditionsprocessdoesnothandle,forexample,assetsthathaveasalvagevalueorassetswithmorethanoneassignments.

o    MassAdditions:

YouusetheMassAdditionsprocesstoaddassetsautomaticallyfromanexternalsource.CreateassetsfromoneormoreinvoicedistributionlinesinOraclePayables,CIPassetlinesinOracleProjects,assetinformationfromanotherassetssystem,orinformationfromanyotherfeedersystemusingtheinterface.

CIPAssets

IfyouhavecheckedtheAllowCIPAssetscheckboxontheBookControlswindowofataxbook,whenyouaddCIPassetsusingtheAdditionsAPI,theAPIautomaticallyaddsthoseCIPassetstothattaxbookatthesametimethattheyareaddedtothecorporatebook.

MRC

IfyouhavesetupMultipleReportingCurrencies（MRC）,whenyouaddassetsusingtheAdditionsAPI,theAPIautomaticallycopiestheassetstothereportingbooks.

PassingNullValues

YoumustpassspecialvaluesinordertonullthevaluesofBONUS_RULE,CEILING_NAME,orGROUP_ASSET_ID.IfyoupassaNULLvaluedirectlyforthesevalues,theAPIwillautomaticallydefaulttothevaluesetupforthecategory.ThetablebelowshowsthevaluethatmustbepassedforthefieldvaluetobeNULL.

Field

ValuetoPassforNULLField

BONUS_RULE

FND_API.G_MISS_CHAR

CEILING_NAME

FND_API.G_MISS_CHAR

GROUP_ASSET_ID

FND_API.G_MISS_NUM

SeeAlso

AdditionsAPIDescription

SampleScript:

UsingtheAdditionsAPIviaInvoices

SampleScript:

UsingtheAdditionsAPIwithNoInvoices

AdditionsAPIDescription

TheAdditionsAPIprocedureiscalled:

FA_ADDITION_PUB.DO_ADDITION（）.

Thefollowingtableprovidesthearguments,types,value,anddescriptionsoftheelementsoftheFA_ADDITION_PUB.DO_ADDITIONprocedure.

EachargumenthasaprefixofP,X,orPX.Theseprefixesmeanthefollowing:

o    P-indicatesanInargument

o    X-indicatesanOutargument

o    PX-indicatesanargumentthatisbothInandOut

Argument

Type

Value

Description

P_API_VERSION

NUMBER

Internaluseonly

VersionoftheAPIinuse.

P_INIT_MSG_LIST

VARCHAR2

（1）

FND_API.G_TRUE-Initializethemessagestack

FND_API.G_FALSE-Donotinitializethemessagestack（Default）

Determineswhetherthemessagesstackshouldbeinitializedandcleared.

P_COMMIT

VARCHAR2

（1）

FND_API.G_TRUE-Commitautomatically

FND_API.G_FALSE-Donotcommitautomatically（Default）

Flagonwhethertocommitassetafterprocessed.

P_VALIDATION_LEVEL

NUMBER

FND_API.G_VALID_

LEVEL_NONE-Lowestlevelofvalidationpossibleforatransaction

FND_API.G_VALID_

LEVEL_FULL-Highestlevelofvalidationpossibleforatransaction（Default）

CheckonwhethertheAPIshoulddothevalidationfortheasset.

X_RETURN_STATUS

VARCHAR2

（1）

FND_API.G_RET_STS_SUCCESS-Additionwasasuccess

FND_API.G_RET_STS_ERROR-AdditionfailedFND_API.G_RET_STS_UNEXP_ERROR-Unexpectederror

DetermineswhetherornottheAPIcompletedsuccessfully.

X_MSG_COUNT

NUMBER

Numberofmessagesonthemessagestack.

X_MSG_DATA

VARCHAR2（1024）

Messagestack.

P_CALLING_FN

VARCHAR2（30）

FunctioncallingtheAPI

PX_TRANS_REC

FA_API_TYPES.

TRANS_REC_TYPE

Describesthetransactiontakingplace.

PX_DIST_TRANS_REC

FA_API_TYPES.

DIST_TRANS_REC_TYPE

Describesthedistributionofthetransaction.

PX_ASSET_HDR_REC

FA_API_TYPES.

ASSET_HDR_REC_TYPE

Uniqueidentifiersoftheassetbeingadded.

PX_ASSET_DESC_REC

FA_API_TYPES.

ASSET_DESC_REC_TYPE

Descriptionoftheasset.

PX_ASSET_TYPE_REC

FA_API_TYPES.

ASSET_TYPE_REC_TYPE

Assettypeoftheasset.

PX_ASSET_CAT_REC

FA_API_TYPES.

ASSET_CAT_REC_TYPE

Categoryinformationoftheasset.

PX_ASSET_HIERARCHY_REC

FA_API_TYPES.

ASSET_HIERARCHY_REC_TYPE

Hierarchyinformationoftheasset.

PX_ASSET_FIN_REC

FA_API_TYPES.

ASSET_FIN_REC_TYPE

Financialinformationoftheasset.

PX_ASSET_DEPRN_REC

FA_API_TYPES.

ASSET_DEPRN_

REC_TYPE

Depreciationinformationoftheasset.

PX_ASSET_DIST_TBL

FA_API_TYPES.

ASSET_DIST_TBL_

TYPE

Distributioninformationoftheasset.

PX_INV_TBL

FA_API_TYPES.

INV_TBL_TYPE

Invoicesfortheasset.

PX_INV_RATE_TBL

FA_API_TYPES.

INV_RATE_TBL_

TYPE

TableofratesfortheinvoicesfortheassetforMRC.

Table1-1.（Page2of2）

TRANS_REC_TYPETransactionStructure

TheTRANS_REC_TYPEtransactionstructurecontainsinformationaboutthetransaction,suchasthetransactionheaderIDandthetransactiontypecode.Thefollowingtableshowstypeandvalueinformationforeachargument.

Argument

Required/Optional

Type

Value

TRANSACTION_HEADER_

ID

Internaluseonly

NUMBER（15）

OptionalOUTparameter

TRANSACTION_DATE_

ENTERED

Optional

DATE

Mustbethesameasthedateplacedinservice,whichitdefaultsto.

TRANSACTION_NAME

Optional

VARCHAR2（20）

Descriptionofthetransaction.

MASS_REFERENCE_ID

Optional

NUMBER（15）

Identifiesconcurrentrequestthatinvokedthemasstransaction.

TRANSACTION_SUBTYPE

Optional

VARCHAR2（9）

AMORTIZED-AmortizeNBVaddition

NULL-Regularaddition

AMORTIZATION_START_

DATE

Optional

DATE

Amortizationstartdate

CALLING_INTERFACE

Optional

VARCHAR2（30）

DefaultstoCUSTOM

DESC_FLEX

Optional

DESC_FLEX_

REC

Descriptiveflexfieldsegment

WHO_INFO

Required

STANDARD_

WHO_REC

StandardWhocolumns

ASSET_HDR_REC_TYPEAssetStructure

TheASSET_HDR_REC_TYPEassetstructurecontainsuniqueidentificationinformationforagivenasset,suchastheassetIDandbooktypecode.Thefollowingtableshowstypeandvalueinformationforeachargument.

Argument

Required/Optional

Type

Value

ASSET_ID

InternaluseonlyforadditiontoCorporatebook.RequiredforadditiontotaxbookforassetalreadyexistinginCorporatebook.

Forataxaddition,onlytheTRANS_REC_TYPEandtheASSET_HDR_REC_TYPEattributesareneeded.ThevaluesintheotherstructuressuchasASSET_DESC_REC_TYPE,ASSET_FIN_REC_TYPE,ASSET_TYPE_REC_TYPE,ASSET_CAT_REC_TYPE,etc,willdefaultformthevaluesoftheCorporatebook,

NUMBER（15）

OptionalOUTparameter

BOOK_TYPE_CODE

Required

VARCHAR2（15）

Bookname

ASSET_DESC_REC_TYPEAssetStructure

TheASSET_DESC_REC_TYPEassetstructurecontainsdescriptiveinformationabouttheasset,suchasthetagnumber,serialnumber,andmanufacturername.Thefollowingtableshowstypeandvalueinformationforeachargument.

Argument

Required/Optional

Type

Value

ASSET_NUMBER

Optional

VARCHAR2（15）

Defaultstoasset_id.OptionalOUTparameter.

DESCRIPTION

Required

VARCHAR2（80）

Descriptionoftheasset.

TAG_NUMBER

Optional

VARCHAR2（15）

Tagnumberoftheasset.

SERIAL_NUMBER

Optional

VARCHAR2（35）

Serialnumberoftheasset.

ASSET_KEY_CCID

Optional

NUMBER（15）

Identifiesanassetkey 

flexfieldcombinationfortheasset.

PARENT_ASSET_ID

Optional

NUMBER（15）

Identifiesaparentassetforsubcomponents.

STATUS

Optional

VARCHAR2（150）

Describesthestatusoftheasset.（CRLAssetsonly）

MANUFACTURER_NAME

Optional

VARCHAR2（30）

Nameofthemanufacturer.

MODEL_NUMBER

Optional

VARCHAR2（40）

Modelnumberoftheasset.

WARRANTY_ID

Optional

NUMBER（15）

Warrantyidentificationnumber.

LEASE_ID

Optional

NUMBER（15）

Leaseidentificationnumber.

IN_USE_FLAG

Optional

VARCHAR2（3）

Indicateswhethertheassetisinuse. 

YES-Inuse（default）

NO-Notinuse

INVENTORIAL

Optional

VARCHAR2（3）

YES-Includeinphysicalinventory

NO-Donotincludeinphysicalinventory

Defaultstovalueincategory

PROPERTY_TYPE_CODE

Optional

VARCHAR2（10）

Indicatesthepropertytype.Defaultstovalueincategory

PROPERTY_1245_1250_

CODE

Optional

VARCHAR2（4）

1245-Personal

1250-Real

Defaultstovalueincategory

OWNED_LEASED

Optional

VARCHAR2（15）

OWNED-Owned（Default）

LEASED-Leased

Defaultstovalueincategory

NEW_USED

Optional

VARCHAR2（4）

NEW-New（Default）

USED-Used

CURRENT_UNITS

Required

NUMBER

Currentnumberofunitsfortheasset.

LEASE_DESC_FLEX

Optional

DESC_FLEX_

REC_TYPE

Leasedescriptiveflexfieldsegments.

GLOBAL_DESC_FLEX

Optional

DESC_FLEX_

REC_TYPE

Globaldescriptiveflexfieldsegments.

Table1-2.（Page2of2）

ASSET_TYPE_REC_TYPEAssetStructure

TheASSET_TYPE_REC_TYPEassetstructurecontainsinformationabouttheassettype:

CIP,capitalized,orexpensed.Thefollowingtableshowstypeandvalueinformationforeachargument.

Argument

Required/Optional

Type

Value

ASSET_TYPE

Required

VARCHAR2（15）

CAPITALIZED-Capitalizedasset（default）

CIP-CIPasset

EXPENSED-Expensedasset

ASSET_CAT_REC_TYPEAssetStructure

TheASSET_CAT_REC_TYPEassetstructurecontainsinformationabouttheassetcategory,suchasthecategoryIDandthecategorydescriptiveflexfield.Thefollowingtableshowstypeandvalue