Monetary Amounts
Introduction
Monetary Amounts are similar to Dimensions in that they are primarily a value
with a unit to clarify what the number refers to, but in this case the unit is a currency
. The amount is a particular instance of a value/currency combination, so there can be multiple amounts each of which have the same value and currency, but are used in different models. This is the same as the way there can be multiple dimensions with the same classification, value and unit used in different models.
In the Linked Art API and model, amounts are only used in the Provenance Activity structure, as described in the Provenance model documentation.
Property Definitions
The monetary amount data structure has the following properties.
Properties of Monetary Amounts
Property Name | Datatype | Requirement | Description |
---|---|---|---|
id |
string | Optional | If present, the value MUST be a URI identifying the amount, from which a representation of the amount can be retrieved |
type |
string | Required | The class for the name, which MUST be the value "MonetaryAmount" |
_label |
string | Recommended | A human readable label, intended for developers |
_complete |
boolean | Optional | Non-Semantic. If there is an id property with a URI, and there is more information about the amount available from the representation at that URI, then _complete MUST be present with a value of false to inform the consuming application that it might want to retrieve it |
value |
number | Required | The numeric value of the amount |
currency |
json object | Required | The currency for the amount, which MUST follow the requirements for a Currency |
classified_as |
array | Recommended | An array of json objects, each of which is a further classification of the amount and MUST follow the requirements for Type |
identified_by |
array | Recommended | An array of json objects, each of which is a textual representation of the structured data in the amount, and MUST follow the requirements for Name |
upper_value_limit |
number | Optional | A number, which represents the highest possible value for the amount |
lower_value_limit |
number | Optional | A number, which represents the lowest possible value for the amount |
referred_to_by |
array | Optional | An array of json objects, each of which is either a reference to a textual work that refers to the amount, or an embedded statement about the amount. |
Property Diagram
Incoming Properties
Dimension instances are typically found as the object of the following properties. This list is not exhaustive, but is intended to cover the likely cases.
Property Name | Source Endpoint | Description |
---|---|---|
paid_amount |
Provenance Activity | Monetary amounts are mostly used to record the amount of money that changes hands in a transaction, referred to from a Payment in a Provenance Activity |
dimension |
Set | Monetary amounts can be associated with other entities, such as a Set of objects, with the dimension property |
Example
An auction lot has a monetary amount of $500 as its starting price.
- It has a
type
of "MonetaryAmount" - It is
classified_as
a starting price, with anid
of aat:300417242 and atype
of "Type" - It has a
value
of 500 - And a
currency
of US dollars, with anid
of aat:300411994 and atype
of "Currency" - It has a display label with the content of "500 US Dollars"
- It is
referred_to_by
a note, with the content "From personal correspondence"
{
"@context": "https://linked.art/ns/v1/linked-art.json",
"id": "https://linked.art/example/set/2",
"type": "Set",
"_label": "Set of Objects for Lot 812",
"dimension": [
{
"type": "MonetaryAmount",
"_label": "$500",
"classified_as": [
{
"id": "http://vocab.getty.edu/aat/300417242",
"type": "Type",
"_label": "Starting Price"
}
],
"value": 500,
"identified_by": [
{
"type": "Name",
"classified_as": [
{
"id": "http://vocab.getty.edu/aat/300404669",
"type": "Type",
"_label": "Display Title"
}
],
"content": "500 US Dollars"
}
],
"referred_to_by": [
{
"type": "LinguisticObject",
"classified_as": [
{
"id": "http://vocab.getty.edu/aat/300027200",
"type": "Type",
"_label": "Note",
"classified_as": [
{
"id": "http://vocab.getty.edu/aat/300418049",
"type": "Type",
"_label": "Brief Text"
}
]
}
],
"content": "From personal correspondence"
}
],
"currency": {
"id": "http://vocab.getty.edu/aat/300411994",
"type": "Currency",
"_label": "US Dollars"
}
}
]
}