Page Comparison

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

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

Service Contract Object Formats

Excerpt

Code Block

language	js
title	JSON Format
linenumbers	true
collapse	true

{
	"_t" : "serviceContract",
	"_v" : "1.0",
	"BillToAccountNum": "",
	"Constraints": {
		"ExcludeOrderTypes": ["", ""],
		"IncludeOrderTypes": ["", ""],
		"ExcludeServiceCodes": [["", ""], ["", ""]],
		"IncludeServiceCodes": [["", ""], ["", ""]]
	},
	"ContactNumber": "",
	"ContractID": "",
	"ContractProvider": "",
	"Rules": {
		"AuthorizationNumPattern": "",
		"IsAuthorizationNumReq": true,
		"IsSerialNumReq": true,
		"SerialNumPattern": ""
	},
	"Warranty": {
		"InWarranty": true,
		"Copay": ""
	}
}

Service Contract Object Properties

Required properties are in bold.

Property Type Description

BillToAccountNum string This properly identifies the party who is responsible for paying for the service.

Constraints

object

This property contains various criteria definition for service contract eligibility.

Property	Type	Description
ExcludeOrderTypes	collection	A collection of order types to exclude for a service contract
IncludeOrderTypes	collection	A collection of order types to include for service contract eligibility
ExcludeServiceCodes	collection	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
IncludeServiceCodes	collection	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.

ContactNumber string The phone number for the service contract administrator.

ContractID string This property uniquely identifies the service contract.

ContractProvider string This property identifies the name of service contract administrator.

Rules

object

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

Property	Type	Description
AuthorizationNumPattern	string	Regular expression for authorization number validation
IsAuthorizationNumReq	boolean	Identifies if the authorization number is required from a service contract administrator Default value is `false`
IsSerialNumReq	boolean	Identifies if the asset serial number is required for service contract process. Default value is `false`
SerialNumPattern	string	Regular expression for serial number validation

Warranty

object

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

Property Type Description

InWarranty

boolean

Default value is false

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

Copay

string

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

Versions Compared

Old Version 4

New Version Current

Key

Service Contract Object Formats

Service Contract Object Properties