> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho CRM: README

> Get currency by ID. Zoho CRM Currencies Get Currency By Id reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Get currency by ID.

<Info>
  Tool ID: `zoho_crm_currencies_get_currency_by_id`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_currencies_get_currency_by_id',
  {
    "currency": "example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute zoho_crm_currencies_get_currency_by_id --input '{
  "currency": "example"
}' --json
```

## Example response

The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get zoho_crm_currencies_get_currency_by_id --json` for the complete live contract.

## Input reference

Retrieves details of a specific currency via its unique currency ID.

| Name               | Type     | Required | Default | Details                                                          |
| ------------------ | -------- | -------- | ------- | ---------------------------------------------------------------- |
| `payload.currency` | `string` | Yes      | —       | Path parameter identifying the currency ID. Maximum length: 255. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves details of a specific currency via its unique currency ID.",
    "properties": {
      "currency": {
        "type": "string",
        "description": "Path parameter identifying the currency ID.",
        "maxLength": 255
      }
    },
    "required": [
      "currency"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                                  | Type                                     | Required | Default | Details                                                                                                                      |
| ----------------------------------------------------- | ---------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `result.data`                                         | `object`                                 | Yes      | —       | Currency response object.                                                                                                    |
| `result.data.currencies`                              | `array`                                  | Yes      | —       | Array containing the requested currency object. Maximum items: 1.                                                            |
| `result.data.currencies[].prefix_symbol`              | `boolean`                                | Yes      | —       | If true, the currency symbol appears before the numerical value.                                                             |
| `result.data.currencies[].format`                     | `object`                                 | Yes      | —       | Defines how the currency value is displayed including separators and numeral system.                                         |
| `result.data.currencies[].format.numeral_system`      | `"Indian" \| "International"`            | Yes      | —       | Numeral grouping system used for formatting. Allowed: `Indian`, `International`.                                             |
| `result.data.currencies[].format.decimal_places`      | `"0" \| "2" \| "3" \| "4" \| "5" \| "6"` | Yes      | —       | Number of digits shown after decimal point. Allowed: `0`, `2`, `3`, `4`, `5`, `6`.                                           |
| `result.data.currencies[].format.decimal_separator`   | `"Comma" \| "Period"`                    | Yes      | —       | Character used as decimal separator. Allowed: `Comma`, `Period`.                                                             |
| `result.data.currencies[].format.thousand_separator`  | `"Comma" \| "Period" \| "Space"`         | Yes      | —       | Character used for grouping thousand digits. Allowed: `Comma`, `Period`, `Space`.                                            |
| `result.data.currencies[].exchange_rate`              | `string`                                 | Yes      | —       | Exchange rate relative to the base currency. Maximum length: 18. Pattern: `^[0-9]&#123;1,9&#125;(\.[0-9]&#123;1,9&#125;)?$`. |
| `result.data.currencies[].is_active`                  | `boolean`                                | Yes      | —       | Indicates whether the currency is currently active.                                                                          |
| `result.data.currencies[].exchange_rate_auto_update`  | `boolean`                                | No       | —       | Indicates whether the currency has the automated exchange rate option enabled or not.                                        |
| `result.data.currencies[].iso_code`                   | `string`                                 | Yes      | —       | Official ISO currency code. Maximum length: 3.                                                                               |
| `result.data.currencies[].symbol`                     | `string`                                 | Yes      | —       | Symbol representing the currency. Maximum length: 50.                                                                        |
| `result.data.currencies[].name`                       | `string`                                 | Yes      | —       | Full currency name. Maximum length: 255.                                                                                     |
| `result.data.currencies[].is_base`                    | `boolean`                                | Yes      | —       | Indicates whether this is the base currency of the organization.                                                             |
| `result.data.currencies[].id`                         | `string`                                 | Yes      | —       | Unique ID associated with this currency. Maximum length: 255.                                                                |
| `result.data.currencies[].created_by`                 | `object`                                 | Yes      | —       | User who created the currency record.                                                                                        |
| `result.data.currencies[].created_by.name`            | `string`                                 | Yes      | —       | Name of the user who created this currency. Maximum length: 255.                                                             |
| `result.data.currencies[].created_by.id`              | `string`                                 | Yes      | —       | User ID of the creator. Maximum length: 255.                                                                                 |
| `result.data.currencies[].modified_by`                | `object`                                 | Yes      | —       | User who last modified the currency record.                                                                                  |
| `result.data.currencies[].modified_by.name`           | `string`                                 | Yes      | —       | Name of the user who last updated this currency. Maximum length: 255.                                                        |
| `result.data.currencies[].modified_by.id`             | `string`                                 | Yes      | —       | User ID of the last modifier. Maximum length: 255.                                                                           |
| `result.data.currencies[].modified_time`              | `string`                                 | Yes      | —       | Timestamp when the currency was last modified. Format: `date-time`.                                                          |
| `result.data.currencies[].created_time`               | `string`                                 | Yes      | —       | Timestamp when the currency was initially created. Format: `date-time`.                                                      |
| `result.data.currencies[].exchange_rate_updated_time` | `string`                                 | No       | —       | Timestamp when the exchange rate was last modified. Format: `date-time`.                                                     |
| `result.meta`                                         | `object`                                 | No       | —       | Additional response metadata (status, paging).                                                                               |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Currency response object.",
        "properties": {
          "currencies": {
            "type": "array",
            "description": "Array containing the requested currency object.",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Currency object with formatting, exchange info and settings.",
              "properties": {
                "prefix_symbol": {
                  "type": "boolean",
                  "description": "If true, the currency symbol appears before the numerical value."
                },
                "format": {
                  "type": "object",
                  "description": "Defines how the currency value is displayed including separators and numeral system.",
                  "properties": {
                    "numeral_system": {
                      "type": "string",
                      "description": "Numeral grouping system used for formatting.",
                      "enum": [
                        "Indian",
                        "International"
                      ]
                    },
                    "decimal_places": {
                      "type": "string",
                      "description": "Number of digits shown after decimal point.",
                      "enum": [
                        "0",
                        "2",
                        "3",
                        "4",
                        "5",
                        "6"
                      ]
                    },
                    "decimal_separator": {
                      "type": "string",
                      "description": "Character used as decimal separator.",
                      "enum": [
                        "Comma",
                        "Period"
                      ]
                    },
                    "thousand_separator": {
                      "type": "string",
                      "description": "Character used for grouping thousand digits.",
                      "enum": [
                        "Comma",
                        "Period",
                        "Space"
                      ]
                    }
                  },
                  "required": [
                    "numeral_system",
                    "decimal_places",
                    "decimal_separator",
                    "thousand_separator"
                  ],
                  "additionalProperties": false
                },
                "exchange_rate": {
                  "type": "string",
                  "description": "Exchange rate relative to the base currency.",
                  "maxLength": 18,
                  "pattern": "^[0-9]{1,9}(\\.[0-9]{1,9})?$"
                },
                "is_active": {
                  "type": "boolean",
                  "description": "Indicates whether the currency is currently active."
                },
                "exchange_rate_auto_update": {
                  "type": "boolean",
                  "description": "Indicates whether the currency has the automated exchange rate option enabled or not."
                },
                "iso_code": {
                  "type": "string",
                  "description": "Official ISO currency code.",
                  "maxLength": 3
                },
                "symbol": {
                  "type": "string",
                  "description": "Symbol representing the currency.",
                  "maxLength": 50
                },
                "name": {
                  "type": "string",
                  "description": "Full currency name.",
                  "maxLength": 255
                },
                "is_base": {
                  "type": "boolean",
                  "description": "Indicates whether this is the base currency of the organization."
                },
                "id": {
                  "type": "string",
                  "description": "Unique ID associated with this currency.",
                  "maxLength": 255
                },
                "created_by": {
                  "type": "object",
                  "description": "User who created the currency record.",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Name of the user who created this currency.",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "User ID of the creator.",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "name",
                    "id"
                  ],
                  "additionalProperties": false
                },
                "modified_by": {
                  "type": "object",
                  "description": "User who last modified the currency record.",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Name of the user who last updated this currency.",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "User ID of the last modifier.",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "name",
                    "id"
                  ],
                  "additionalProperties": false
                },
                "modified_time": {
                  "type": "string",
                  "description": "Timestamp when the currency was last modified.",
                  "format": "date-time"
                },
                "created_time": {
                  "type": "string",
                  "description": "Timestamp when the currency was initially created.",
                  "format": "date-time"
                },
                "exchange_rate_updated_time": {
                  "type": "string",
                  "description": "Timestamp when the exchange rate was last modified.",
                  "format": "date-time"
                }
              },
              "required": [
                "prefix_symbol",
                "format",
                "exchange_rate",
                "is_active",
                "iso_code",
                "symbol",
                "name",
                "is_base",
                "id",
                "created_by",
                "modified_by",
                "modified_time",
                "created_time"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "currencies"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)
