Salesforce Contracts

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Salesforce Contracts
Salesforce Contracts Standard Objects
Apex Reference
Salesforce Contracts Resources
Salesforce Contracts Metadata API Types
ClauseCatgConfiguration
ContractType
ESignatureConfig
ESignatureEnvelopeConfig
ExternalDocStorageConfig
PDF

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

Field Name Field Type Description
contractTypeConfigs ContractTypeConfig[] A list of configurations for the Contract Type.
isDefault boolean Indicates whether this contract type is a default for the org. Default value is False.
masterLabel string Required. The name of the setting.
subTypes string 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.

Field Name Description
configType
Field Type
ContractConfigType (enumeration of type string)
Description
Required.
Indicates the name of the configuration setting.
Possible value are:
  • Append0ToAutoNbrEmbeddedSect
  • 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
Field Type
string
Description
Required.
Indicates the value of the configuration setting specified in the Configuration Name field.
usageType
Field Type
ContractUsageType (enumeration of type string)
Description
The usage type to which this setting belongs.
Possible value are:
  • DocumentSetting
  • Reconciliation
  • Redlining
  • SignatureSetting

Declarative Metadata Sample Definition

The following is an example of a ContractType component.

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

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

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>*</members>
        <name>ContractType</name>
    </types>
    <types>
        <members>Contract.RecordTypeName1</members>
        <name>RecordType</name>
    </types>
    <version>54.0</version>
</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.