Newer Version Available

This content describes an older version of this product. View Latest

Asset

Represents an item of commercial value, such as a product sold by your company or a competitor, that a customer has purchased and installed.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
AccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
(Required) ID of the Account associated with this asset. Must be a valid account ID. Required if ContactId is not specified.
AssetLevel
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The asset’s position in an asset hierarchy. If the asset has no parent or child assets, its level is 1. Assets that belong to a hierarchy have a level of 1 for the root asset, 2 for the child assets of the root asset, 3 for their children, and so forth.

On assets created before the introduction of this field, the asset level defaults to –1. Once the asset record is updated, the asset level is calculated and automatically updated.

Note

AssetProvidedById
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The account that provided the asset, typically a manufacturer.
AssetServicedById
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The account in charge of servicing the asset.
Availability
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of expected uptime where the asset was available for use.
AverageUptimePerDay
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The average number of hours per day the asset is expected to be available for use.
ContactId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Required if AccountId is not specified. ID of the Contact associated with this asset. Must be a valid contact ID that has an account parent (but does not need to match the asset’s AccountId).
Description
Type
textarea
Properties
Create, Nillable, Update
Description
Description of the asset.
DigitalAssetStatus
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Status of digital tracking of the asset. The default picklist includes the following values:
  • On
  • Off
  • Warning
  • Error
ExternalIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the matching record in an external system. This field is available from API version 49.0 and later.
InstallDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Date when the asset was installed.
IsCompetitorProduct
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether this Asset represents a product sold by a competitor (true) or not (false). Default value is false. Its UI label is Competitor Asset.
IsInternal
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates that the asset is produced or used internally (true) or not (false). Default value is false. Its UI label is Internal Asset.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time that the asset was last modified. Its UI label is Last Modified Date.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time that the asset was last viewed.
LocationId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The asset’s location. Typically, this is the place where the asset is stored, such as a warehouse or van.
ManufactureDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the asset was manufactured. This field is available from API version 49.0 and later.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
(Required) Name of the asset. Label is Asset Name.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The asset’s owner. By default, the asset owner is the user who created the asset record. Its UI label is Asset Owner.
ParentId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The asset’s parent asset. Its UI label is Parent Asset.
Price
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Price paid for this asset.
Product2Id
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
(Optional) ID of the Product2 associated with this asset. Must be a valid Product2 ID. Its UI label is Product.
ProductCode
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The product code of the related product.
ProductDescription
Type
string
Properties
Filter, Sort, Nillable
Description
The product description of the related product.
ProductFamily
Type
picklist
Properties
Filter, Group, Sort, Nillable
Description
The product family of the related product.
PurchaseDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Date on which this asset was purchased.
Quantity
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Quantity purchased or installed.
Reliability
Type
percent
Properties
Filter, Nillable, Sort
Description
The percentage of expected uptime where the asset wasn’t subject to unplanned downtime.
RootAssetId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
(Read only) The top-level asset in an asset hierarchy. Depending on where an asset lies in the hierarchy, its root could be the same as its parent. Its UI label is Root Asset.
SerialNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Serial number for this asset.
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Customizable picklist of values. The default picklist includes the following values:
  • Purchased
  • Shipped
  • Installed
  • Registered
  • Obsolete
StatusReason
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The explanation of the device status. This field is available from API version 49.0 and later.
Possible values are:
  • Not Ready
  • Off
  • Offline
  • Online
  • Paused
  • Standby
StockKeepingUnit
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The SKU assigned to the related product.
SumDowntime
Type
double
Properties
Filter, Nillable, Sort
Description
Accumulated downtime (planned and unplanned), determined as follows:
  • When only UptimeRecordStart is set, the sum of all downtime from UptimeRecordStart.
  • When UptimeRecordStart and UptimeRecordEnd are set, the sum of all downtime from UptimeRecordStart to UptimeRecordEnd.
Otherwise, downtime is not accumulated.
SumUnplannedDowntime
Type
double
Properties
Filter, Nillable, Sort
Description
Accumulated unplanned downtime, determined as follows:
  • When only UptimeRecordStart is set, the sum of all unplanned downtime from UptimeRecordStart.
  • When UptimeRecordStart and UptimeRecordEnd are set, the sum of all unplanned downtime from UptimeRecordStart to UptimeRecordEnd.
Otherwise, unplanned downtime is not accumulated.
UptimeRecordEnd
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date that SumDowntime and SumUnplannedDowntime are accumulated until.
UptimeRecordStart
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date from which SumDowntime and SumUnplannedDowntime are accumulated.
UsageEndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Date when usage for this asset ends or expires.
Uuid
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unique ID for the asset. This field is available from API version 49.0 and later.

Usage

Use this object to track products sold to customers. With asset tracking, a client application can quickly determine which products were previously sold or are currently installed at a specific account. You can also create hierarchies of up to 10,000 assets.

For example, your organization might want to renew and up-sell opportunities on products sold in the past. Similarly, your organization might want to track competitive products that exist in a customer environment that could potentially be replaced or swapped out.

Asset tracking is also useful for product support, providing detailed information to assist with product-specific support issues. For example, the PurchaseDate or SerialNumber could indicate whether a given product has certain maintenance requirements, including product recalls. Similarly, the UsageEndDate might indicate when the asset was removed from service or when a license or warranty expires.

If an application creates a new Asset record, it must specify a Name and either an AccountId, ContactId, or both.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

AssetFeed
Feed tracking is available for the object.
AssetHistory
History is available for tracked fields of the object.
AssetOwnerSharingRule
Sharing rules are available for the object.
AssetShare
Sharing is available for the object.