Zoho: Specific Currency

← Currencies operations · Get started

Operation zoho.getcurrencybyid

Provider route: GET /crm/v8/org/currencies/{currency}. 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"]["getCurrencyById"]>[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.getCurrencyById(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.get_currency_by_id(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.currency	string	Required within parent	Maximum length: 255

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
$	JSON	Root
$ (anyOf 1)	object	Alternative	Currency response object. Additional keys: not allowed
$ (anyOf 1).currencies	array	Required within parent	JSON array containing the requested currency object. Maximum items: 1
$ (anyOf 1).currencies[]	object	Each item	JSON object with currency formatting, exchange info and settings. Additional keys: not allowed
$ (anyOf 1).currencies[].created_by	object	Required within parent	User who created the currency record. Additional keys: not allowed
$ (anyOf 1).currencies[].created_by.id	string	Required within parent	The unique identifier of the user who created the currency record. Format: int64 Maximum length: 255
$ (anyOf 1).currencies[].created_by.name	string	Required within parent	Name of the user who created this currency. Maximum length: 255
$ (anyOf 1).currencies[].created_time	string	Required within parent	Timestamp when the currency was initially created. Format: date-time
$ (anyOf 1).currencies[].exchange_rate	string	Required within parent	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: 18 Pattern: ^[0-9]{1,9}(.[0-9]{1,9})?$
$ (anyOf 1).currencies[].exchange_rate_auto_update	boolean	Optional	Indicates whether the currency has the automated exchange rate option enabled or not.
$ (anyOf 1).currencies[].exchange_rate_updated_time	string	Optional	Timestamp when the exchange rate was last modified. Format: date-time
$ (anyOf 1).currencies[].format	object	Required within parent	Represents the format of the base currency with details like decimal_separator, thousand_separator, and decimal_places. Additional keys: not allowed
$ (anyOf 1).currencies[].format.decimal_places	string	Required within parent	Represents the number of decimal places allowed for the currency. It can be 0, 2, and 3. Known values: 0, 2, 3, 4, 5, 6
$ (anyOf 1).currencies[].format.decimal_separator	string	Required within parent	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. Known values: Comma, Period
$ (anyOf 1).currencies[].format.numeral_system	string	Required within parent	Numeral grouping system used for formatting. Known values: Indian, International Default: International
$ (anyOf 1).currencies[].format.thousand_separator	string	Required within parent	The thousand separator separates groups of thousands in a currency. It can be a Period, Comma, or Space, depending on the currency. Known values: Comma, Period, Space
$ (anyOf 1).currencies[].id	string	Required within parent	Unique ID associated with this currency. Format: int64 Maximum length: 255
$ (anyOf 1).currencies[].is_active	boolean	Required within parent	Indicates whether the currency is active and available for use.
$ (anyOf 1).currencies[].is_base	boolean	Required within parent	Indicates whether this is the base currency of the organization.
$ (anyOf 1).currencies[].iso_code	string	Required within parent	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
$ (anyOf 1).currencies[].modified_by	object	Required within parent	User who last modified the currency record. Additional keys: not allowed
$ (anyOf 1).currencies[].modified_by.id	string	Required within parent	The unique identifier of the user who last modified the currency record. Format: int64 Maximum length: 255
$ (anyOf 1).currencies[].modified_by.name	string	Required within parent	Name of the user who last updated this currency. Maximum length: 255
$ (anyOf 1).currencies[].modified_time	string	Required within parent	Timestamp when the currency was last modified. Format: date-time
$ (anyOf 1).currencies[].name	string	Required within parent	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
$ (anyOf 1).currencies[].prefix_symbol	boolean	Required within parent	Represents the position of the currency symbol. Possible Values: true - Display the currency symbol before the currency value. This is the default value. false - Display the currency symbol after the currency value.
$ (anyOf 1).currencies[].symbol	string	Required within parent	Indicates the currency symbol used for display. Maximum length: 50
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: zoho.getcurrencybyid. Catalog operation: getCurrencyById. 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.

No-content response statuses: [204]

Official provider source