Zoho: Update base currency

← Currencies operations · Get started

Operation zoho.updatebasecurrency

Provider route: PUT /crm/v8/org/currencies/actions/enable. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["currencies"]["updateBaseCurrency"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.currencies.updateBaseCurrency(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.currencies.update_base_currency(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Required within parent	Payload for modifying existing base currency. Additional keys: not allowed
body.base_currency	object	Required within parent	JSON object containing the updated base currency values. Additional keys: not allowed
body.base_currency.exchange_rate	string	Optional	Represents the rate at which the currency has to be exchanged with home currency. Accepts positive decimal numbers up to nine digits and nine decimal places. Example: 123456789.123456789. Maximum length: 50 Pattern: ^[0-9]{1,9}(.[0-9]{1,9})?$
body.base_currency.format	object	Optional	Represents the format of the base currency with details like decimal_separator, thousand_separator, and decimal_places. Additional keys: not allowed
body.base_currency.format.decimal_places	string	Optional	Represents the number of decimal places allowed for the currency. It can be 0, 2, and 3. One of: 0, 2, 3, 4, 5, 6
body.base_currency.format.decimal_separator	string	Optional	The decimal separator separates the integer part of the currency from its fractional part. It can be a Period or Comma, depending on the currency. One of: Comma, Period
body.base_currency.format.numeral_system	string	Optional	Numbering system used for grouping digits. Default: International One of: Indian, International
body.base_currency.format.thousand_separator	string	Optional	The thousand separator separates groups of thousands in a currency. It can be a Period, Comma, or Space, depending on the currency. One of: Comma, Period, Space Maximum length: 255
body.base_currency.id	string	Required within parent	The unique identifier of the currency. Format: int64 Maximum length: 255
body.base_currency.iso_code	string	Optional	Represents the ISO code of the currency. You can get the currency code from the CRM UI at Setup > General > Company Settings > Currencies. Maximum length: 3
body.base_currency.name	string	Optional	Represents the name of the currency. You can get the available currencies from the CRM UI at Setup > General > Company Settings > Currencies. Maximum length: 255
body.base_currency.symbol	string	Optional	Represents the symbol of the currency. Maximum length: 50

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root	Successful update response Additional keys: not allowed
base_currency	object	Required within parent	Result of base currency update Additional keys: not allowed
base_currency.code	string	Required within parent	Indicating the code of the result. Maximum length: 50
base_currency.details	object	Required within parent	Additional details of the response. Additional keys: not allowed
base_currency.details.id	string	Optional	The unique identifier of the base currency created. Format: int64 Maximum length: 255
base_currency.message	string	Required within parent	Message describing the operation result. Maximum length: 255
base_currency.status	string	Required within parent	Represents the status of the operation. Maximum length: 50

Policy, approvals and errors

SDK function policy ID: zoho.updatebasecurrency. Catalog operation: updateBaseCurrency. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source