REST Object Definitions Configuration Related Objects Service Contract Object

Service Contract Object Formats

JSON Format

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

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.

ConcessionID

string

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.

3.49.0

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

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.

Copay

string

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

3.49.0

IsHidden

boolean

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.

4.3.0

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