Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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.

 

Service Contract Object Formats

JSON Format
{
	"_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

(info) Required properties are in bold.

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

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

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

  • No labels