YQueue DocsDevelopers

Schema

Money

The standardised representation of a monetary amount.

  • Foundation

Overview

object · 2 properties · 2 required

Properties

amount

integer Required

The amount/value in the lowest possible unit of the associated currency. For example, a value of `125` alongside a currency of `SGD` means $1.25.

Example 123

currency

string Required

An ISO 4217 alpha-3 currency code.

Example SGD
Min length 3
Max length 3

Used by

Raw YAML
Download source
title: Money
x-tags:
  - Foundation
type: object
description: The standardised representation of a monetary amount.
properties:
  amount:
    type: integer
    description: |-
      The amount/value in the lowest possible unit of the associated currency.

      For example, a value of `125` alongside a currency of `SGD` means $1.25.
    example: 123
  currency:
    type: string
    description: An ISO 4217 alpha-3 currency code.
    example: SGD
    minLength: 3
    maxLength: 3
required:
  - amount
  - currency

Search documentation

Search across this documentation site.