Skip to main content

📊 Asset Fields Data Dictionary

📋 Overview

This document provides a comprehensive data dictionary for Asset fields in the Asset Valuer Pro system. It maps technical field names to their business purpose, data types, validation rules, and usage examples.

📋 Core Identification Fields

Field NameData TypeBusiness PurposeRequiredDescriptionExample Value
IdIntegerUnique identifierYesSystem-generated primary key12345
NameStringDescriptive nameYesHuman-readable name of the asset"Main Administration Building"
ReferenceStringAsset identifierYesUnique reference code for the asset"BLDG-001"
CustomerReferenceStringClient referenceNoClient's internal reference code"FA-1234"
AssetClassIdInteger (FK)ClassificationYesLinks to asset classification5
AssetTypeIdInteger (FK)Type categorizationYesLinks to asset type12
AssetSubTypeIdInteger (FK)Detailed categorizationYesLinks to asset sub-type23

📋 Valuation Classification Fields

Field NameData TypeBusiness PurposeRequiredDescriptionExample Value
ValuationPolicyEnumValuation approachYesDefines how asset is valued"Above Revaluation Threshold"
ValuationTypeEnumValuation methodYesMethod used for valuation"Direct Cost"
ValuationClassIdInteger (FK)Disclosure classificationYesFor financial disclosures7
FinancialAssetClassIdInteger (FK)Financial reportingNoClassification for financial reports3
FinancialAssetSubClassIdInteger (FK)Financial sub-classNoSub-classification for financial reports8
IsControlledForFinancialPurposeBooleanControl statusYesWhether asset is controlled for financial reportingtrue

📋 Physical Attributes and Location

Field NameData TypeBusiness PurposeRequiredDescriptionExample Value
AddressComplex (Object)Location addressNoFull address detailsAddress object
FacilityStringFacility locationNoFacility name where asset is located"North Campus"
SubFacilityStringSub-facilityNoSub-facility location"Building C"
LatitudeDecimalGPS coordinatesNoGPS latitude for mapping-33.865143
LongitudeDecimalGPS coordinatesNoGPS longitude for mapping151.209900

📋 Temporal and Status Fields

Field NameData TypeBusiness PurposeRequiredDescriptionExample Value
AcquisitionDateDateTimeAcquisition dateNoWhen asset was acquired"2020-06-15"
DecommissionDateDateTimeRetirement dateNoWhen asset was/will be retired"2045-12-31"
IndexedFromDateDateTimeIndexation dateNoDate from which indexation is applied"2022-01-01"
StatusEnumInspection statusYesCurrent inspection status"Inspected"
InspectionDateDateTimeLast inspectionNoWhen asset was last inspected"2023-09-22"
InspectorNameStringInspectorNoName of inspector"John Smith"
AssetHistoryEnumAsset historyYesClassification of asset history"Found"

📋 Valuation Attributes

Field NameData TypeBusiness PurposeRequiredDescriptionExample Value
AssetAssumptionsIdInteger (FK)Valuation assumptionsYesLinks to valuation assumptions45
OptimisationAdjustmentPctDecimalOptimization factorNoAdjustment for optimization0.05 (5%)
ValuerStringValuation authorityNoPerson who performed valuation"Sarah Johnson"
IsHeritageAssetBooleanHeritage statusNoWhether asset has heritage statusfalse
IsHeldForSaleBooleanSale statusNoWhether asset is held for salefalse
IsInvestmentBooleanInvestment statusNoWhether asset is held for investmentfalse
IsHighestAndBestUseBooleanUsage statusNoWhether asset is at highest and best usetrue

📋 Financial Values

Field NameData TypeBusiness PurposeRequiredDescriptionExample Value
PreviousGrossDecimalPrevious valuationNoPrevious gross replacement cost450000.00
PreviousCurrentValueDecimalPrevious fair valueNoPrevious fair/current value350000.00
PreviousDepreciationExpenseDecimalPrevious depreciationNoPrevious depreciation expense15000.00
Field NameData TypeBusiness PurposeRequiredDescriptionExample Value
ComponentsCollectionComponent breakdownNoComponents comprising the assetList of Component objects
ReplacementCostsCollectionCost detailsNoReplacement cost breakdownList of AssetReplacementCost objects
ContentsCollectionAsset contentsNoContents within the assetList of Contents objects
NotesCollectionDocumentationNoNotes about the assetList of AssetNote objects
ImagesCollectionVisual documentationNoPhotos of the assetList of AssetImage objects
DocumentsCollectionDocument attachmentsNoDocuments related to the assetList of AssetDocument objects

