Nic at 02:41, 5 December 2022

2022-12-05T02:41:29Z

← Older revision		Revision as of 21:41, 4 December 2022
Line 262:		Line 262:

	:[[Xero Assets Endpoint: Assets\|Assets]]		:[[Xero Assets Endpoint: Assets\|Assets]]
	:[[Xero Assets Endpoint: ~~AssetTypes~~\|~~AssetTypes~~]]		:[[Xero Assets Endpoint: AssetsExpanded\|AssetsExpanded]]
	:[[Xero Assets Endpoint: ~~GetAsset~~\|~~GetAsset~~]]		:[[Xero Assets Endpoint: AssetsTypes\|AssetsTypes]]

Nic at 02:35, 5 December 2022

2022-12-05T02:35:16Z

← Older revision		Revision as of 21:35, 4 December 2022
Line 2:		Line 2:

	The Xero '''GetAsset''' [[Xero Assets Endpoints\|endpoint]] provides all the fields for a single asset specified using it's id.		The Xero '''GetAsset''' [[Xero Assets Endpoints\|endpoint]] provides all the fields for a single asset specified using it's id.

			It is a [[Function Endpoints\|function]] that accepts a series of parameters.

	This endpoint only provides three additional fields over the [[Xero Assets Endpoint: Assets\|Assets]] endpoint.		This endpoint only provides three additional fields over the [[Xero Assets Endpoint: Assets\|Assets]] endpoint.

	It also provides data in a similar format to the [[Xero Assets Endpoint: AssetsExpanded\|AssetsExpanded]] function.		It also provides data in a similar format to the [[Xero Assets Endpoint: AssetsExpanded\|AssetsExpanded]] function.


			== Parameters ==

			The GetAssetis a [[Function Endpoints\|function]] that accepts the following parameters.

			;assetId
			:A [[Field Type: GUID\|guid field]] that determines the asset for which to retrieve data.
			:This field is mandatory.

Nic at 02:15, 5 December 2022

2022-12-05T02:15:32Z

← Older revision		Revision as of 21:15, 4 December 2022
Line 26:		Line 26:
	;assetTypeId		;assetTypeId
	:A [[Field Type: GUID\|guid field]] that provides the id of the asset type.		:A [[Field Type: GUID\|guid field]] that provides the id of the asset type.
	:This field links with the [[Xero Assets Endpoint: ~~AssetTypes~~\|~~AssetTypes~~]] endpoint.		:This field links with the [[Xero Assets Endpoint: AssetsTypes\|AssetsTypes]] endpoint.

	;assetStatus		;assetStatus

Nic: Created page with "== Overview == The Xero '''GetAsset''' endpoint provides all the fields for a single asset specified using it's id. This endpoint only provides thr..."

2022-12-05T02:15:19Z

Created page with "== Overview == The Xero '''GetAsset''' endpoint provides all the fields for a single asset specified using it's id. This endpoint only provides thr..."

New page

== Overview ==

The Xero '''GetAsset''' [[Xero Assets Endpoints|endpoint]] provides all the fields for a single asset specified using it's id.

This endpoint only provides three additional fields over the [[Xero Assets Endpoint: Assets|Assets]] endpoint.

It also provides data in a similar format to the [[Xero Assets Endpoint: AssetsExpanded|AssetsExpanded]] function.

== Fields ==

The following fields are available for the AssetsTypes endpoint.

;DataFile
:A [[Field Type: Record|record field]] that provides the [[Field: DataFile|DataFile]] associated with the asset type.

;assetId
:A [[Field Type: GUID|guid field]] that provides the id of the asset.

;assetNumber
:A [[Field Type: Text|text field]] that provides the number of the asset.

;assetName
:A [[Field Type: Text|text field]] that provides the name of the asset.

;assetTypeId
:A [[Field Type: GUID|guid field]] that provides the id of the asset type.
:This field links with the [[Xero Assets Endpoint: AssetTypes|AssetTypes]] endpoint.

;assetStatus
:A [[Field Type: Text|text field]] that provides the status of the asset.
:Possible values are:
:* '''DRAFT'''
:* '''REGISTERED'''
:* '''DISPOSED'''

;purchaseDate
:A [[Field Type: Date|date field]] that provides the date the asset was purchased.

;purchasePrice
:A [[Field Type: Decimal|decimal field]] that provides the price at which the asset was purchased.

;disposalPrice
:A [[Field Type: Decimal|decimal field]] that provides the price at which the asset was disposed, if applicable.

;accountingBookValue
:A [[Field Type: Decimal|decimal field]] that provides the asset's acconting book value as of now.

;taxValues
:A [[Field Type: Table|table field]] that provides tax values of the asset as of now.
:See [[#taxValues Fields|taxValues Fields]] for more information.

;serialNumber
:A [[Field Type: Text|text field]] that provides the serial number of the asset.

;warrantyExpiryDate
:A [[Field Type: Date|date field]] that provides the warraty expiry date of the asdset.

;trackingItems
:A [[Field Type: Table|table field]] that provides the tracking cateogry for the asset.
:See [[#trackingItems Fields|trackingItems Fields]] for more information.

;bookDepreciationSetting
:A [[Field Type: Record|record field]] that provides the settings for depreciating the book value of this asset.
:See [[#bookDepreciationSetting Fields|bookDepreciationSetting Fields]] for more information.

;bookDepreciationDetail
:A [[Field Type: Record|record field]] that provides the additional details for depreciating this asset.
:See [[#bookDepreciationDetail Fields|bookDepreciationDetail Fields]] for more information.

;taxDepreciationSettings
:A [[Field Type: Table|table field]] that provides the default settings for depreciating the tax value of these type of assets.
:See [[#taxDepreciationSettings Fields|taxDepreciationSettings Fields]] for more information.

;taxDepreciationDetails
:A [[Field Type: Record|record field]] that provides the additional details for depreciating this asset for tax purposes.
:See [[#taxDepreciationDetails Fields|taxDepreciationDetails Fields]] for more information.

;canRollback
:A [[Field Type: Boolean|true/false field]] that indicates if this asset can be rolled back or not.

== taxValues Fields ==

The [[#Fields|taxValues Fields]] include the following sub fields.

;taxType
:A [[Field Type: Text|text field]] that provides provides the tax type. This is always set to '''Tax'''.

;value
:A [[Field Type: Decimal|decimal field]] that provides the tax value of the asset.

== trackingItems Fields ==

The [[#Fields|trackingItems Fields]] include the following sub fields.

;trackingCategoryId
:A [[Field Type: GUID|guid field]] that provides the id of the tracking category linked to this asset.
:This field links with the [[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]] endpoint.

;trackingItemId
:A [[Field Type: GUID|guid field]] that provides the id of the tracking option linked to this asset.
:This field links with the [[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]] endpoint.

== bookDepreciationSetting Fields ==

The [[#Fields|bookDepreciationSetting Fields]] include the following sub fields.

;depreciationMethod
:A [[Field Type: Text|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 [[Field Type: Text|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 [[Field Type: Text|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 [[Field Type: Decimal|decimal field]] that provides the depreciation rate for this asset.

;effectiveLifeYears
:A [[Field Type: Decimal|decimal field]] that provides the effective life in years for this asset.

;costLimit
:A [[Field Type: Decimal|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 [[Field Type: Decimal|decimal field]] that provides the value of the asset once fully depreciated.

;poolId
:A [[Field Type: GUID|GUID field]] representing the id of the asset pool.
:This field cannot be linked at this time.

;pooled
:A [[Field Type: Boolean|true/false field]] that indicates if the asset type is pooled.

== bookDepreciationDetail Fields ==

The [[#Fields|bookDepreciationDetail Fields]] include the following sub fields.

;depreciationStartDate
:A [[Field Type: Date|date field]] that provides the start date used to depreciate the asset.

;priorAccumDepreciationAmount
:A [[Field Type: Decimal|decimal field]] that provides the total of all depreciation prior to the current financial year for this asset.

;currentAccumDepreciationAmount
:A [[Field Type: Decimal|decimal field]] that provides the total of all depreciation occurring in the current financial year for this asset.

;currentCapitalGain
:A [[Field Type: Decimal|decimal field]] that provides the capital gain value once this asset is disposed.

;currentGainLoss
:A [[Field Type: Decimal|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 [[#Fields|taxDepreciationSettings Fields]] include the following sub fields.

;depreciationMethod
:A [[Field Type: Text|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 [[Field Type: Text|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 [[Field Type: Text|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 [[Field Type: Decimal|decimal field]] that provides the depreciation rate for this asset.

;effectiveLifeYears
:A [[Field Type: Decimal|decimal field]] that provides the effective life in years for this asset.

;poolId
:A [[Field Type: GUID|GUID field]] representing the id of the asset pool.
:This field cannot be linked at this time.

;taxType
:A [[Field Type: Text|text field]] that provides provides the tax type. This is always set to '''Tax'''.

== taxDepreciationDetails Fields ==

The [[#Fields|taxDepreciationDetails Fields]] include the following sub fields.

;depreciationStartDate
:A [[Field Type: Date|date field]] that provides the start date used to depreciate the asset.

;priorAccumDepreciationAmount
:A [[Field Type: Decimal|decimal field]] that provides the total of all depreciation prior to the current financial year for this asset.

;currentAccumDepreciationAmount
:A [[Field Type: Decimal|decimal field]] that provides the total of all depreciation occurring in the current financial year for this asset.

;currentCapitalGain
:A [[Field Type: Decimal|decimal field]] that provides the capital gain value once this asset is disposed.

;currentGainLoss
:A [[Field Type: Decimal|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 [[Field Type: Text|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 [https://developer.xero.com/documentation/api/assets/assets Xero API].

== Related Fields ==

:[[Field: DataFile|DataFile]]

== Related Endpoints ==

:[[Xero Assets Endpoint: Assets|Assets]]
:[[Xero Assets Endpoint: AssetTypes|AssetTypes]]
:[[Xero Assets Endpoint: GetAsset|GetAsset]]

== Related Topics ==

:[[Xero Assets Models]]
:[[Xero Assets Endpoints]]

Xero Assets Endpoint: GetAsset - Revision history

Nic at 02:41, 5 December 2022

Nic at 02:35, 5 December 2022

Nic at 02:15, 5 December 2022

Nic: Created page with "== Overview == The Xero '''GetAsset''' endpoint provides all the fields for a single asset specified using it's id. This endpoint only provides thr..."