CurrencySettings

Represents an organization’s currency settings, including supporting multiple currencies and currency effective dates. This type extends the Metadata metadata type and inherits its fullName field.

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

CurrencySettings values are stored in the Currency.settings file 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

CurrencySettings is available in API version 47.0 and later.

Fields

Field Name	Field Type	Description
enableCurrencyEffectiveDates	boolean	Indicates whether effective dated currency is enabled (`true`) or not (`false`). This field has a default value of `false`. To enable this preference, enableMultiCurrency must be set to `true`
enableCurrencySymbolWithMultiCurrency	boolean	Indicates whether the currency symbol (`true`) or ISO code (`false`) displays in multi-currency orgs. This field has a default value of `false`. This field has no effect if enableMultiCurrency is set to `false`.
enableMultiCurrency	boolean	Indicates whether multiple currencies are enabled (`true`) or not (`false`). This field has a default value of `false`. Once set to `true`, this field can’t be set to `false`. See Considerations for Enabling Multiple Currencies for more information. Note
isMultiCurrencyActivationAllowed	boolean	Deprecated in API version 49.0 and later. Regardless of the value in this field, a Salesforce admin can activate multiple currencies. In API version 48.0 and earlier, if Customizable Forecasting was enabled, this field indicated whether Salesforce Customer Support could activate multiple currencies (`true`) or the feature couldn't be activated (`false`). This field is only visible if multiple currencies are disabled. It has a default of `false` to provide an extra layer of protection against accidentally enabling multiple currencies when Customizable Forecasting was enabled. In API version 48.0 and earlier, customers with Customizable Forecasting enabled in their orgs had to contact Salesforce Customer Support to activate multiple currencies. Customers set this field to `true` when Salesforce Customer Support requested that they do so to validate their request to activate multiple currencies. Customizable Forecasting was retired in Summer ’20. Users can’t access the Customizable Forecasting feature and its underlying data via the user interface or API. To predict sales revenue and quantities from your opportunity pipeline, use Collaborative Forecasts. Note
isParenCurrencyConvDisabled	boolean	Indicates whether parenthetical currency conversion is disabled (`true`) or enabled (`false`). This field has a default value of `true`. When this field is set to `false`, Salesforce displays converted currency amounts to users whose personal currency differs from the currency of the record they’re viewing.

Declarative Metadata Sample Definition

The following is an example of a CurrencySettings file.

1<?xml version="1.0" encoding="UTF-8"?>
2<CurrencySettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableCurrencyEffectiveDates>false</enableCurrencyEffectiveDates>
4    <enableCurrencySymbolWithMultiCurrency>false</enableCurrencySymbolWithMultiCurrency>
5    <enableMultiCurrency>false</enableMultiCurrency>
6    <isMultiCurrencyActivationAllowed>false</isMultiCurrencyActivationAllowed>
7    <isParenCurrencyConvDisabled>false</isParenCurrencyConvDisabled>
8</CurrencySettings>

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>Currency</members>
5        <name>Settings</name>
6    </types>
7    <version>47.0</version>
8</Package>

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.

Metadata API Developer Guide