CompanySettings

Represents global settings that affect multiple features in your organization.

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

This type extends Metadata and inherits its fields.

CompanySettings values are stored in a single file named Company.settings in the settings directory of the corresponding package directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Company Profile Settings are available in API version 27.0 and later.

• Type: boolean
• Required: Yes
• Introduced: API version 47.0
• Description: If a custom fiscal period is set up, this field is used to determine whether the custom fiscal period is used for forecasts. If true, the custom fiscal period is used. If false (default), standard periods are used.

• Type: FiscalYearSettings
• Required: No
• Description: The organization’s fiscal year setting based on year and start month. Not available if Custom Fiscal Year or Forecasts (Classic) is enabled. When changing fiscal year settings, quotas and adjustments can be purged. For example changing your start month results in purging this data.

Represents your organization’s fiscal year setting.

• Type: string (enumeration of type string)
• Required: No
• Description: This field is used to determine the fiscal year name. Valid values are endingMonth or startingMonth. For example, if your fiscal year starts in April 2012 and ends in March 2013, and this value is:
• Possible values:
  • endingMonth — , then 2013 is used for the fiscal year name.
  • startingMonth — , then 2012 is used for the fiscal year name.

• Type: string
• Required: No
• Description: The month on which the fiscal year is based.

• Type: string
• Required: No

• Type: string
• Required: No

A sample XML definition of a fiscal year setting is shown below. Note that this example is supported in API version 27.0 and later.

1<?xml version="1.0" encoding="UTF-8"?>
2<CompanySettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <fiscalYear>
4        <fiscalYearNameBasedOn>endingMonth</fiscalYearNameBasedOn>
5        <startMonth>January</startMonth>
6    </fiscalYear>
7</CompanySettings>

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.