openapi-directory/api/xero.com/xero_assets.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"description":"Xero API servers","url":"https://api.xero.com/assets.xro/1.0"}],"info":{"contact":{"email":"api@xero.com","name":"Xero Platform Team","url":"https://developer.xero.com","x-twitter":"XeroAPI"},"description":"The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc.","license":{"name":"MIT","url":"https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE"},"termsOfService":"https://developer.xero.com/xero-developer-platform-terms-conditions/","title":"Xero Assets API","version":"2.9.4","x-apisguru-categories":["financial"],"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/master/xero_assets.yaml","version":"3.0"}],"x-providerName":"xero.com","x-serviceName":"xero_assets"},"paths":{"/AssetTypes":{"get":{"description":"By passing in the appropriate options, you can search for available fixed asset types in the system","operationId":"getAssetTypes","responses":{"200":{"content":{"application/json":{"example":"[ { \"assetTypeId\":\"710255c6-d2ed-4463-b992-06c8685add5e\", \"assetTypeName\":\"Computer Equipment\", \"fixedAssetAccountId\":\"37c35de7-8df0-44bf-8e7c-f1f67cf6a278\", \"depreciationExpenseAccountId\":\"0fbd1820-9dd0-454a-9515-6ec076a84cf7\", \"accumulatedDepreciationAccountId\":\"512eac06-6894-47cd-b421-673b4ca2693a\", \"bookDepreciationSetting\":{ \"depreciableObjectId\":\"710255c6-d2ed-4463-b992-06c8685add5e\", \"depreciableObjectType\":\"AssetType\", \"bookEffectiveDateOfChangeId\":\"39b9c2e9-62b1-4efc-ab75-fa9152ffaa5f\", \"depreciationMethod\":\"StraightLine\", \"averagingMethod\":\"FullMonth\", \"depreciationRate\":25.00, \"depreciationCalculationMethod\":\"None\" }, \"taxDepreciationSettings\":[ ], \"locks\":0, \"lockPrivateUseAccount\":false }, { \"assetTypeId\":\"1a398a67-9d9d-4783-8689-14a8efce89d9\", \"assetTypeName\":\"Machinery97704\", \"fixedAssetAccountId\":\"5c93f577-c48f-44cd-8593-01489e319c2b\", \"depreciationExpenseAccountId\":\"adc14376-c960-43f0-b7f3-4063e5098039\", \"accumulatedDepreciationAccountId\":\"9195cadd-8645-41e6-9f67-7bcd421defe8\", \"bookDepreciationSetting\":{ \"depreciableObjectId\":\"1a398a67-9d9d-4783-8689-14a8efce89d9\", \"depreciableObjectType\":\"AssetType\", \"bookEffectiveDateOfChangeId\":\"6d09a96d-7768-4f28-95e8-c9ac870fe36e\", \"depreciationMethod\":\"DiminishingValue100\", \"averagingMethod\":\"ActualDays\", \"depreciationRate\":40.00, \"depreciationCalculationMethod\":\"None\" }, \"taxDepreciationSettings\":[ ], \"locks\":0, \"lockPrivateUseAccount\":false } ]","schema":{"items":{"$ref":"#/components/schemas/AssetType"},"type":"array"}}},"description":"search results matching criteria"},"400":{"description":"bad input parameter"}},"security":[{"OAuth2":["assets.read"]}],"summary":"searches fixed asset types","tags":["Asset"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}],"post":{"description":"Adds an fixed asset type to the system","operationId":"createAssetType","requestBody":{"content":{"application/json":{"example":"{ \"assetTypeName\":\"Machinery11004\", \"fixedAssetAccountId\":\"3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82\", \"depreciationExpenseAccountId\":\"d1602f69-f900-4616-8d34-90af393fa368\", \"accumulatedDepreciationAccountId\":\"9195cadd-8645-41e6-9f67-7bcd421defe8\", \"bookDepreciationSetting\":{ \"depreciationMethod\":\"DiminishingValue100\", \"averagingMethod\":\"ActualDays\", \"depreciationRate\":0.05, \"depreciationCalculationMethod\":\"None\" } }","schema":{"$ref":"#/components/schemas/AssetType"}}},"description":"Asset type to add"},"responses":{"200":{"content":{"application/json":{"example":"{ \"assetTypeId\":\"85509b5d-308e-420d-9532-b85105058916\", \"assetTypeName\":\"Machinery11004\", \"fixedAssetAccountId\":\"3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82\", \"depreciationExpenseAccountId\":\"d1602f69-f900-4616-8d34-90af393fa368\", \"accumulatedDepreciationAccountId\":\"9195cadd-8645-41e6-9f67-7bcd421defe8\", \"bookDepreciationSetting\":{ \"depreciableObjectId\":\"00000000-0000-0000-0000-000000000000\", \"depreciableObjectType\":\"None\", \"depreciationMethod\":\"DiminishingValue100\", \"averagingMethod\":\"ActualDays\", \"depreciationRate\":0.05, \"depreciationCalculationMethod\":\"None\" }, \"locks\":0, \"lockPrivateUseAccount\":false }","schema":{"$ref":"#/components/schemas/AssetType"}}},"description":"results single object -  created fixed type"},"400":{"content":{"application/json":{"example":"{ \"resourceValidationErrors\":[ ], \"fieldValidationErrors\":[ { \"fieldName\":\"FixedAssetAccountId\", \"valueProvided\":\"\", \"localisedMessage\":\"Fixed Asset Account Id is invalid\", \"type\":\"http://common.service.xero.com/errors/validation/field\", \"title\":\"Validation Error\", \"detail\":\"Fixed Asset Account Id is invalid\" }, { \"fieldName\":\"DepreciationExpenseAccountId\", \"valueProvided\":\"\", \"localisedMessage\":\"Depreciation Expense Account Id is invalid\", \"type\":\"http://common.service.xero.com/errors/validation/field\", \"title\":\"Validation Error\", \"detail\":\"Depreciation Expense Account Id is invalid\" } ], \"type\":\"http://common.service.xero.com/errors/validation\", \"title\":\"The resource update failed validation.\", \"detail\":\"Validation Errors\" }"}},"description":"invalid input, object invalid"},"409":{"description":"a type already exists"}},"security":[{"OAuth2":["assets"]}],"summary":"adds a fixed asset type","tags":["Asset"],"x-hasAssetsValidationError":true}},"/Assets":{"get":{"description":"By passing in the appropriate options, you can search for available fixed asset in the system","operationId":"getAssets","parameters":[{"description":"Required when retrieving a collection of assets. See Asset Status Codes","in":"query","name":"status","required":true,"schema":{"$ref":"#/components/schemas/AssetStatusQueryParam"}},{"description":"Results are paged. This specifies which page of the results to return. The default page is 1.","in":"query","name":"page","schema":{"example":1,"type":"integer"}},{"description":"The number of records returned per page. By default the number of records returned is 10.","in":"query","name":"pageSize","schema":{"example":5,"type":"integer"}},{"description":"Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice.","in":"query","name":"orderBy","schema":{"enum":["AssetType","AssetName","AssetNumber","PurchaseDate","PurchasePrice","DisposalDate","DisposalPrice"],"example":"AssetName","type":"string"}},{"description":"ASC or DESC","in":"query","name":"sortDirection","schema":{"enum":["asc","desc"],"example":"ASC","type":"string"}},{"description":"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.","in":"query","name":"filterBy","schema":{"example":"Company Car","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"pagination\":{ \"page\":1, \"pageSize\":10, \"pageCount\":2, \"itemCount\":11, \"links\":{ \"first\":{ \"href\":\"http://asset.favorit.xero.com/v1/assets?status=DRAFT&page=1\" }, \"next\":{ \"href\":\"http://asset.favorit.xero.com/v1/assets?status=DRAFT&page=2\" }, \"last\":{ \"href\":\"http://asset.favorit.xero.com/v1/assets?status=DRAFT&page=2\" } } }, \"items\":[ { \"assetId\":\"68f17094-af97-4f1b-b36b-013b45b6ad3c\", \"assetName\":\"Computer47822\", \"assetNumber\":\"123478074\", \"purchaseDate\":\"2020-01-01T00:00:00\", \"purchasePrice\":100.0000, \"disposalPrice\":0.0, \"assetStatus\":\"Draft\", \"trackingItems\":[ ], \"bookDepreciationSetting\":{ \"depreciableObjectId\":\"68f17094-af97-4f1b-b36b-013b45b6ad3c\", \"depreciableObjectType\":\"Asset\", \"bookEffectiveDateOfChangeId\":\"5da77739-7f22-4109-b0a0-67480fb89af0\", \"depreciationMethod\":\"StraightLine\", \"averagingMethod\":\"ActualDays\", \"depreciationRate\":0.50, \"depreciationCalculationMethod\":\"None\" }, \"bookDepreciationDetail\":{ \"depreciationStartDate\":\"2020-01-02T00:00:00\", \"priorAccumDepreciationAmount\":0.000000, \"currentAccumDepreciationAmount\":0.000000, \"currentCapitalGain\":0.000000, \"currentGainLoss\":0.000000 }, \"taxDepreciationSettings\":[ ], \"taxDepreciationDetails\":[ ], \"canRollback\":true, \"accountingBookValue\":100.000000, \"taxValues\":[ ], \"isDeleteEnabledForDate\":false }, { \"assetId\":\"52ea3adf-f04a-4577-8fd2-43c52a256bd5\", \"assetName\":\"Computer4148\", \"assetNumber\":\"123466620\", \"purchaseDate\":\"2020-01-01T00:00:00\", \"purchasePrice\":100.0000, \"disposalPrice\":0.0, \"assetStatus\":\"Draft\", \"trackingItems\":[\n], \"bookDepreciationSetting\":{ \"depreciableObjectId\":\"52ea3adf-f04a-4577-8fd2-43c52a256bd5\", \"depreciableObjectType\":\"Asset\", \"bookEffectiveDateOfChangeId\":\"c0d5280f-28b6-4329-b5b7-36e08c662010\", \"depreciationMethod\":\"StraightLine\", \"averagingMethod\":\"ActualDays\", \"depreciationRate\":0.50, \"depreciationCalculationMethod\":\"None\" }, \"bookDepreciationDetail\":{ \"depreciationStartDate\":\"2020-01-02T00:00:00\", \"priorAccumDepreciationAmount\":0.000000, \"currentAccumDepreciationAmount\":0.000000, \"currentCapitalGain\":0.000000, \"currentGainLoss\":0.000000 }, \"taxDepreciationSettings\":[ ], \"taxDepreciationDetails\":[ ], \"canRollback\":true, \"accountingBookValue\":100.000000, \"taxValues\":[\n], \"isDeleteEnabledForDate\":false } ] }","schema":{"$ref":"#/components/schemas/Assets"}}},"description":"search results matching criteria"},"400":{"description":"bad input parameter"}},"security":[{"OAuth2":["assets.read"]}],"summary":"searches fixed asset","tags":["Asset"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}],"post":{"description":"Adds an asset to the system","operationId":"createAsset","requestBody":{"content":{"application/json":{"example":"{ \"assetName\":\"Computer74863\", \"assetNumber\":\"123477544\", \"purchaseDate\":\"2020-01-01\", \"purchasePrice\":100.0, \"disposalPrice\":23.23, \"assetStatus\":\"Draft\", \"bookDepreciationSetting\":{ \"depreciationMethod\":\"StraightLine\", \"averagingMethod\":\"ActualDays\", \"depreciationRate\":0.5, \"depreciationCalculationMethod\":\"None\" }, \"bookDepreciationDetail\":{ \"currentCapitalGain\":5.32, \"currentGainLoss\":3.88, \"depreciationStartDate\":\"2020-01-02\", \"costLimit\":100.0, \"currentAccumDepreciationAmount\":2.25 }, \"AccountingBookValue\":99.5 }","schema":{"$ref":"#/components/schemas/Asset"}}},"description":"Fixed asset you are creating","required":true},"responses":{"200":{"content":{"application/json":{"example":"{ \"assetId\":\"2257c64a-77ca-444c-a5ea-fa9a588c7039\", \"assetName\":\"Computer74863\", \"assetNumber\":\"123477544\", \"purchaseDate\":\"2020-01-01T00:00:00\", \"purchasePrice\":100.0000, \"disposalPrice\":23.2300, \"assetStatus\":\"Draft\", \"trackingItems\":[], \"bookDepreciationSetting\":{ \"depreciableObjectId\":\"2257c64a-77ca-444c-a5ea-fa9a588c7039\", \"depreciableObjectType\":\"Asset\", \"bookEffectiveDateOfChangeId\":\"b58a2ace-1213-4681-9f11-2e30f57b5b8c\", \"depreciationMethod\":\"StraightLine\", \"averagingMethod\":\"ActualDays\", \"depreciationRate\":0.50, \"depreciationCalculationMethod\":\"None\" }, \"bookDepreciationDetail\":{ \"depreciationStartDate\":\"2020-01-02T00:00:00\", \"priorAccumDepreciationAmount\":0.000000, \"currentAccumDepreciationAmount\":0.000000, \"currentCapitalGain\":0.000000, \"currentGainLoss\":0.000000 }, \"taxDepreciationSettings\":[ ], \"taxDepreciationDetails\":[], \"canRollback\":true, \"accountingBookValue\":76.770000, \"taxValues\":[], \"isDeleteEnabledForDate\":true }","schema":{"$ref":"#/components/schemas/Asset"}}},"description":"return single object - create new asset"},"400":{"content":{"application/json":{"example":"{ \"resourceValidationErrors\":[ ], \"fieldValidationErrors\":[ { \"fieldName\":\"BookDepreciationSetting.DepreciationRate\", \"valueProvided\":\"\", \"localisedMessage\":\"Can't have both Depreciation Rate and Effective Life\", \"type\":\"http://common.service.xero.com/errors/validation/field\", \"title\":\"Validation Error\", \"detail\":\"Can't have both Depreciation Rate and Effective Life\" } ], \"type\":\"http://common.service.xero.com/errors/validation\", \"title\":\"The resource update failed validation.\", \"detail\":\"Validation Errors\" }"}},"description":"invalid input, object invalid"}},"security":[{"OAuth2":["assets"]}],"summary":"adds a fixed asset","tags":["Asset"],"x-hasAssetsValidationError":true}},"/Assets/{id}":{"get":{"description":"By passing in the appropriate asset id, you can search for\na specific fixed asset in the system\n","operationId":"getAssetById","parameters":[{"description":"fixed asset id for single object","in":"path","name":"id","required":true,"schema":{"example":"4f7bcdcb-5ec1-4258-9558-19f662fccdfe","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":"{ \"assetId\":\"68f17094-af97-4f1b-b36b-013b45b6ad3c\", \"assetName\":\"Computer47822\", \"assetNumber\":\"123478074\", \"purchaseDate\":\"2020-01-01T00:00:00\", \"purchasePrice\":100.0000, \"disposalPrice\":23.0000, \"assetStatus\":\"Draft\", \"trackingItems\":[\n], \"bookDepreciationSetting\":{ \"depreciableObjectId\":\"68f17094-af97-4f1b-b36b-013b45b6ad3c\", \"depreciableObjectType\":\"Asset\", \"bookEffectiveDateOfChangeId\":\"5da77739-7f22-4109-b0a0-67480fb89af0\", \"depreciationMethod\":\"StraightLine\", \"averagingMethod\":\"ActualDays\", \"depreciationRate\":0.50, \"depreciationCalculationMethod\":\"None\" }, \"bookDepreciationDetail\":{ \"depreciationStartDate\":\"2020-01-02T00:00:00\", \"priorAccumDepreciationAmount\":0.000000, \"currentAccumDepreciationAmount\":0.000000, \"currentCapitalGain\":0.000000, \"currentGainLoss\":0.000000 }, \"taxDepreciationSettings\":[ ], \"taxDepreciationDetails\":[ ], \"canRollback\":true, \"metaData\":{ \"bookDepreciationDetailsCanChange\":true, \"taxDepreciationDetailsCanChange\":true }, \"accountingBookValue\":77.000000, \"taxValues\":[ ], \"isDeleteEnabledForDate\":true }","schema":{"$ref":"#/components/schemas/Asset"}}},"description":"search results matching criteria"},"400":{"description":"bad input parameter"}},"security":[{"OAuth2":["assets.read"]}],"summary":"Retrieves fixed asset by id","tags":["Asset"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}]},"/Settings":{"get":{"description":"By passing in the appropriate options, you can search for available fixed asset types in the system","operationId":"getAssetSettings","responses":{"200":{"content":{"application/json":{"example":"{ \"assetNumberPrefix\":\"FA-\", \"assetNumberSequence\":\"0007\", \"assetStartDate\":\"2016-01-01T00:00:00\", \"optInForTax\":false }","schema":{"$ref":"#/components/schemas/Setting"}}},"description":"search results matching criteria"},"400":{"description":"bad input parameter"}},"security":[{"OAuth2":["assets.read"]}],"summary":"searches fixed asset settings","tags":["Asset"]},"parameters":[{"$ref":"#/components/parameters/requiredHeader"}]}},"components":{"parameters":{"requiredHeader":{"description":"Xero identifier for Tenant","example":"YOUR_XERO_TENANT_ID","in":"header","name":"xero-tenant-id","required":true,"schema":{"type":"string"}}},"schemas":{"Asset":{"properties":{"accountingBookValue":{"description":"The accounting value of the asset","example":0,"format":"double","type":"number","x-is-money":true},"assetId":{"description":"The Xero-generated Id for the asset","example":"3b5b3a38-5649-495f-87a1-14a4e5918634","format":"uuid","type":"string"},"assetName":{"description":"The name of the asset","example":"Awesome Truck 3","type":"string"},"assetNumber":{"description":"Must be unique.","example":"FA-0013","type":"string"},"assetStatus":{"$ref":"#/components/schemas/AssetStatus"},"assetTypeId":{"description":"The Xero-generated Id for the asset type","example":"3b5b3a38-5649-495f-87a1-14a4e5918634","format":"uuid","type":"string"},"bookDepreciationDetail":{"$ref":"#/components/schemas/BookDepreciationDetail"},"bookDepreciationSetting":{"$ref":"#/components/schemas/BookDepreciationSetting"},"canRollback":{"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,"type":"boolean"},"disposalDate":{"description":"The date the asset was disposed","example":"2025-04-15T13:51:57.237Z","format":"date","type":"string"},"disposalPrice":{"description":"The price the asset was disposed at","example":"1.0000","format":"double","type":"number","x-is-money":true},"isDeleteEnabledForDate":{"description":"Boolean to indicate whether delete is enabled","example":true,"type":"boolean"},"purchaseDate":{"description":"The date the asset was purchased YYYY-MM-DD","example":"2025-04-15T13:51:57.237Z","format":"date","type":"string"},"purchasePrice":{"description":"The purchase price of the asset","example":"1000.0000","format":"double","type":"number","x-is-money":true},"serialNumber":{"description":"The asset's serial number","example":"ca4c6b39-4f4f-43e8-98da-5e1f350a6694","type":"string"},"warrantyExpiryDate":{"description":"The date the asset’s warranty expires (if needed) YYYY-MM-DD","example":"ca4c6b39-4f4f-43e8-98da-5e1f350a6694","type":"string"}},"required":["assetName"],"type":"object"},"AssetStatus":{"description":"See Asset Status Codes.","enum":["Draft","Registered","Disposed"],"example":"Draft","type":"string"},"AssetStatusQueryParam":{"description":"See Asset Status Codes.","enum":["DRAFT","REGISTERED","DISPOSED"],"example":"DRAFT","type":"string"},"AssetType":{"properties":{"accumulatedDepreciationAccountId":{"description":"The account for accumulated depreciation of fixed assets of this type","example":"ca4c6b39-4f4f-43e8-98da-5e1f350a6694","format":"uuid","type":"string"},"assetTypeId":{"description":"Xero generated unique identifier for asset types","example":"5da209c5-5e19-4a43-b925-71b776c49ced","format":"uuid","type":"string"},"assetTypeName":{"description":"The name of the asset type","example":"Computer Equipment","type":"string"},"bookDepreciationSetting":{"$ref":"#/components/schemas/BookDepreciationSetting"},"depreciationExpenseAccountId":{"description":"The expense account for the depreciation of fixed assets of this type","example":"b23fc79b-d66b-44b0-a240-e138e086fcbc","format":"uuid","type":"string"},"fixedAssetAccountId":{"description":"The asset account for fixed assets of this type","example":"24e260f1-bfc4-4766-ad7f-8a8ce01de879","format":"uuid","type":"string"},"locks":{"description":"All asset types that have accumulated depreciation for any assets that use them are deemed ‘locked’ and cannot be removed.","example":33,"type":"integer"}},"required":["assetTypeName","bookDepreciationSetting"],"type":"object"},"Assets":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Asset"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object"},"BookDepreciationDetail":{"properties":{"costLimit":{"description":"The value of the asset you want to depreciate, if this is less than the cost of the asset.","example":9000,"format":"double","type":"number","x-is-money":true},"currentAccumDepreciationAmount":{"description":"All depreciation occurring in the current financial year.","example":5,"format":"double","type":"number","x-is-money":true},"currentCapitalGain":{"description":"When an asset is disposed, this will be the sell price minus the purchase price if a profit was made.","example":5.25,"format":"double","type":"number","x-is-money":true},"currentGainLoss":{"description":"When an asset is disposed, this will be the lowest one of sell price or purchase price, minus the current book value.","example":10.5,"format":"double","type":"number","x-is-money":true},"depreciationStartDate":{"description":"YYYY-MM-DD","example":"2025-04-15T13:51:57.237Z","format":"date","type":"string"},"priorAccumDepreciationAmount":{"description":"All depreciation prior to the current financial year.","example":0.45,"format":"double","type":"number","x-is-money":true},"residualValue":{"description":"The value of the asset remaining when you've fully depreciated it.","example":10000,"format":"double","type":"number","x-is-money":true}},"required":["name"]},"BookDepreciationSetting":{"properties":{"averagingMethod":{"description":"The method of averaging applied to this asset. See Averaging Methods","enum":["FullMonth","ActualDays"],"example":"ActualDays","type":"string"},"bookEffectiveDateOfChangeId":{"description":"Unique Xero identifier for the effective date change","example":"68f17094-af97-4f1b-b36b-013b45b6ad3c","format":"uuid","type":"string"},"depreciableObjectId":{"description":"Unique Xero identifier for the depreciable object","example":"68f17094-af97-4f1b-b36b-013b45b6ad3c","format":"uuid","type":"string"},"depreciableObjectType":{"description":"The type of asset object","example":"Asset","type":"string"},"depreciationCalculationMethod":{"description":"See Depreciation Calculation Methods","enum":["Rate","Life","None"],"example":"None","type":"string"},"depreciationMethod":{"description":"The method of depreciation applied to this asset. See Depreciation Methods","enum":["NoDepreciation","StraightLine","DiminishingValue100","DiminishingValue150","DiminishingValue200","FullDepreciation"],"example":"StraightLine","type":"string"},"depreciationRate":{"description":"The rate of depreciation (e.g. 0.05)","example":0.05,"format":"double","type":"number","x-is-money":true},"effectiveLifeYears":{"description":"Effective life of the asset in years (e.g. 5)","example":5,"type":"integer"}},"required":["name"]},"Error":{"externalDocs":{"url":"https://developer.xero.com/documentation/api/http-response-codes"},"properties":{"detail":{"description":"Detail of the error","type":"string"},"fieldValidationErrors":{"description":"Array of elements of field validation errors","items":{"$ref":"#/components/schemas/FieldValidationErrorsElement"},"type":"array"},"resourceValidationErrors":{"description":"Array of elements of resource validation errors","items":{"$ref":"#/components/schemas/ResourceValidationErrorsElement"},"type":"array"},"title":{"description":"Title of the error","type":"string"},"type":{"description":"The internal type of error, not accessible externally","type":"string"}},"type":"object"},"FieldValidationErrorsElement":{"externalDocs":{"url":"https://developer.xero.com/documentation/api/http-response-codes"},"properties":{"detail":{"description":"Detail of the field validation error","type":"string"},"fieldName":{"description":"The field name of the erroneous field","type":"string"},"localisedMessage":{"description":"Explanation of the field validation error","type":"string"},"title":{"description":"Title of the field validation error","type":"string"},"type":{"description":"Internal type of the field validation error message","type":"string"},"valueProvided":{"description":"The provided value","type":"string"}},"type":"object"},"Pagination":{"properties":{"itemCount":{"example":2,"type":"integer"},"page":{"example":1,"type":"integer"},"pageCount":{"example":1,"type":"integer"},"pageSize":{"example":10,"type":"integer"}}},"ResourceValidationErrorsElement":{"externalDocs":{"url":"https://developer.xero.com/documentation/api/http-response-codes"},"properties":{"detail":{"description":"Detail of the resource validation error","type":"string"},"localisedMessage":{"description":"Explanation of the resource validation error","type":"string"},"resourceName":{"description":"The field name of the erroneous field","type":"string"},"title":{"description":"Title of the resource validation error","type":"string"},"type":{"description":"Internal type of the resource error message","type":"string"}},"type":"object"},"Setting":{"properties":{"assetNumberPrefix":{"description":"The prefix used for fixed asset numbers (“FA-” by default)","example":"FA-","type":"string"},"assetNumberSequence":{"description":"The next available sequence number","example":"0022","type":"string"},"assetStartDate":{"description":"The date depreciation calculations started on registered fixed assets in Xero","example":"2025-04-15T13:51:57.237Z","format":"date","type":"string"},"defaultCapitalGainOnDisposalAccountId":{"description":"Default account that capital gains are posted to","example":"6d6a0bdb-e118-45d8-a023-2ad617ec1cb7","format":"uuid","type":"string"},"defaultGainOnDisposalAccountId":{"description":"Default account that gains are posted to","example":"346ddb97-739a-4274-b43b-66aa3218d17c","format":"uuid","type":"string"},"defaultLossOnDisposalAccountId":{"description":"Default account that losses are posted to","example":"1b798541-24e2-4855-9309-c023a0b576f3","format":"uuid","type":"string"},"lastDepreciationDate":{"description":"The last depreciation date","example":"2025-04-15T13:51:57.237Z","format":"date","type":"string"},"optInForTax":{"description":"opt in for tax calculation","example":false,"type":"boolean"}},"required":["name"],"type":"object"}},"securitySchemes":{"OAuth2":{"description":"For more information","flows":{"authorizationCode":{"authorizationUrl":"https://login.xero.com/identity/connect/authorize","scopes":{"assets":"Grant read-write access to fixed assets","assets.read":"Grant read-only access to fixed assets","email":"Grant read-only access to your email","openid":"Grant read-only access to your open id","profile":"your profile information"},"tokenUrl":"https://identity.xero.com/connect/token"}},"type":"oauth2"}}}}