Currency (Iso 4217) in ESG data model(Currency)

Base entity from which all Industry Data Model entities are derived.

Traits

Traits for this entity are listed here.

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"4.3"	string	semantic version number of the entity

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Base entity from which all Industry Data Model entities are derived. en The definition of Currency is based upon the ISO 4217 standard. ISO 4217 is the international standard describing three letter codes (also known as the currency code) to define the names of currencies established by the International Organization for Standardization (ISO). The first two letters of the code are the two letters of ISO 3166-1 alpha-2 country codes (which are similar to those used for national top-level domains on the Internet) and the third is usually the initial of the currency itself. So Japan's currency code becomes JPY-JP for Japan and Y for yen. This eliminates the problem caused by the names dollar, franc and pound being used in dozens of different countries, each having significantly differing values. Also, if a currency is revalued, the currency code's last letter is changed to distinguish it from the old currency. In some cases, the third letter is the initial for "new" in that country's language, to distinguish it from an older currency that was revalued; the code often long outlasts the usage of the term "new" itself. Examples of this include the Mexican peso (MXN) and the Turkish lira (TRY). Other changes can be seen, however; the Russian ruble, for example, changed from RUR to RUB, where the B comes from the third letter in the word "ruble". There's also a three-digit code number assigned to each currency, in the same manner as There's also a three-digit code number assigned to each country as part of ISO 3166. This numeric code is usually the same as the ISO 3166 numeric code. For example, USD (US Dollar) has code 840 which is also the numeric code for US (United States). The standard also defines the relationship between the major currency unit and any minor currency unit. Often, the minor currency unit has a value that is 1/100 of the major unit, but 1/10 or 1/1000 are also common. Some currencies do not have any minor currency unit at all. In others, the major currency unit has so little value that the minor unIt's no longer generally used (e.g. the Japanese sen, 1/100th of a yen). Mauritania does not use a decimal division of units, setting 1 ouguiya (UM) = 5 khoums, and Madagascar has 1 ariary = 5 iraimbilanja. This is indicated in the standard by the currency exponent. For example USD has exponent 2, while JPY has exponent 0. ISO 4217 includes codes not only for currencies, but also for precious metals (gold, silver, palladium and platinum; by definition expressed per one troy ounce, as compared to "1 USD") and certain other entities used in international finance, e.g. Special Drawing Rights. There are also special codes allocated for testing purposes (XTS), and to indicate no currency transactions (XXX). These codes all begin with the letter "X". The precious metals use "X" plus the metal's chemical symbol; silver, for example, is XAG. ISO 3166 never assigns country codes beginning with "X" while these codes are assigned for privately customized use only (reserved, never for official codes), so ISO 4217 can use "X" codes for non-country-specific currencies without risk of clashing with future country codes. This is a list of global currencies and the three-character currency codes that we have found are generally used to represent them. In most cases, the currency code is composed of the country's two-character Internet country code plus an extra character to denote the currency unit. For example, the code for Canadian Dollars is simply Canada's two-character Internet code ("CA") plus a one-character currency designator ("D"). ISO 4217 (Codes for the Representation of Currencies and Funds) defines three-letter abbreviations for world currencies. The general principle used to construct these abbreviations is to take the two-letter abbreviations defined in ISO 3166 (Codes for the Representation of Names of Countries) and append the first letter of the currency name (e.g., USD for the United States In the case of currencies defined by supra-national entities, ISO 4217 assigns two-letter entity codes starting with "X" to use in place of country codes (e.g., XCD for the Central Caribbean Dollar). The following are examples: USD America (United States of America), Dollars AUD Australia, Dollars CAD Canada, Dollars	entity	a reference to the constant entity holding the list of localized text

is.identifiedBy
Names a specific identity attribute to use with an entity.

Parameter	Value	Data type	Explanation
attribute	Currency/(resolvedAttributes)/IsoCurrencyCode	attribute

minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.

Parameter	Value	Data type	Explanation
versionNumber	"1.2.3"	string

is.IDM.modelVersion
Semantic version number of the IDM.

Parameter	Value	Data type	Explanation
versionNumber	"1.6.0"	string

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{0CC398B3-9569-4BB0-934F-4BFE0D5CB1F5}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nativeTo.businessArea
The name of the business area from which the entity originates.

Parameter	Value	Data type	Explanation
name	"Accounting & Financial Reporting"	string

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Currency (Iso 4217)	entity	a reference to the constant entity holding the list of localized text

has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides or restates parts of logical schemas to produce one resolved schema.

Parameter	Value	Data type	Explanation
level	"resolved"	string	Possible values: logical, composition, resolved

Attributes

Name	Description	First Included in Instance
IsoCurrencyCode	The ISO 4217 currency code.	Currency
CurrencyName	The name of the currency.	Currency
CountryId	The unique identifier of the Country.	Currency
CurrencySymbol	The symbol associated with the currency.	Currency

IsoCurrencyCode

The ISO 4217 currency code.
First included in: Currency (this entity)

Properties

Name	Value
displayName	ISO Currency Code
description	The ISO 4217 currency code.
isPrimaryKey	true
dataFormat	string
maximumLength	3

Traits

List of traits for the IsoCurrencyCode attribute are listed here.

is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

is.identifiedBy
Names a specific identity attribute to use with an entity.

Parameter	Value	Data type	Explanation
attribute	Currency/(resolvedAttributes)/IsoCurrencyCode	attribute

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{03C4F1F8-C966-4BA7-A63E-9D0F32B643E7}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en ISO Currency Code	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The ISO 4217 currency code.	entity	a reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

Parameter	Value	Data type	Explanation
maximumLength	"3"	integer

is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

CurrencyName

The name of the currency.
First included in: Currency (this entity)

Properties

Name	Value
displayName	Currency Name
description	The name of the currency.
dataFormat	string
maximumLength	256
isNullable	true

Traits

List of traits for the CurrencyName attribute are listed here.

is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{062E6348-440F-46FE-A8C7-9BD23CAAF02F}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Currency Name	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The name of the currency.	entity	a reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

Parameter	Value	Data type	Explanation
maximumLength	"256"	integer

is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

CountryId

The unique identifier of the Country.
First included in: Currency (this entity)

Properties

Name	Value
displayName	Country ID
description	The unique identifier of the Country.
dataFormat	int32
isNullable	true

Traits

List of traits for the CountryId attribute are listed here.

is.dataFormat.integer
is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Country ID	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The unique identifier of the Country.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference Country.cdm.json/Country CountryId	entity	a reference to the constant entity holding the list of entity references

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{077E23E2-D28F-45CF-B796-B16F21B8B4AF}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.dataFormat.integer

CurrencySymbol

The symbol associated with the currency.
First included in: Currency (this entity)

Properties

Name	Value
displayName	Currency Symbol
description	The symbol associated with the currency.
dataFormat	binary
isNullable	true

Traits

List of traits for the CurrencySymbol attribute are listed here.

is.dataFormat.byte
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

Parameter	Value	Data type	Explanation
identifier	"{091ABACE-FE88-4C8A-8C26-8DF27B2AE3E7}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Currency Symbol	entity	a reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The symbol associated with the currency.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.byte
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.