Xero · Schema

Asset

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
assetId string The Xero-generated Id for the asset
assetName string The name of the asset
assetTypeId string The Xero-generated Id for the asset type
assetNumber string Must be unique.
purchaseDate string The date the asset was purchased YYYY-MM-DD
purchasePrice number The purchase price of the asset
disposalDate string The date the asset was disposed
disposalPrice number The price the asset was disposed at
assetStatus object
warrantyExpiryDate string The date the asset’s warranty expires (if needed) YYYY-MM-DD
serialNumber string The asset's serial number
bookDepreciationSetting object
bookDepreciationDetail object
canRollback boolean 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
accountingBookValue number The accounting value of the asset
isDeleteEnabledForDate boolean Boolean to indicate whether delete is enabled
View JSON Schema on GitHub

JSON Schema

xero-asset-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Asset",
  "title": "Asset",
  "type": "object",
  "required": [
    "assetName"
  ],
  "properties": {
    "assetId": {
      "type": "string",
      "format": "uuid",
      "description": "The Xero-generated Id for the asset",
      "example": "3b5b3a38-5649-495f-87a1-14a4e5918634"
    },
    "assetName": {
      "type": "string",
      "description": "The name of the asset",
      "example": "Awesome Truck 3"
    },
    "assetTypeId": {
      "type": "string",
      "format": "uuid",
      "description": "The Xero-generated Id for the asset type",
      "example": "3b5b3a38-5649-495f-87a1-14a4e5918634"
    },
    "assetNumber": {
      "type": "string",
      "description": "Must be unique.",
      "example": "FA-0013"
    },
    "purchaseDate": {
      "type": "string",
      "format": "date",
      "description": "The date the asset was purchased YYYY-MM-DD",
      "example": "2015-07-01 00:00:00"
    },
    "purchasePrice": {
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "description": "The purchase price of the asset",
      "example": "1000.0000"
    },
    "disposalDate": {
      "type": "string",
      "format": "date",
      "description": "The date the asset was disposed",
      "example": "2020-07-01 00:00:00"
    },
    "disposalPrice": {
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "description": "The price the asset was disposed at",
      "example": "1.0000"
    },
    "assetStatus": {
      "$ref": "#/components/schemas/AssetStatus"
    },
    "warrantyExpiryDate": {
      "type": "string",
      "description": "The date the asset\u2019s warranty expires (if needed) YYYY-MM-DD",
      "example": "ca4c6b39-4f4f-43e8-98da-5e1f350a6694"
    },
    "serialNumber": {
      "type": "string",
      "description": "The asset's serial number",
      "example": "ca4c6b39-4f4f-43e8-98da-5e1f350a6694"
    },
    "bookDepreciationSetting": {
      "$ref": "#/components/schemas/BookDepreciationSetting"
    },
    "bookDepreciationDetail": {
      "$ref": "#/components/schemas/BookDepreciationDetail"
    },
    "canRollback": {
      "type": "boolean",
      "description": "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.",
      "example": true
    },
    "accountingBookValue": {
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "description": "The accounting value of the asset",
      "example": 0
    },
    "isDeleteEnabledForDate": {
      "type": "boolean",
      "description": "Boolean to indicate whether delete is enabled",
      "example": true
    }
  }
}