Asset

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

Introduced in API version 5.0.

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

  • 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 isn’t specified.

    This field is a relationship field.

  • Relationship name: Account

  • Relationship type: relationship

  • Refers to: Account

  • Type: address
  • Properties: Filter, Nillable
  • Introduced: API version 55.0
  • Description: Represents the physical address or geolocation of the asset.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 40.0
  • 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. After the asset record is updated, the asset level is calculated and automatically updated.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 40.0

  • Description:

    The account that provided the asset, typically a manufacturer.

    This field is a relationship field.

  • Relationship name: AssetProvidedBy

  • Relationship type: relationship

  • Refers to: Account

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 40.0

  • Description:

    The account in charge of servicing the asset.

    This field is a relationship field.

  • Relationship name: AssetServicedBy

  • Relationship type: relationship

  • Refers to: Account

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 65.0
  • Type: percent
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: The percentage of expected uptime where the asset was available for use.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: The average number of hours per day the asset is expected to be available for use.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The city detail for the address.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 53.0
  • Description: The business impact associated with the asset’s failure. Using this field, you can address the asset’s health and take action using Flows. To enable this field, use Object Manager to update the field availability. Make sure that the field is visible for field-level security and for page layout. To learn more, see What Determines Field Access. The picklist values aren’t predefined in orgs created before Winter ’22 that aren’t Field Service enabled.
  • Possible values:
    • Insignificant — Insignificant
    • Minor — Minor
    • Moderate — Moderate
    • Major — Major
    • Critical — Critical

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    Required if AccountId isn’t specified. ID of the Contact associated with this asset. Must be a valid contact ID that has an account parent (but doesn’t need to match the asset’s AccountId).

    This field is a relationship field.

  • Relationship name: Contact

  • Relationship type: relationship

  • Refers to: Contact

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The country detail for the address.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: Reserved for future use. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: Represents the end of the period shown as current. System-populated field inherited from the end date of the current asset state period. If that field is empty, as with an evergreen subscription, the Current Lifecycle End Date field is also empty. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: The asset’s monthly recurring revenue during the current asset state period. System-populated field inherited from the monthly recurring revenue on the current asset state period. If no asset state period is current, the value is 0. Label is Current Monthly Recurring Revenue. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: The asset’s quantity during the current asset state period. System-populated field inherited from the quantity on the current asset state period. If no asset state period is current, the value is 0. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Description of the asset.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 48.0
  • Description: Status of digital tracking of the asset. The default picklist includes the following values:
  • Possible values:
    • On — On
    • Off — Off
    • Warning — Warning
    • Error — Error

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 64.0

  • Default value: false

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: The ID of the matching record in an external system.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Accuracy level of the geocode for the address.

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 50.0

  • Description:

    True if this asset is a lifecycle-managed asset, otherwise false. You can’t switch an asset to a lifecycle-managed asset or the reverse. This field is system populated.

    The default value is false. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled.

  • Default value: false

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 61.0
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Date when the asset was installed.
  • 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). The default value is false. Its UI label is Competitor Asset.
  • Default value: false
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 40.0
  • Description: Indicates that the asset is produced or used internally (true) or not (false). The default value is false. Its UI label is Internal Asset.
  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 67.0

  • Default value: false

  • Type: double
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Used with Longitude to specify the precise geolocation of the address.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: Represents the end of the asset’s lifecycle. System-populated field inherited from the end date of the final asset state period. If that field is empty, as with an evergreen subscription, the lifecycle has no end date. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: Represents the beginning of the asset’s lifecycle. System-populated field inherited from the start date of the earliest asset state period. This field can’t be edited. When a new asset action affects the start date of an asset state period, the period is deleted and a new one is generated. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 39.0

  • Description:

    The asset’s location. Typically, this location is the place where the asset is stored, such as a warehouse or van.

    If you have access to the location entity, it doesn’t necessarily mean you can access the location id field. To access the location, you must have userHasLocation user access.

  • Relationship name: Location

  • Relationship type: relationship

  • Refers to: Location

  • Type: double
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Used with Latitude to specify the precise geolocation of the address.
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: The date when the asset was manufactured.
  • Type: double
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 59.0
  • Type: double
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 59.0
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: (Required) Name of the asset. Label is Asset Name.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 36.0

  • Description:

    The asset’s parent asset. Its UI label is Parent Asset.

    This field is a relationship field.

  • Relationship name: Parent

  • Relationship type: relationship

  • Refers to: Asset

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The postal code for the address.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Price paid for this asset.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 60.0
  • Description: Pricing source to use when amending or renewing an asset.
  • Possible values:
    • LastTransaction — LastTransaction — Last Transaction
    • PriceBookListPrice — PriceBookListPrice — Price Book or List Price

  • 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.

    This field is a relationship field.

  • Relationship name: Product2

  • Relationship type: relationship

  • Refers to: Product2

  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 41.0
  • Description: The product code of the related product.
  • Type: string
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 45.0
  • Description: The product description of the related product.
  • Type: picklist
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 45.0
  • Description: The product family of the related product.

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 67.0

  • Relationship name: ProductItem

  • Relationship type: relationship

  • Refers to: ProductItem

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Date on which this asset was purchased.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Quantity purchased or installed. The Quantity field value isn’t set by Customer Asset Lifecycle Management. Instead, you can populate the field as you need.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 56.0
  • Description: Specify which pricing type to use when the quantity of this asset is increased. Its UI label is Pricing Type for Quantity Increase. This field is available when Revenue Cloud is enabled.
  • Possible values:
    • LastNegotiatedPrice — LastNegotiatedPrice — Available in API version 58.0 and later.
    • ListPrice — ListPrice
  • Type: percent
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: The percentage of expected uptime where the asset wasn’t subject to unplanned downtime.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 55.0
  • Description: The price used when renewing a subscription. Its UI label is Pricing Type for Renewal. This field is available when Revenue Cloud is enabled.
  • Possible values:
    • LastNegotiatedPrice — LastNegotiatedPrice
    • ListPrice — ListPrice
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 55.0
  • Description: With Renewal Term Unit, defines the default subscription term for renewal quotes. This field is available when Revenue Cloud is enabled.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 55.0
  • Description: The unit of time for a subscription term. This field is available when Revenue Cloud is enabled.
  • Possible values:
    • Annual — Annual — Available in API version 58.0 and later. —UI label is Years.
    • Months — Months

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 36.0

  • Relationship name: RootAsset

  • Relationship type: relationship

  • Refers to: Asset

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 60.0

  • Description:

    ID of the RetailStore or WebStore associated with this Asset.

    This field is a polymorphic relationship field.

    To access this field, your org must have a Salesforce Order Management license or a B2B Commerce License.

    This field is available in API v60.0 and later.

  • Relationship name: SalesStore

  • Relationship type: polymorphic

  • Refers to: RetailStore, WebStore

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Serial number for this asset.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The state detail for the address.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Customizable picklist of values. The default picklist includes the following values:
  • Possible values:
    • Purchased — Purchased
    • Shipped — Shipped
    • Installed — Installed
    • Registered — Registered
    • Obsolete — Obsolete
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 65.0
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: The explanation of the device status.
  • Possible values:
    • Not Ready — Not Ready
    • Off — Off
    • Offline — Offline
    • Online — Online
    • Paused — Paused
    • Standby — Standby
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 41.0
  • Description: The SKU assigned to the related product.
  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The street detail for the address.

  • Type: double

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 49.0

  • 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 isn’t accumulated.

  • Type: double

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 49.0

  • 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 isn’t accumulated.

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 51.0
  • Description: The total amount of revenue for the asset, including revenue from each stage in the asset lifecycle. This field is available when CPQ Plus, Salesforce Billing, or Revenue Cloud is enabled.
  • Type: percent
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 64.0
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: The date until which SumDowntime and SumUnplannedDowntime are accumulated.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: The date from which SumDowntime and SumUnplannedDowntime are accumulated.
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Date when usage for this asset ends or expires.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 49.0
  • Description: The unique ID for the asset.

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, suppose that your company wants to renew and upsell opportunities on products sold in the past. Similarly, your company can track competitive products in a customer environment where products can 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 can indicate whether a given product has certain maintenance requirements, including product recalls. Similarly, the UsageEndDate can indicate when the asset was removed from service or when a license or warranty expires.

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

With REST API, use the getRelatedListInfo function to get information about related lists on the asset. Note that when requesting information about PrimaryAssets, the response is labeled Related Assets, and the response for RelatedAssets is labeled Primary Assets.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.