Money Item object representation

The moneyitem object representation and fields are described below.

moneyitem was introduced in API version V1

moneyitem has not been marked for deprecation

Endpoint usages

Money Item

Description

A money value item in the context of a content entity

Example create representation

{
  "name" : "price",
  "sortOrder" : 0,
  "currencyCode" : "GBP",
  "unitValue" : 2500,
  "entity" : {
    "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
    "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
  },
  "formattedValue" : "25.00",
  "currencySymbol" : "£"
}

Example response representation

{
  "urn" : "df30637a-c46b-4c67-bdaf-b6c3ba8c9034",
  "url" : "/n/v1/moneyitem/df30637a-c46b-4c67-bdaf-b6c3ba8c9034",
  "name" : "price",
  "sortOrder" : 0,
  "currencyCode" : "GBP",
  "unitValue" : 2500,
  "entity" : {
    "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
    "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
  },
  "formattedValue" : "25.00",
  "currencySymbol" : "£"
}

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.	URN of the item
url	URL represented as a string	The URL of the money item
name	Field name, typically used in content items. Typically use conventions around html ID expectations.	The name of item item field	Required on create. Minimum length: 1. Maximum length: 1024.
sortOrder	Signed int32	The sort order value for the item	Required on create.
currencyCode	A string representation of a enumeration name restricted to the documented values	The currency code for the money item	Required on create. Allowed values: AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BRL BSD BTN BWP BYN BYR BZD CAD CDF CHF CLF CLP CNY COP CRC CUC CUP CVE CZK DJF DKK DOP DZD EEK EGP ERN ETB EUR FJD FKP GBP GEL GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS INR IQD IRR ISK JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LTL LVL LYD MAD MDL MGA MKD MMK MNT MOP MRO MRU MUR MVR MWK MXN MXV MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SKK SLE SLL SOS SRD STN STD SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD UYU UZS VEF VES VND VUV WST XAF XCD XOF XPF YER ZAR ZMW ZMK ZWD
unitValue	Signed int64	The value of money in cents for the currency e.g. 1099 for £10.99	Required on create. Minimum: -9223372036854775808. Maximum: 9223372036854775807.
entity	Entity	The entity this item is associated with.	Required on create.
formattedValue	String literal	The formatted (with period) value without the currency symbol.
currencySymbol	String literal	The currency symbol (may be ambiguous without the full currency code but is provided for convenience)
isPublished	Boolean literal e.g. true	Set in the context of money item history to indicate which item is published
createdTimestamp	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.	The timestamp the money item was created in history view
history