Money

A monetary amount and its currency.

Money

A monetary amount and the currency in which it's denominated.

Property	Type	Required	Description
amount	decimalString	Yes	The amount of money.
currency	string	Yes	The ISO 4217 currency code in which the amount is denominated.

Example

{
  "amount": "-50.50",
  "currency": "USD"
}

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: Money.yaml
type: object
properties:
  amount:
    $ref: decimalString.yaml
    description: The amount of money.
  currency:
    type: string
    description: The ISO 4217 currency code in which the amount is denominated.
required:
  - amount
  - currency
examples:
  - amount: "-50.50"
    currency: USD
  - amount: "5000"
    currency: EUR
  - amount: "10000.50"
    currency: USD
description: A monetary amount and the currency in which it's denominated.

TypeSpec

/** A monetary amount and the currency in which it's denominated. */
@example(Examples.Money.usdWithCents, #{ title: "US dollars and cents" })
@example(Examples.Money.euroWithoutCents, #{ title: "Euros displayed without cents" })
@example(Examples.Money.usdNegative, #{ title: "A negative amount of US dollars and cents" })
@Versioning.added(Versions.v0_1)
model Money {
  /** The amount of money. */
  amount: decimalString;

  /** The ISO 4217 currency code in which the amount is denominated. */
  currency: string;
}