---
schema_version: "1"
id: 841e2bda1a9e38cfe5ff4e7340255d41918e88d7980fd9ae62e1cf6613e9ab5a
title: CurrencySettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_currencysettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_currencysettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 3ffc10db8936788c002d43aeade321429f46d5b15392d45496d2765528febddd
description: Represents an organization's currency settings, including turning on multiple currencies, configuring active currencies, setting the corporate currency, and enabling currency effective dates. This type extends the Metadata metadata type and inherits its fullName field.
---
# CurrencySettings

Represents an organization's currency settings, including turning on multiple currencies, configuring active currencies, setting the corporate currency, and enabling 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for 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. The corporateCurrency and currency fields, and the deploy behavior for enableMultiCurrency, are available in API version 68.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d298341e112">Field Name</th>

              <th class="featureTableHeader  " id="d298341e115">Field Type</th>

              <th class="featureTableHeader  " id="d298341e118">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d298341e112" data-title="Field Name"><span class="keyword parmname">corporateCurrency</span></td>

              <td class="entry" headers="d298341e115" data-title="Field Type">string</td>

              <td class="entry" headers="d298341e118" data-title="Description">The ISO 4217 code of the org's corporate currency, such as <samp class="codeph nolang">USD</samp> or <samp class="codeph nolang">EUR</samp>. The
                corporate currency's conversion rate is fixed at <samp class="codeph nolang">1.0</samp>; all other currencies are denominated against it. Setting this field
                in a deploy switches the org's corporate currency, which demotes the previously
                corporate currency and rebases conversion rates. The new corporate currency must
                already be registered in the org and be active. Has no effect unless
                <span class="keyword parmname">enableMultiCurrency</span> is <samp class="codeph nolang">true</samp>, either previously or in the same deploy. Available in API version
                68.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d298341e112" data-title="Field Name"><span class="keyword parmname">currency</span></td>

              <td class="entry" headers="d298341e115" data-title="Field Type">Currency[]</td>

              <td class="entry" headers="d298341e118" data-title="Description">One or more currency entries. New currencies are inserted; entries that match
                an existing currency by <span class="keyword parmname">isoCode</span> update its
                <span class="keyword parmname">active</span>, <span class="keyword parmname">scale</span>, and
                <span class="keyword parmname">conversionRate</span> values. Has no effect unless
                <span class="keyword parmname">enableMultiCurrency</span> is <samp class="codeph nolang">true</samp>, either previously or in the same deploy. See <a class="xref" href="#currency_subtype">Currency
                  Fields</a>. Available in API version 68.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d298341e112" data-title="Field Name"><span class="keyword parmname">enableCurrencyEffectiveDates</span></td>

              <td class="entry" headers="d298341e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d298341e118" data-title="Description">Indicates whether effective dated currency is enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">false</samp>. To enable this preference,
                <span class="keyword parmname">enableMultiCurrency</span> must be set to <samp class="codeph nolang">true</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d298341e112" data-title="Field Name"><span class="keyword parmname">enableCurrencySymbolWithMultiCurrency</span></td>

              <td class="entry" headers="d298341e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d298341e118" data-title="Description">Indicates whether the currency symbol (<samp class="codeph nolang">true</samp>) or ISO code (<samp class="codeph nolang">false</samp>) displays
                in multi-currency orgs. This field has a default value of <samp class="codeph nolang">false</samp>. This field has no effect if
                <span class="keyword parmname">enableMultiCurrency</span> is set to <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d298341e112" data-title="Field Name"><span class="ph" id="enableMultiCurrency"><a name="enableMultiCurrency"><!-- --></a><span class="keyword parmname">enableMultiCurrency</span></span></td>

              <td class="entry" headers="d298341e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d298341e118" data-title="Description">Indicates whether multiple currencies are enabled (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). This field
                has a default value of <samp class="codeph nolang">false</samp>. Starting in API
                version 68.0, deploying <samp class="codeph nolang">true</samp> against an org
                that doesn't have multi-currency enabled turns on multi-currency for the org.
                Deploying <samp class="codeph nolang">true</samp> against an org that already has
                multi-currency enabled is a no-op. When multi-currency is turned on, the corporate
                currency is taken from <span class="keyword parmname">corporateCurrency</span> if provided in the
                same deploy; otherwise it defaults to the org's locale-derived currency. <div class="box message confirm">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png" alt="Important">
                        <div class="mediaBd">
                          <h4 class="mbs">Important</h4>
                          <p>Turning on multi-currency is irreversible. After you deploy
                            <samp class="codeph nolang">enableMultiCurrency=true</samp>, the org can't
                            return to single-currency operation through Metadata API. Deploying <samp class="codeph nolang">enableMultiCurrency=false</samp> against an org that has
                            multi-currency enabled returns an error. See <a class="xref" href="https://help.salesforce.com/articleView?id=admin_enable_multicurrency_implications.htm&amp;language=en_US" target="_blank">Considerations for Enabling Multiple
                              Currencies</a> for more information.
                          </p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d298341e112" data-title="Field Name"><span class="keyword parmname">isMultiCurrencyActivationAllowed</span></td>

              <td class="entry" headers="d298341e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d298341e118" data-title="Description">Deprecated in API version 49.0 and later. Regardless of the value in this
                field, a Salesforce admin can activate multiple currencies.<p class="p">In API version 48.0
                  and earlier, if Customizable Forecasting was enabled, this field indicated whether
                  Salesforce Customer Support could activate multiple currencies (<samp class="codeph nolang">true</samp>) or the feature couldn't be activated (<samp class="codeph nolang">false</samp>).</p>
                <div class="p">This field is only visible if
                  multiple currencies are disabled. It has a default of <samp class="codeph nolang">false</samp> 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 <samp class="codeph nolang">true</samp> when
                  Salesforce Customer Support requested that they do so to validate their request to
                  activate multiple currencies.<div class="box message info">
                    <div class="inner">
                      <div class="bd">
                        <div class="media">
                          <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                          <div class="mediaBd">
                            <h4 class="mbs">Note</h4>
                            <p>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 Salesforce Forecasting.</p>
                          </div>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d298341e112" data-title="Field Name"><span class="keyword parmname">isParenCurrencyConvDisabled</span></td>

              <td class="entry" headers="d298341e115" data-title="Field Type">boolean</td>

              <td class="entry" headers="d298341e118" data-title="Description">Indicates whether parenthetical currency conversion is disabled (<samp class="codeph nolang">true</samp>) or enabled (<samp class="codeph nolang">false</samp>). This field has a default value of <samp class="codeph nolang">true</samp>. When this field is set to <samp class="codeph nolang">false</samp>, Salesforce displays converted currency amounts to users whose
                personal currency differs from the currency of the record they're viewing.</td>

            </tr>

          </tbody>

        </table>

