ContractType

A contract type is used to group contracts so that they exhibit similar characteristics. For example, the lifecycle states, the people who access, the templates and clauses used. This type extends the Metadata metadata type and inherits its fullName field.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ContractType components have the suffix .contractType and are stored in the contractTypes folder.

Version

ContractType components are available in API version 54.0 and later.

Special Access Rules

Fields

contractTypeConfigs

Type: ContractTypeConfig[]

Description: A list of configurations for the Contract Type.

isDefault

Type: boolean

Description: Indicates whether this contract type is a default for the org. Default value is False.

masterLabel

Type: string

Description: Required. The name of the setting.

subTypes

Type: string

Description: List of subtypes for the contract object associated with this contract type.

ContractTypeConfig

Specific configuration settings defined for a Contract Type that control characteristics and behavior of all contracts of that type.

configType

Type: ContractConfigType (enumeration of type string)

Description: Required.

Indicates the name of the configuration setting. Possible value are:

Append0ToAutoNbrEmbeddedSect
AsyncCheckInEnabled
AutoGenDocOnContractUpdate
AutoGenDocOnContractCreation
AutoGenerateDocFileType
CheckInDocFileType
CreateDocSectionsDocxTemplates
CompareContractVersionsEnabled
ContractSignatureDeclinedSts
ContractDocumentDownloadOption
ContractSignatureExpiredStatus
ContractSignatureVoidedStatus
ContractSignedStatus
DefaultTemplateName
DocuSignAccountBrand
DocuSignUseAccountDefaultNtfcn
DocuSignExpiresAfter
DocuSignExpireEnabled
DocumentFileNameFormat
DocuSignExpireWarning
DocuSignReminderDelayinDays
DocuSignReminderEnabled
DocuSignReminderFrequency
DocumentTemplateFilterClass
EmailNotificationOnDocumentGeneration
ImportTargetContractStatus
InclWordTrackChgSectionContent
InclWordTrackChgReconciliation
NotifyDocTemplateVerChgStatus
PrivateExternalReviewCompletionSite
TrackContractRedlines
WordTrackChangesDisplayColor

configValue

Type: string

Description: Required.

Indicates the value of the configuration setting specified in the Configuration Name field.

usageType

Type: ContractUsageType (enumeration of type string)

Description: The usage type to which this setting belongs. Possible value are DocumentSetting, Reconciliation, Redlining, or SignatureSetting

Declarative Metadata Sample Definition

The following is an example of a ContractType component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ContractType xmlns="http://soap.sforce.com/2006/04/metadata">
3    <masterLabel>New_ContractType</masterLabel>
4    <isDefault>true</isDefault>
5    <subTypes>RecordTypeName1</subTypes>
6</ContractType>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>ContractType</name>
6    </types>
7    <types>
8        <members>Contract.RecordTypeName1</members>
9        <name>RecordType</name>
10    </types>
11    <version>54.0</version>
12</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.