Newer Version Available

This content describes an older version of this product. View Latest

ContractSettings

Represents contract settings. For more information, see “Set Up Contracts” in the Salesforce online help.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for more details.

File Suffix and Directory Location

There is one contract settings file stored in a file named Contract.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version

ContractSettings is available in API version 27.0 and later.

Fields

Field Name Field Type Description
autoCalculateEndDate boolean Indicates whether the end date of a contract is automatically calculated (true) or not (false).
notifyOwnersOnContractExpiration boolean Indicates whether account and contract owners are automatically sent email notifications when a contract expires (true) or not (false).

Declarative Metadata Sample Definition

This is a sample contract settings file.

1<?xml version="1.0" encoding="UTF-8"?>
2<ContractSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <autoCalculateEndDate>true</autoCalculateEndDate>
4    <notifyOwnersOnContractExpiration>false</notifyOwnersOnContractExpiration>
5</ContractSettings>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.