Xero: searches fixed asset

← Assets operations · Get started

Operation xero.assets_getassets

Provider route: GET /assets.xro/1.0/Assets. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/xero with npm, or alter-sdk-xero with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { XeroIntegration } from "@alter-ai/xero";

async function execute(input: Parameters<XeroIntegration["assets"]["getAssets"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new XeroIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.assets.getAssets(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_xero import XeroIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = XeroIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.assets.get_assets(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.status	string	Required within parent	See Asset Status Codes. One of: DRAFT, REGISTERED, DISPOSED
query.page	integer	Optional
query.pageSize	integer	Optional
query.orderBy	string	Optional	One of: AssetType, AssetName, AssetNumber, PurchaseDate, PurchasePrice, DisposalDate, DisposalPrice
query.sortDirection	string	Optional	One of: asc, desc
query.filterBy	string	Optional
headers	object	Required within parent	Additional keys: not allowed
headers.xero-tenant-id	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand searches fixed asset — response body

Referenced models: searches fixed asset — response body

Schemas

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

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

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]+)?$

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]+)?$

Policy, approvals and errors

SDK function policy ID: xero.assets_getassets. Catalog operation: assets.getAssets. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source