Xero: Assets schemas

← Assets operations · All schemas

adds a fixed asset type — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
accumulatedDepreciationAccountId	string	Optional	The account for accumulated depreciation of fixed assets of this type Format: uuid
assetTypeId	string	Optional	Xero generated unique identifier for asset types Format: uuid
assetTypeName	string	Required within parent	The name of the asset type
bookDepreciationSetting	Model	Required within parent	Expand adds a fixed asset — request body — body book Depreciation Setting
depreciationExpenseAccountId	string	Optional	The expense account for the depreciation of fixed assets of this type Format: uuid
fixedAssetAccountId	string	Optional	The asset account for fixed assets of this type Format: uuid
locks	integer	Optional	All asset types that have accumulated depreciation for any assets that use them are deemed ‘locked’ and cannot be removed.

Referenced models: adds a fixed asset — request body — body book Depreciation Setting

adds a fixed asset type — response body

Field	Type	Presence	Description and constraints
$	object	Root
accumulatedDepreciationAccountId	string	Optional	The account for accumulated depreciation of fixed assets of this type Format: uuid
assetTypeId	string	Optional	Xero generated unique identifier for asset types Format: uuid
assetTypeName	string	Required within parent	The name of the asset type
bookDepreciationSetting	Model	Required within parent	Expand adds a fixed asset — response body — book Depreciation Setting
depreciationExpenseAccountId	string	Optional	The expense account for the depreciation of fixed assets of this type Format: uuid
fixedAssetAccountId	string	Optional	The asset account for fixed assets of this type Format: uuid
locks	JSON	Optional
locks (anyOf 1)	integer	Alternative	All asset types that have accumulated depreciation for any assets that use them are deemed ‘locked’ and cannot be removed.
locks (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: adds a fixed asset — response body — book Depreciation Setting

adds a fixed asset — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
accountingBookValue	number	Optional	The accounting value of the asset Format: double
assetId	string	Optional	The Xero-generated Id for the asset Format: uuid
assetName	string	Required within parent	The name of the asset
assetNumber	string	Optional	Must be unique.
assetStatus	string	Optional	See Asset Status Codes. One of: Draft, Registered, Disposed
assetTypeId	string	Optional	The Xero-generated Id for the asset type Format: uuid
bookDepreciationDetail	Model	Optional	Expand adds a fixed asset — request body — body book Depreciation Detail
bookDepreciationSetting	Model	Optional	Expand adds a fixed asset — request body — body book Depreciation Setting
canRollback	boolean	Optional	Boolean to indicate whether depreciation can be rolled back for this asset individually. This is true if it doesn't have 'legacy' journal entries and if there is no lock period that would prevent this asset from rolling back.
disposalDate	string	Optional	The date the asset was disposed Format: date
disposalPrice	number	Optional	The price the asset was disposed at Format: double
isDeleteEnabledForDate	boolean	Optional	Boolean to indicate whether delete is enabled
purchaseDate	string	Optional	The date the asset was purchased YYYY-MM-DD Format: date
purchasePrice	number	Optional	The purchase price of the asset Format: double
serialNumber	string	Optional	The asset's serial number
warrantyExpiryDate	string	Optional	The date the asset’s warranty expires (if needed) YYYY-MM-DD

Referenced models: adds a fixed asset — request body — body book Depreciation Detail, adds a fixed asset — request body — body book Depreciation Setting

adds a fixed asset — request body — body book Depreciation Detail

Field	Type	Presence	Description and constraints
$	JSON	Root
businessUseCapitalGain	number	Optional	(New Zealand Orgs Only) The portion of capital gain realised from the disposal of a fixed asset that is attributable to its business use. Format: decimal
businessUseCurrentGainLoss	number	Optional	(New Zealand Orgs Only) Represents the gain or loss from the disposal of the business use portion of a fixed asset. This value records the financial result (profit or loss) related specifically to the asset’s business use. Format: decimal
costLimit	number	Optional	The value of the asset you want to depreciate, if this is less than the cost of the asset. Format: double
currentAccumDepreciationAmount	number	Optional	All depreciation occurring in the current financial year. Format: double
currentCapitalGain	number	Optional	When an asset is disposed, this will be the sell price minus the purchase price if a profit was made. Format: double
currentGainLoss	number	Optional	When an asset is disposed, this will be the lowest one of sell price or purchase price, minus the current book value. Format: double
depreciationStartDate	string	Optional	YYYY-MM-DD Format: date
initialDeductionPercentage	number	Optional	(New Zealand Orgs Only) The Investment Boost deduction percentage. Format: decimal
priorAccumDepreciationAmount	number	Optional	All depreciation prior to the current financial year. Format: double
privateUseCapitalGain	number	Optional	(New Zealand Orgs Only) The portion of capital gain realised from the disposal of a fixed asset that is attributable to its private (non-business) use. Format: decimal
privateUseCurrentGainLoss	number	Optional	(New Zealand Orgs Only) Represents the gain or loss from the disposal of the private use portion of a fixed asset. This value records the financial result (profit or loss) related specifically to the asset’s private use. Format: decimal
residualValue	number	Optional	The value of the asset remaining when you've fully depreciated it. Format: double

adds a fixed asset — request body — body book Depreciation Setting

Field	Type	Presence	Description and constraints
$	JSON	Root
averagingMethod	string	Optional	The method of averaging applied to this asset. See Averaging Methods One of: FullMonth, ActualDays
bookEffectiveDateOfChangeId	string	Optional	Unique Xero identifier for the effective date change Format: uuid
depreciableObjectId	string	Optional	Unique Xero identifier for the depreciable object Format: uuid
depreciableObjectType	string	Optional	The type of asset object
depreciationCalculationMethod	string	Optional	See Depreciation Calculation Methods One of: Rate, Life, None
depreciationMethod	string	Optional	The method of depreciation applied to this asset. See Depreciation Methods One of: NoDepreciation, StraightLine, DiminishingValue100, DiminishingValue150, DiminishingValue200, FullDepreciation
depreciationRate	number	Optional	The rate of depreciation (e.g. 0.05) Format: double
effectiveLifeYears	integer	Optional	Effective life of the asset in years (e.g. 5)

adds a fixed asset — response body

Field	Type	Presence	Description and constraints
$	object	Root
accountingBookValue	JSON	Optional
accountingBookValue (anyOf 1)	number	Alternative	The accounting value of the asset Format: double
accountingBookValue (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
assetId	string	Optional	The Xero-generated Id for the asset Format: uuid
assetName	string	Required within parent	The name of the asset
assetNumber	string	Optional	Must be unique.
assetStatus	string	Optional	See Asset Status Codes. Known values: Draft, Registered, Disposed
assetTypeId	string	Optional	The Xero-generated Id for the asset type Format: uuid
bookDepreciationDetail	Model	Optional	Expand adds a fixed asset — response body — book Depreciation Detail
bookDepreciationSetting	Model	Optional	Expand adds a fixed asset — response body — book Depreciation Setting
canRollback	boolean	Optional	Boolean to indicate whether depreciation can be rolled back for this asset individually. This is true if it doesn't have 'legacy' journal entries and if there is no lock period that would prevent this asset from rolling back.
disposalDate	string	Optional	The date the asset was disposed Format: date
disposalPrice	JSON	Optional
disposalPrice (anyOf 1)	number	Alternative	The price the asset was disposed at Format: double
disposalPrice (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
isDeleteEnabledForDate	boolean	Optional	Boolean to indicate whether delete is enabled
purchaseDate	string	Optional	The date the asset was purchased YYYY-MM-DD Format: date
purchasePrice	JSON	Optional
purchasePrice (anyOf 1)	number	Alternative	The purchase price of the asset Format: double
purchasePrice (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
serialNumber	string	Optional	The asset's serial number
warrantyExpiryDate	string	Optional	The date the asset’s warranty expires (if needed) YYYY-MM-DD

Referenced models: adds a fixed asset — response body — book Depreciation Detail, adds a fixed asset — response body — book Depreciation Setting

adds a fixed asset — response body — book Depreciation Detail

Field	Type	Presence	Description and constraints
$	JSON	Root
businessUseCapitalGain	JSON	Optional
businessUseCapitalGain (anyOf 1)	number	Alternative	(New Zealand Orgs Only) The portion of capital gain realised from the disposal of a fixed asset that is attributable to its business use. Format: decimal
businessUseCapitalGain (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
businessUseCurrentGainLoss	JSON	Optional
businessUseCurrentGainLoss (anyOf 1)	number	Alternative	(New Zealand Orgs Only) Represents the gain or loss from the disposal of the business use portion of a fixed asset. This value records the financial result (profit or loss) related specifically to the asset’s business use. Format: decimal
businessUseCurrentGainLoss (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
costLimit	JSON	Optional
costLimit (anyOf 1)	number	Alternative	The value of the asset you want to depreciate, if this is less than the cost of the asset. Format: double
costLimit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currentAccumDepreciationAmount	JSON	Optional
currentAccumDepreciationAmount (anyOf 1)	number	Alternative	All depreciation occurring in the current financial year. Format: double
currentAccumDepreciationAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currentCapitalGain	JSON	Optional
currentCapitalGain (anyOf 1)	number	Alternative	When an asset is disposed, this will be the sell price minus the purchase price if a profit was made. Format: double
currentCapitalGain (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currentGainLoss	JSON	Optional
currentGainLoss (anyOf 1)	number	Alternative	When an asset is disposed, this will be the lowest one of sell price or purchase price, minus the current book value. Format: double
currentGainLoss (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
depreciationStartDate	string	Optional	YYYY-MM-DD Format: date
initialDeductionPercentage	JSON	Optional
initialDeductionPercentage (anyOf 1)	number	Alternative	(New Zealand Orgs Only) The Investment Boost deduction percentage. Format: decimal
initialDeductionPercentage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
priorAccumDepreciationAmount	JSON	Optional
priorAccumDepreciationAmount (anyOf 1)	number	Alternative	All depreciation prior to the current financial year. Format: double
priorAccumDepreciationAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
privateUseCapitalGain	JSON	Optional
privateUseCapitalGain (anyOf 1)	number	Alternative	(New Zealand Orgs Only) The portion of capital gain realised from the disposal of a fixed asset that is attributable to its private (non-business) use. Format: decimal
privateUseCapitalGain (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
privateUseCurrentGainLoss	JSON	Optional
privateUseCurrentGainLoss (anyOf 1)	number	Alternative	(New Zealand Orgs Only) Represents the gain or loss from the disposal of the private use portion of a fixed asset. This value records the financial result (profit or loss) related specifically to the asset’s private use. Format: decimal
privateUseCurrentGainLoss (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
residualValue	JSON	Optional
residualValue (anyOf 1)	number	Alternative	The value of the asset remaining when you've fully depreciated it. Format: double
residualValue (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

adds a fixed asset — response body — book Depreciation Setting

Field	Type	Presence	Description and constraints
$	JSON	Root
averagingMethod	string	Optional	The method of averaging applied to this asset. See Averaging Methods Known values: FullMonth, ActualDays
bookEffectiveDateOfChangeId	string	Optional	Unique Xero identifier for the effective date change Format: uuid
depreciableObjectId	string	Optional	Unique Xero identifier for the depreciable object Format: uuid
depreciableObjectType	string	Optional	The type of asset object
depreciationCalculationMethod	string	Optional	See Depreciation Calculation Methods Known values: Rate, Life, None
depreciationMethod	string	Optional	The method of depreciation applied to this asset. See Depreciation Methods Known values: NoDepreciation, StraightLine, DiminishingValue100, DiminishingValue150, DiminishingValue200, FullDepreciation
depreciationRate	JSON	Optional
depreciationRate (anyOf 1)	number	Alternative	The rate of depreciation (e.g. 0.05) Format: double
depreciationRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
effectiveLifeYears	JSON	Optional
effectiveLifeYears (anyOf 1)	integer	Alternative	Effective life of the asset in years (e.g. 5)
effectiveLifeYears (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

searches fixed asset settings — response body

Field	Type	Presence	Description and constraints
$	object	Root
assetNumberPrefix	string	Optional	The prefix used for fixed asset numbers (“FA-” by default)
assetNumberSequence	string	Optional	The next available sequence number
assetStartDate	string	Optional	The date depreciation calculations started on registered fixed assets in Xero Format: date
defaultCapitalGainOnDisposalAccountId	string	Optional	Default account that capital gains are posted to Format: uuid
defaultGainOnDisposalAccountId	string	Optional	Default account that gains are posted to Format: uuid
defaultLossOnDisposalAccountId	string	Optional	Default account that losses are posted to Format: uuid
lastDepreciationDate	string	Optional	The last depreciation date Format: date
optInForTax	boolean	Optional	opt in for tax calculation

searches fixed asset — response body

Field	Type	Presence	Description and constraints
$	object	Root
items	array	Optional
items[]	Model	Each item	Expand adds a fixed asset — response body
pagination	Model	Optional	Expand searches fixed asset — response body — pagination

Referenced models: adds a fixed asset — response body, searches fixed asset — response body — pagination

searches fixed asset — response body — pagination

Field	Type	Presence	Description and constraints
$	JSON	Root
itemCount	JSON	Optional
itemCount (anyOf 1)	integer	Alternative
itemCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
page	JSON	Optional
page (anyOf 1)	integer	Alternative
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageCount	JSON	Optional
pageCount (anyOf 1)	integer	Alternative
pageCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageSize	JSON	Optional
pageSize (anyOf 1)	integer	Alternative
pageSize (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$