📋 Specialized Valuation Objects

Field NameData TypeBusiness PurposeRequiredDescriptionExample Value
InsuranceComplex (Object)Insurance valuationNoInsurance-related valuation dataInsurance object
MarketApproachComplex (Object)Market valuationConditionalMarket approach valuation dataMarketApproach object
IncomeApproachComplex (Object)Income valuationConditionalIncome approach valuation dataIncomeApproach object
ValuationMethodComplex (Object)Valuation calculationsYesCalculated valuation resultsAssetValuationMethod object

📋 Custom and Error Fields

Field NameData TypeBusiness PurposeRequiredDescriptionExample Value
CustomFieldsDictionaryCustom attributesNoClient-specific custom fields{"ProjectCode": "P123"}
ErrorsDictionaryValidation errorsNoValidation errors for the asset{"Reference": "Duplicate reference"}
WarningsDictionaryValidation warningsNoValidation warnings for the asset{"DecommissionDate": "Date in past"}

📋 Relationships with Other Entities

Related EntityRelationship TypeDescriptionNavigation Property
AssetClassMany-to-OneAsset belongs to an asset classAssetClass
AssetTypeMany-to-OneAsset belongs to an asset typeAssetType
AssetSubTypeMany-to-OneAsset belongs to an asset sub-typeAssetSubType
ComponentOne-to-ManyAsset comprises multiple componentsComponents
AssetAssumptionsMany-to-OneAsset uses valuation assumptionsAssetAssumptions
ClientMany-to-OneAsset belongs to a clientClient
LeaseOne-to-ManyAsset may have multiple leasesLeases
ValuationClassMany-to-OneAsset has a valuation classificationValuationClass
MaintenancePlanOne-to-ManyAsset may have maintenance plansMaintenancePlans

📋 Business Rules and Validations

  1. Identity Rules

    • Reference must be unique within a client
    • Name should be descriptive and meaningful
  2. Classification Rules

    • Asset must have valid AssetClass, AssetType, and AssetSubType
    • ValuationType must be appropriate for the asset class
  3. Valuation Readiness Rules

    // Asset is ready for valuation when:
    AssetClassId is not null &&
    ValuationPolicy != ValuationPolicies.Undefined &&
    ValuationPolicy != ValuationPolicies.NotToBeValued &&
    IsControlledForFinancialPurpose &&
    AssetClass?.Job is not null &&
    AssetAssumptions is not null &&
    (DecommissionDate is null || DecommissionDate > AssetClass.Job.EffectiveDateOfValuation)
  4. Specialized Method Rules

    • Market approach valuation requires MarketApproach object
    • Income approach valuation requires IncomeApproach object

📋 Business Impact and Usage

Financial Reporting

Assets provide the foundation for financial reporting valuation, with their classification, status, and attributes directly impacting:

  • Gross replacement cost calculations
  • Current value (fair value) determination
  • Depreciation expense calculations
  • Financial statement disclosures

Asset Management

Asset data supports asset management through:

  • Condition assessment (Status field)
  • Location tracking (Address, Facility fields)
  • Lifespan management (AcquisitionDate, DecommissionDate)
  • Maintenance planning (MaintenancePlans collection)

Insurance Valuation

Insurance object contains data for insurance calculations:

  • Replacement cost determination
  • Escalation factors
  • Professional fees calculations
  • Debris removal estimates

📋 Data Collection Methods

Asset data is collected through multiple channels:

  1. Direct Entry: Web interface manual entry
  2. Bulk Import: CSV/Excel import of asset registers
  3. Field Data Collection: Mobile app capture of physical attributes and condition
  4. System Calculation: Valuation results generated by system

📋 Version Considerations

Version 2 vs. Version 3 Differences

  • Version 3 adds more comprehensive GPS location support
  • Version 3 enhances CustomFields capabilities
  • Version 3 improves validation with structured Errors and Warnings collections
  • Version 3 adds more comprehensive MaintenancePlans tracking