Page Comparison

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

borderColor	grey
bgColor	whitesmoke

On this page:

Table of Contents

maxLevel	2

Related pages:

REST Object Definitions Work Order Activity Related Objects Work Order Object

Asset Object Formats

Include Page

	Asset Object Formats
	Asset Object Formats

Asset Object Properties

Required properties are in bold.

Property Type Description

AccountNum string When 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.

AssetNum string This property uniquely identifies the asset and can be composed of alpha, numerics, and most special characters.

AssetSubType string This property is for future use and currently is not used.

Cost

number

Identifies the purchase price for the asset

Status

title	4.16.0

Desc string Contains a brief description of the asset.

FlexAttrs

object

Include Page

	_def_FlexAttrs
	_def_FlexAttrs

FlexForm

object

Include Page

	_def_FlexForms
	_def_FlexForms

(3.12)

FlexFormsDisplayValues

object

Include Page

	_def_FlexFormsDisplayValues
	_def_FlexFormsDisplayValues

Status

title	4.14.0

FlexView

object

Include Page

	_def_FlexViews
	_def_FlexViews

History

object

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.

Property Type Description

FlexView

object

Include Page

	_def_FlexViews
	_def_FlexViews

Items

collection

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

Notes

collection

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.

OrderDate datetime The UTC date and time when the work order was created.

OrderNum string The order number associated with the work order.

OrderType string Contains a Work Order Types System Category value identifying the type of work order.

InServiceDate datetime The UTC date and time when the asset was originally placed in service.

IsComponent

boolean

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

LastServiceDate datetime The UTC date and time when the asset was last serviced

Location string An open text field that can be used by the customer to describe the physical location of where the asset was installed.

LocationNum string When 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.

Mfg string Identifies the manufacture of the asset.

Model string Identifies the manufacture's model number of the asset.

ProdNum string Optionally identifies a corresponding item in the product catalog.

SerialNum

RetailerID

string

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

Status

title	4.16.0

RetailerName

string

Identifies

the serial number of the asset.DescstringContains a brief description

a business selling asset to the consumer

Status

title	4.16.0

SerialNum

string

Identifies the serial number of the asset.

Status

string

Contains an Asset Status Codes system category value identifying the current state of the asset.

ServiceCodes

object

Include Page

	_def_ServiceCodes
	_def_ServiceCodes

ServiceCodesDesc

collection

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

title	3.33.0

Type

string

Contains an

REST System Categories

Asset Types system category value identifying the type of asset.

VerificationAPI

object

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.

Property

Type

Description

IsVerified

boolean

Identifies if the mobile worker verified asset information.

Valid values are:

false = Asset verification failed
true = Mobile worker verified asset

VerificationDate

datetime

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

Status

title	3.35.0

VerificationQR

object

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.

Property

Type

Description

IsVerified

boolean

Identifies if the mobile worker verified asset information.

Valid values are:

false = Asset verification failed
true = Mobile worker verified asset

VerificationDate

datetime

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

Status

title	3.35.0

Delete

boolean

Optional property.

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

Versions Compared

Old Version 13

New Version Current

Key

Asset Object Formats

Asset Object Properties