Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Asset object contains properties related to a specific asset. An asset is specifically tracked piece of equipment usually located as a customer location.



Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2

Related pages:


Asset Object Formats

Include Page
Asset Object Formats
Asset Object Formats

Asset Object Properties

(info) Required properties are in bold.

PropertyTypeDescription
AccountNumstringWhen the asset is associated with an Account Location, the AccountNum field represents the ID of the associated Account. When set, the LocationNum field must also be set.
AssetNumstringThis property uniquely identifies the asset and can be composed of alpha, numerics, and most special characters.
AssetSubTypestring(warning) This property is for future use and currently is not used.
Costnumber

Identifies the purchase price for the asset

Status
title4.16.0

DescstringContains a brief description of the asset.
FlexAttrsobject

Include Page
_def_FlexAttrs
_def_FlexAttrs

FlexFormobject

Include Page
_def_FlexForms
_def_FlexForms

(3.12)

FlexFormsDisplayValuesobject

Include Page
_def_FlexFormsDisplayValues
_def_FlexFormsDisplayValues

Status
title4.14.0

FlexViewobject

Include Page
_def_FlexViews
_def_FlexViews

Historyobject

An optional property in which it is possible to store one or more collections, containing service history details for the asset. When used, each item in the collection should be used to store details of a work order.

Alternatively, instead of adding service history information to the Asset object, the Asset Service History REST API Interface can optionally be used, allowing ServiceMobility to obtain the service history data for assets from a 3rd party system containing the relevant details. 

PropertyTypeDescription
FlexViewobject
Include Page
_def_FlexViews
_def_FlexViews
Itemscollection

The Items collection contains line item details for the work order. Line items include parts used, parts returned, travel codes, labor codes, etc. Line items are grouped based on the line item type identified by the ProdAttrs.ProdType property.

See: Item Object

Notescollection

The Notes object contains an optional collection of notes associated with the work order. These can be recorded by anyone involved with taking and booking the work order. Notes are internal and not meant to be displayed to the Customer

OrderDatedatetimeThe UTC date and time when the work order was created.
OrderNumstringThe order number associated with the work order.
OrderTypestringContains a Work Order Types System Category value identifying the type of work order.


InServiceDatedatetimeThe UTC date and time when the asset was originally placed in service.
IsComponentboolean

Identifies if this asset is a component of another asset.

Valid values are:

  • true = This asset is considered a component of another asset
  • false = This asset is not a component of another asset
LastServiceDatedatetimeThe UTC date and time when the asset was last serviced
LocationstringAn open text field that can be used by the customer to describe the physical location of where the asset was installed.
LocationNumstringWhen the asset is associated with an Account Location, the LocationNum field represents the ID of the associated Location. When set, the AccountNum field must also be set.
MfgstringIdentifies the manufacture of the asset.
ModelstringIdentifies the manufacture's model number of the asset.
ProdNumstringOptionally identifies a corresponding item in the product catalog.
SerialNumRetailerIDstring

This property indicates identifier for a business selling asset to the consumer

Status
title4.16.0

RetailerNamestring

Identifies

the serial number of the asset.
DescstringContains a brief description

a business selling asset to the consumer

Status
title4.16.0

SerialNumstringIdentifies the serial number of the asset.
StatusstringContains an Asset Status Codes system category value identifying the current state of the asset.
ServiceCodesobject
Include Page
_def_ServiceCodes
_def_ServiceCodes
ServiceCodesDesccollection

This optional collection contains the description for service codes.

The order the descriptions appear in the array are the order mobile worker has selected service codes in the mobile application.

Status
title3.33.0
TypestringContains an REST System Categories Asset Types system category value identifying the type of asset.
VerificationAPIobject

Captures response of Asset's Model Number Verification in Work Order process. Mobile worker can verify asset installed at the account location when Rules.CanVerifyAsset is true in Work Order Object.

PropertyTypeDescription
IsVerifiedboolean

Identifies if the mobile worker verified asset information.

Valid values are:

  • false = Asset verification failed
  • true = Mobile worker verified asset

VerificationDate

datetimeThe date and time, in UTC format, when the asset verification was attempted.

Status
title3.35.0

VerificationQRobject

Captures response of Asset Verification by scanning QR code in Work Order process. Mobile worker can verify asset installed at the account location when rules Rules.CanVerifyAsset is true and Rules.CanScanQRCode is true in Work Order Object.

PropertyTypeDescription
IsVerifiedboolean

Identifies if the mobile worker verified asset information.

Valid values are:

  • false = Asset verification failed
  • true = Mobile worker verified asset

VerificationDate

datetimeThe date and time, in UTC format, when the asset verification was attempted.

Status
title3.35.0

Deleteboolean

Optional property.

This property is used during a PATCH request to remove specific items. This property will never be returned during a GET request.