XExeroapi
Asset

searches fixed asset

Changed on

By passing in the appropriate options, you can search for available fixed asset in the system

get/Assets

Request

  • Base URL
    https://api.xero.com/assets.xro/1.0
  • URL
    https://api.xero.com/assets.xro/1.0/Assets
  • Auth
    OAuth 2
    Authorization code: https://login.xero.com/identity/connect/authorize
    Token URL: https://identity.xero.com/connect/token scopes: assets, assets.read

Query parameters

status'DRAFT' | 'REGISTERED' | 'DISPOSED' required

See Asset Status Codes.

Example:DRAFT

Required when retrieving a collection of assets. See Asset Status Codes

pageinteger
Example:1

Results are paged. This specifies which page of the results to return. The default page is 1.

pageSizeinteger
Example:5

The number of records returned per page. By default the number of records returned is 10.

orderBy'AssetType' | 'AssetName' | 'AssetNumber' | 'PurchaseDate' | 'PurchasePrice' | 'DisposalDate' | 'DisposalPrice'
Example:AssetName

Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice.

sortDirection'asc' | 'desc'
Example:ASC

ASC or DESC

filterBystring
Example:Company Car

A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields.

Response

search results matching criteria

Example response

{
  "pagination": {
    "page": 1,
    "pageSize": 10,
    "pageCount": 1,
    "itemCount": 2
  },
  "items": [
    {
      "assetId": "3b5b3a38-5649-495f-87a1-14a4e5918634",
      "assetName": "Awesome Truck 3",
      "assetTypeId": "3b5b3a38-5649-495f-87a1-14a4e5918634",
      "assetNumber": "FA-0013",
      "purchaseDate": "2015-07-01T00:00:00",
      "disposalDate": "2020-07-01T00:00:00",
      "assetStatus": "Draft",
      "warrantyExpiryDate": "ca4c6b39-4f4f-43e8-98da-5e1f350a6694",
      "serialNumber": "ca4c6b39-4f4f-43e8-98da-5e1f350a6694",
      "bookDepreciationSetting": {
        "depreciationMethod": "StraightLine",
        "averagingMethod": "ActualDays",
        "depreciationRate": 0.05,
        "effectiveLifeYears": 5,
        "depreciationCalculationMethod": "None",
        "depreciableObjectId": "68f17094-af97-4f1b-b36b-013b45b6ad3c",
        "depreciableObjectType": "Asset",
        "bookEffectiveDateOfChangeId": "68f17094-af97-4f1b-b36b-013b45b6ad3c"
      },
      "bookDepreciationDetail": {
        "currentCapitalGain": 5.25,
        "currentGainLoss": 10.5,
        "depreciationStartDate": "2015-07-01T00:00:00",
        "costLimit": 9000,
        "residualValue": 10000,
        "priorAccumDepreciationAmount": 0.45,
        "currentAccumDepreciationAmount": 5
      },
      "canRollback": true,
      "isDeleteEnabledForDate": true
    }
  ]
}

Changes

  • 0b01d6001cb0Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status