Newer Version Available

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

CompanySettings

Represents global settings that affect multiple features in your organization.s

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

Declarative Metadata File Suffix and Directory Location

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 is only one settings file for each settings component.

Version

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

Fields

Field Name Field Type Description
fiscalYear FiscalYearSetting 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.

FiscalYearSetting

Represents your organization’s fiscal year setting.

Field Field Type Description
fiscalYearNameBasedOn string 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:
  • endingMonth, then 2013 is used for the fiscal year name.
  • startingMonth, then 2012 is used for the fiscal year name.
startMonth string The month on which the fiscal year is based.

Declarative Metadata Sample Definition — Fiscal Year Setting

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>