## Currency Fields

Represents one entry in the org's currency type list. Used as the element type of the CurrencySettings.currency collection. Available in API version 68.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| active | boolean | Indicates whether this currency is available for users to assign to records (true) or not (false). Inactive currencies can't be set as the corporate currency. Defaults to true for new currencies. Optional. |
| conversionRate | double | The conversion rate from this currency to the corporate currency. Must be 1.0 if this entry is the corporate currency. Required for new currencies. |
| isoCode | string | The currency's ISO 4217 code, such as USD, JPY, or EUR. The code must be one of the ISO codes that Salesforce supports; an unsupported code returns an error. Required. |
| scale | int | The number of decimal places to use for this currency. Valid values are 0 through 6. Optional. |

## Declarative Metadata Sample Definition

The following is an example of a CurrencySettings file that turns on multi-currency and seeds two currencies.

<?xml version="1.0" encoding="UTF-8"?>
<CurrencySettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableMultiCurrency\>true</enableMultiCurrency\>
    <corporateCurrency\>USD</corporateCurrency\>
    <currency\>
        <isoCode\>USD</isoCode\>
        <active\>true</active\>
        <conversionRate\>1.0</conversionRate\>
        <scale\>2</scale\>
    </currency\>
    <currency\>
        <isoCode\>JPY</isoCode\>
        <active\>true</active\>
        <conversionRate\>110.0</conversionRate\>
        <scale\>0</scale\>
    </currency\>
    <enableCurrencyEffectiveDates\>false</enableCurrencyEffectiveDates\>
    <enableCurrencySymbolWithMultiCurrency\>false</enableCurrencySymbolWithMultiCurrency\>
    <isParenCurrencyConvDisabled\>false</isParenCurrencyConvDisabled\>
</CurrencySettings\>

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\>Currency</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).