# Interface: CurrencySchema

Defined in: [schema.ts:436](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L436)

A schema representing a return value or object property that is an amount of currency.

## Extends

- `BaseNumberSchema`\<[`Currency`](../../enumerations/ValueHintType/#currency)>

## Properties

### codaType

> **codaType**: [`Currency`](../../enumerations/ValueHintType/#currency)

Defined in: [schema.ts:438](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L438)

Instructs Coda to render this value as a currency amount.

#### Overrides

`BaseNumberSchema.codaType`

______________________________________________________________________

### currencyCode?

> `optional` **currencyCode**: `string`

Defined in: [schema.ts:445](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L445)

A three-letter ISO 4217 currency code, e.g. USD or EUR. If the currency code is not supported by Coda, the value will be rendered using USD.

______________________________________________________________________

### description?

> `optional` **description**: `string`

Defined in: [schema.ts:285](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L285)

A explanation of this object schema property shown to the user in the UI.

If your pack has an object schema with many properties, it may be useful to explain the purpose or contents of any property that is not self-evident.

#### Inherited from

`BaseNumberSchema.description`

______________________________________________________________________

### format?

> `optional` **format**: [`CurrencyFormat`](../../enumerations/CurrencyFormat/)

Defined in: [schema.ts:447](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L447)

A render format for further refining how the value is rendered.

______________________________________________________________________

### precision?

> `optional` **precision**: `number`

Defined in: [schema.ts:440](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L440)

The decimal precision. The value is rounded to this precision when rendered.

______________________________________________________________________

### type

> **type**: [`Number`](../../enumerations/ValueType/#number)

Defined in: [schema.ts:314](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L314)

Identifies this schema as relating to a number value.

#### Inherited from

`BaseNumberSchema.type`