Versions Compared

Old Version 6

changes.mady.by.user Mickey Bushman

Saved on

compared with

New Version Current

changes.mady.by.user Jason Andrew

Saved on

Key

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

The Service Contract object contains properties related to a service contract/extended warranty for an asset or a part. 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:


Service Contract Object Formats


Excerpt


Code Block
languagejs
titleJSON Format
linenumberstrue
collapsetrue
{
	"_t" : "serviceContract",
	"_v" : "1.0",
	"BillToAccountNum": "",
	"ConcessionID": "",
	"Constraints": {
		"ExcludeOrderTypes": ["", ""],
		"IncludeOrderTypes": ["", ""],
		"ExcludeServiceCodes": [["", ""], ["", ""]],
		"IncludeServiceCodes": [["", ""], ["", ""]]
	},
	"ContactNumber": "",
	"ContractID": "",
	"ContractProvider": "",
	"CopayRules": {
		"AuthorizationNumPattern": "",
		"IsHiddenIsAuthorizationNumReq": falsetrue,
		"RulesIsSerialNumReq": {true,
		"AuthorizationNumPatternSerialNumPattern": ""
	},
		"IsAuthorizationNumReqWarranty": true,{
		"IsSerialNumReqInWarranty": true,
		"SerialNumPatternCopay": ""
	}
}



Service Contract Object Properties

(info)(info) Required properties are in bold.

PropertyTypeDescription
BillToAccountNumstringThis properly identifies the party who is responsible for paying for the service.
ConcessionIDstring

Identifies concession associated with a service contract. The concession will be applied to the work order when mobile worker adds service contract in the work order process.

Status
title3.49.0

Constraints

object

This property contains various criteria definition for service contract eligibility.

PropertyTypeDescription
ExcludeOrderTypescollectionA collection of order types to exclude for a service contract
IncludeOrderTypescollectionA collection of order types to include for service contract eligibility
ExcludeServiceCodescollection

A collection of service codes to exclude for a service contract

Note: A service code is a collection of strings, so this object is a collection of collections

IncludeServiceCodescollection

A collection of service codes to include for service contract eligibility

Note: A service code is a collection of strings, so this object is a collection of collections


Info

The property will contain exclude OR include criteria for order types and service codes. Include and exclude criteria are mutually exclusive and cannot appear at the same time in the object for order types and service codes.


ContactNumberstringThe phone number for the service contract administrator.
ContractIDstringThis property uniquely identifies the service contract.
ContractProviderstringThis property identifies the name of service contract administrator.Copaystring

Product number to be added to the work order as type co-pay

Status
title3.49.0

IsHiddenboolean

This property identifies if service contract is hidden from selection drop down box in mobile application.

Valid values are:

  • true - The application will hide service contract from selection drop down.
  • false - Service contract is visible in selection drop down box. This is the default value if the property is not present.

Status
title4.3.0

Rulesobject

This property contains rules (flags) that control different aspects of the service contract process.

PropertyTypeDescription
AuthorizationNumPatternstringRegular expression for authorization number validation
IsAuthorizationNumReqboolean

Identifies if the authorization number is required from a service contract administrator

Default value is false

IsSerialNumReqboolean

Identifies if the asset serial number is required for service contract process.

Default value is false

SerialNumPatternstringRegular expression for serial number validation


Warrantyobject

This property contains warranty information for a service contract to be applied to the work order.

PropertyTypeDescription
InWarrantyboolean

Default value is false

Identifies if the service contract controlled asset or part is under warranty. 

Copaystring

Product number to be added to the work order as type co-pay