GET /Assets

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

Servers

Request headers

Name Type Required Description
xero-tenant-id String Yes

Xero identifier for Tenant

Query parameters

Name Type Required Description
page Integer No

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

sortDirection String No

ASC or DESC

Valid values:

  • "desc"
  • "asc"
orderBy String No

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

Valid values:

  • "AssetType"
  • "PurchasePrice"
  • "AssetName"
  • "AssetNumber"
  • "DisposalDate"
  • "PurchaseDate"
  • "DisposalPrice"
filterBy String No

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.

status String Yes

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

Valid values:

  • "DISPOSED"
  • "REGISTERED"
  • "DRAFT"
pageSize Integer No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.