Actions

Ontolog Forum

Revision as of 05:54, 9 January 2016 by imported>KennethBaclawski (Fix PurpleMediaWiki references)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

CCTRepAmount

01-000 Amount. Type

01-000 Amount. Type is a Core Component Type (CCT) and represents a number of monetary units specified in a currency where the unit of currency is explicit or implied. The content component is Amount. Content and contains the value of the Amount. Type CCT. To indicate the currency identifier and the version of the currency identifier, the CCT specification defines two supplementary components, Amount Currency. Identifier and Amount Currency. Code List. Version .

Amount

The following diagram shows one possible mapping between the Amount core component type and classes in the SUMO.

amount.jpg

Example: Amount. Type

For a Core Component Type of Amount. Type , the Content Component carries the value of 12. This value has no semantic meaning on its own. But 12 EUR, where EUR is the Supplementary Component that gives essential extra definition to the Content Component, does have meaning.

[[[ScottLHolmes]]] This example differs from the technical specification of CCT 2.01 in that the proper three character code (EUR) as defined in the Amount. Currency. Identifier is used here, whereas the technical specification uses the term Euro which is not a valid reference.

Given a UBL Invoice instance document, a typical element that uses the Amount. Type CCT is PriceAmount which is defined in the UBL to be of type PriceAmountType which is an extension of sdt:UBLAmountType . UBLAmountType is a Specialized Data Type in the UBL that is essentially a representation of the CCT Amount. Type. Note that in version 1.0 of the UBL, the attribute amountCurrencyCodeListVersionID is fixed at "0.3".

<PriceAmount

xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-1.0"

amountCurrencyID="EUR"

amountCurrencyCodeListVersionID="0.3">

12

</PriceAmount>

OC: Amount

PT: Type

Amount. Type Map to SUMO CurrencyMeasure

CCT Amount. Type maps to a SUMO CurrencyMeasure expressed using MeasureFn in the second argument being a RealNumber with the first argument being an instance UnitOfMeasure and subclass of CurrencyMeasure. The resulting CurrencyMeasure can be related to a thing with the relation monetaryValue

01-001 Amount. Content

01-001 Amount. Content is a Content Component that represents a number of monetary units specified in a currency where the unit of currency is explicit or implied. This is a decimal number.

PDT: decimal

Amount. Content Map to SUMO RealNumber

CCT Amount. Content maps to a SUMO RealNumber part of an expression using MeasureFn.

01-002 Amount Currency. Code List Version. Identifier

01-002 Amount Currency. Code List Version. Identifier is a supplementary component that represents the version of the UN/ECE Rec.9 code list. If not used, the latest version code list is assumed.

[[[ScottLHolmes]]] As this list is maintained in a Microsoft Access database, finding an accurate version is currently a challenge. The PDF document for Rec 9 is marked ECE/TRADE/203 [Edition 96.1] which could be the version but Rec 9 does not specifically mark it as such.

PDT: string

Amount Currency. Code List Version to SUMO uniqueIdentifier

Amount Currency. Code List Version maps to a SUMO SymbolicString that is related to a UnitOfMeasure part of a subclass of CurrencyMeasure by the uniqueIdentifier relation.

01-003 Amount Currency. Identifier

01-003 Amount Currency. Identifier is a supplementary component that represents the currency of the value of Amount. Content . The value should reference UN/ECE Rec. 9, using 3-letter alphabetic codes. The UN/ECE Rec. 9 is also published as ISO 4217. Both the UN/ECE and the ISO offer free publications of these specifications. It is recommended that the currency code is provided in this SC rather than in a separately defined BBIE.

PDT: string

Amount. Currency. Identifier Map to SUMO SymbolicString

Amount. Currency. Identifier maps to a SUMO SymbolicString that is related to a UnitOfMeasure part of a subclass of CurrencyMeasure by the uniqueIdentifier relation.

References

UNECE TDTD Rec 9 Recommendation No. 9 - Alphabetic Code for the Representation of Currencies

UNECE Codes for Trade Updated currencies as of ISO-4217 and ISO-3166-1 country codes Note: This is a link to a copy of the data maintained by UNECE. The master data is available from ISO.

Currency codes - ISO 4217 The master data for updated currencies as of ISO-4217 and ISO-3166-1 country codes is available for download directly from the ISO.

Amount. Type to SUMO

The Core Component Type Amount. Type can be represented in SUMO using the CurrencyMeasure class. A CurrencyMeasure is a type of ConstantQuantity. All ConstantQuantites are expressed with a BinaryFunction called MeasureFn. MeasureFn has two arguments, the first is a Number and the second is a UnitOfMeasure. The content component of Amount. Type serves as the Number and the supplementary component Amount Currency. Identifier serves as the UnitOfMeasure.

The UnitOfMeasure is identified by the uniqueIdentifier relation which is mapped to the supplementary component Amount Currency. Code List Version. Identifier.

amountmap.jpg

SUMO Mapping

Amount. Content is a SUMO RealNumber. Amount Currency Identifier is a SUMO SymbolicString and Amount Currency. Code List Version. Identifier is a SUMO SymbolicString. Amount. Content and Amount Currency. Identifier together form a SUMO CurrencyMeasure expressed by a SUMO MeasureFn.

Typical instances expressed in CCT terms:

  • Amount. Content: 12
  • Amount Currency. Identifier: "EUR"
  • Amount Currency. Code List Version. Identifier: "ECE/TRADE/203 [Edition 96.1]"

Typical instances expressed in SUMO terms: