Skip to main content

Currency

This model represents currency.

PropertyTypeDescriptionInformation
idintCurrency identifierISO 4217 alpha code unique for single currency. Read-only.
namestringLocalized name of currencyRead-only.
decimal_placesintNumber of decimal placesNumber of decimal places currency uses. Number between 0 and 3. Read-only.
numeric_codeint or nullCurrency numeric codeISO 4217 numeric code unique for single currency. Read-only.
symbolstring or nullCurrency symbolSymbol of the currency. String between 1 and 5 characters (or null). Read-only.
is_activeboolActive stateInactive currencies are not shown nor required on input.
is_defaultboolDefault stateDefault currency is used as fallback currency.
created_atDateTimeCurrency creation date and timeRead-only.

Example:

{
"id": "USD",
"name": "United States dollar",
"decimal_places": 2,
"numeric_code": null,
"symbol": "$",
"is_active": true,
"is_default": false,
"created_at": "2019-08-07 14:33:46"
}