Add New Currencies

Purpose

To add new currencies to your organization.

Request URL

https://www.zohoapis.com/crm/v2/org/currencies

Request Method

POST

Scope

scope=ZohoCRM.settings.currencies.{operation_type}

Possible operation types
CREATE - Create currencies

Request JSON

AttributeData TypeMandatoryDescription
decimal_separatorStringYesThe decimal separator separates the integer part of the currency from its fractional part. It can be a Period or Comma, depending on the currency.
thousand_separatorStringYesThe thousand separator separates groups of thousands in a currency. It can be a Period, Comma, or Space, depending on the currency.
decimal_placesIntegerYesRepresents the number of decimal places allowed for the currency. It can be 0, 2, or 3.
prefix_symbolBooleanNoRepresents the position of the ISO code in the currency.
true: Display ISO code before the currency value.
false: Display ISO code after the currency value.
nameStringYesRepresents the name of the currency.
iso_codeStringYesRepresents the ISO code of the currency.
symbolStringYesRepresents the symbol of the currency.
exchange_rateStringYesRepresents the rate at which the currency has to be exchanged for home currency.
is_activeBooleanNoRepresents the status of the currency.
true: The currency is active.
false: The currency is inactive.

Possible Errors

HTTP StatusError CodeMessageReason
404INVALID_URL_PATTERNPlease check if the URL trying to access is a correct one.The request URL has syntactical errors.
400ACTIVE_STATE_LIMIT_EXCEEDEDAllowed active currency limit 10 reached. Please deactivate any one of the existing active currencies to create this currency You already have ten active currencies.
400INVALID_DATACurrency name is invalidYou have specified an invalid currency name. Go to setup> Company Details> Under Currencies tab> Click Add> The Currency picklist will have valid currency names and ISO codes.
400INVALID_DATAISO code is invalidYou have specified an invalid ISO code. Go to setup> Company Details> Under Currencies tab> Click Add> The Currency picklist will have valid currency names and ISO codes.
400INVALID_DATACurrency symbol is invalid.You have specified an invalid currency symbol.
400DUPLICATE_DATADuplicate value given for \"Isocode\" parameter.The currency specified in the input JSON is already present. Even if the status of the currency is inactive, it will still be present in the list.
403FEATURE_NOT_SUPPORTEDThe multi-currency feature is not available except the Enterprise and higher editions.The multi-currency feature is only available in Enterprise and Ultimate editions.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v2/org/currencies"
-X POST
-d input.json
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Sample Input

Copied{
  "currencies": [
    {
      "format": {
        "decimal_separator": "Period",
        "thousand_separator": "Comma",
        "decimal_places": "2"
      },
      "prefix_symbol": true,
      "name": "Saudi Riyal",
      "iso_code": "SAR",
      "symbol": "SR",
      "exchange_rate": "1.0000000",
      "is_active": true
    }
  ]
}

Sample Response

Copied{
    "currencies": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "4150868000000780026"
            },
            "message": "The currency created successfully.",
            "status": "success"
        }
    ]
}