Xero Assets Endpoint: GetAsset
Jump to navigation
Jump to search
Overview
The Xero GetAsset endpoint provides all the fields for a single asset specified using it's id.
It is a function that accepts a series of parameters.
This endpoint only provides three additional fields over the Assets endpoint.
It also provides data in a similar format to the AssetsExpanded function.
Parameters
The GetAssetis a function that accepts the following parameters.
- assetId
- A guid field that determines the asset for which to retrieve data.
- This field is mandatory.
Fields
The following fields are available for the AssetsTypes endpoint.
- DataFile
- A record field that provides the DataFile associated with the asset type.
- assetId
- A guid field that provides the id of the asset.
- assetNumber
- A text field that provides the number of the asset.
- assetName
- A text field that provides the name of the asset.
- assetTypeId
- A guid field that provides the id of the asset type.
- This field links with the AssetsTypes endpoint.
- assetStatus
- A text field that provides the status of the asset.
- Possible values are:
- DRAFT
- REGISTERED
- DISPOSED
- purchaseDate
- A date field that provides the date the asset was purchased.
- purchasePrice
- A decimal field that provides the price at which the asset was purchased.
- disposalPrice
- A decimal field that provides the price at which the asset was disposed, if applicable.
- accountingBookValue
- A decimal field that provides the asset's acconting book value as of now.
- taxValues
- A table field that provides tax values of the asset as of now.
- See taxValues Fields for more information.
- serialNumber
- A text field that provides the serial number of the asset.
- warrantyExpiryDate
- A date field that provides the warraty expiry date of the asdset.
- trackingItems
- A table field that provides the tracking cateogry for the asset.
- See trackingItems Fields for more information.
- bookDepreciationSetting
- A record field that provides the settings for depreciating the book value of this asset.
- See bookDepreciationSetting Fields for more information.
- bookDepreciationDetail
- A record field that provides the additional details for depreciating this asset.
- See bookDepreciationDetail Fields for more information.
- taxDepreciationSettings
- A table field that provides the default settings for depreciating the tax value of these type of assets.
- See taxDepreciationSettings Fields for more information.
- taxDepreciationDetails
- A record field that provides the additional details for depreciating this asset for tax purposes.
- See taxDepreciationDetails Fields for more information.
- canRollback
- A true/false field that indicates if this asset can be rolled back or not.
taxValues Fields
The taxValues Fields include the following sub fields.
- taxType
- A text field that provides provides the tax type. This is always set to Tax.
- value
- A decimal field that provides the tax value of the asset.
trackingItems Fields
The trackingItems Fields include the following sub fields.
- trackingCategoryId
- A guid field that provides the id of the tracking category linked to this asset.
- This field links with the TrackingCategories endpoint.
- trackingItemId
- A guid field that provides the id of the tracking option linked to this asset.
- This field links with the TrackingCategories endpoint.
bookDepreciationSetting Fields
The bookDepreciationSetting Fields include the following sub fields.
- depreciationMethod
- A text field that provides the method to depreciate this asset.
- Possible values are:
- NoDepreciation: Indicates this asset has no depreciation.
- StraightLine: Indicates this asset is depreciated using a straight line percentage.
- DiminishingValue100: Indicates this asset is depreciated using Diminishing Value at 100%.
- DiminishingValue150: Indicates this asset is depreciated using Diminishing Value at 150%.
- DiminishingValue200: Indicates this asset is depreciated using Diminishing Value at 200%.
- FullDepreciation: Indicates this asset is depreciated in full at purchase.
- averagingMethod
- A text field that provides the method to average the value of this asset.
- Possible values are:
- ActualDays: Indicates the average is based on the actual number of days.
- FullMonth: Indicates the average is based on the full month.
- depreciationCalculationMethod
- A text field that provides the calculation method to depreciate this asset.
- Possible values are:
- Rate: Indicates the depreciation is calculated using a rate.
- Life: Indicates the depreciation is calculated using the assets life span.
- None: Indcates depreciation does not apply.
- depreciationRate
- A decimal field that provides the depreciation rate for this asset.
- effectiveLifeYears
- A decimal field that provides the effective life in years for this asset.
- costLimit
- A decimal field that provides the value of the asset you want to depreciate, if this is less than the cost of the asset.
- residualValue
- A decimal field that provides the value of the asset once fully depreciated.
- poolId
- A GUID field representing the id of the asset pool.
- This field cannot be linked at this time.
- pooled
- A true/false field that indicates if the asset type is pooled.
bookDepreciationDetail Fields
The bookDepreciationDetail Fields include the following sub fields.
- depreciationStartDate
- A date field that provides the start date used to depreciate the asset.
- priorAccumDepreciationAmount
- A decimal field that provides the total of all depreciation prior to the current financial year for this asset.
- currentAccumDepreciationAmount
- A decimal field that provides the total of all depreciation occurring in the current financial year for this asset.
- currentCapitalGain
- A decimal field that provides the capital gain value once this asset is disposed.
- currentGainLoss
- A decimal field that provides the gain/loss value once this asset is disposed.
- This will be the lowest one of sell price or purchase price, minus the current book value.
taxDepreciationSettings Fields
The taxDepreciationSettings Fields include the following sub fields.
- depreciationMethod
- A text field that provides the method to depreciate this asset.
- Possible values are:
- NoDepreciation: Indicates this asset has no depreciation.
- StraightLine: Indicates this asset is depreciated using a straight line percentage.
- DiminishingValue100: Indicates this asset is depreciated using Diminishing Value at 100%.
- DiminishingValue150: Indicates this asset is depreciated using Diminishing Value at 150%.
- DiminishingValue200: Indicates this asset is depreciated using Diminishing Value at 200%.
- FullDepreciation: Indicates this asset is depreciated in full at purchase.
- averagingMethod
- A text field that provides the method to average the value of this asset.
- Possible values are:
- ActualDays: Indicates the average is based on the actual number of days.
- FullMonth: Indicates the average is based on the full month.
- depreciationCalculationMethod
- A text field that provides the calculation method to depreciate this asset.
- Possible values are:
- Rate: Indicates the depreciation is calculated using a rate.
- Life: Indicates the depreciation is calculated using the assets life span.
- None: Indcates depreciation does not apply.
- depreciationRate
- A decimal field that provides the depreciation rate for this asset.
- effectiveLifeYears
- A decimal field that provides the effective life in years for this asset.
- poolId
- A GUID field representing the id of the asset pool.
- This field cannot be linked at this time.
- taxType
- A text field that provides provides the tax type. This is always set to Tax.
taxDepreciationDetails Fields
The taxDepreciationDetails Fields include the following sub fields.
- depreciationStartDate
- A date field that provides the start date used to depreciate the asset.
- priorAccumDepreciationAmount
- A decimal field that provides the total of all depreciation prior to the current financial year for this asset.
- currentAccumDepreciationAmount
- A decimal field that provides the total of all depreciation occurring in the current financial year for this asset.
- currentCapitalGain
- A decimal field that provides the capital gain value once this asset is disposed.
- currentGainLoss
- A decimal field that provides the gain/loss value once this asset is disposed.
- This will be the lowest one of sell price or purchase price, minus the current book value.
- taxType
- A text field that provides provides the tax type. This is always set to Tax.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints