Linked Art API: Monetary Amount Structure

Table of Contents

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

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.

{
  "@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"
      }
    }
  ]
}

graph TD classDef object stroke:black,fill:#E1BA9C,rx:20px,ry:20px; classDef actor stroke:black,fill:#FFBDCA,rx:20px,ry:20px; classDef type stroke:red,fill:#FAB565,rx:20px,ry:20px; classDef name stroke:orange,fill:#FEF3BA,rx:20px,ry:20px; classDef dims stroke:black,fill:#c6c6c6,rx:20px,ry:20px; classDef infoobj stroke:#907010,fill:#fffa40,rx:20px,ry:20px classDef timespan stroke:blue,fill:#ddfffe,rx:20px,ry:20px classDef place stroke:#3a7a3a,fill:#aff090,rx:20px,ry:20px classDef event stroke:#1010FF,fill:#96e0f6,rx:20px,ry:20px classDef literal stroke:black,fill:#f0f0e0; classDef classstyle stroke:black,fill:white; O1(set/2) class O1 infoobj; O1-- type -->O1_0[Set] class O1_0 classstyle; O1-- _label -->O1_4("''Set of Objects for Lot 812''") class O1_4 literal; O2( _ ) class O2 dims; O2-- type -->O2_0[MonetaryAmount] class O2_0 classstyle; O2-- _label -->O2_2("''$500''") class O2_2 literal; O3(aat:300417242) class O3 type; O3-- type -->O3_0[Type] class O3_0 classstyle; O3-- _label -->O3_3("''Starting Price''") class O3_3 literal; O2-- classified_as -->O3 O2-- value -->O2_4(500) class O2_4 literal; O4( _ ) class O4 name; O4-- type -->O4_0[Name] class O4_0 classstyle; O5(aat:300404669) class O5 type; O5-- type -->O5_0[Type] class O5_0 classstyle; O5-- _label -->O5_3("''Display Title''") class O5_3 literal; O4-- classified_as -->O5 O4-- content -->O4_3("''500 US Dollars''") class O4_3 literal; O2-- identified_by -->O4 O6( _ ) class O6 infoobj; O6-- type -->O6_0[LinguisticObject] class O6_0 classstyle; O7(aat:300027200) class O7 type; O7-- type -->O7_0[Type] class O7_0 classstyle; O7-- _label -->O7_3("''Note''") class O7_3 literal; O8(aat:300418049) class O8 type; O8-- type -->O8_0[Type] class O8_0 classstyle; O8-- _label -->O8_3("''Brief Text''") class O8_3 literal; O7-- classified_as -->O8 O6-- classified_as -->O7 O6-- content -->O6_3("''From personal correspondence''") class O6_3 literal; O2-- referred_to_by -->O6 O9(aat:300411994) class O9 type; O9-- type -->O9_0[Currency] class O9_0 classstyle; O9-- _label -->O9_3("''US Dollars''") class O9_3 literal; O2-- currency -->O9 O1-- dimension -->O2
Other Representations: JSON-LD (raw) | JSON-LD (playground) | Turtle (raw) | Turtle (styled)