Money filters

MoneyRangeFilter

Filters by comparing a field to a range of monetary values.

Table

Filter schema

Property	Type	Description
operator	RangeOperators	The operator to apply to the filter value
value	range object	The value to use for the filter operation

Range object

Property	Type	Description
min	Money	The minimum monetary value for this range
max	Money	The maximum monetary value for this range

Formats

Example

A JSON example of this field is:

{
  "operator": "within",
  "value": {
    "min": {
      "amount": "1000",
      "currency": "USD"
    },
    "max": {
      "amount": "10000",
      "currency": "USD"
    }
  }
}

JSON Schema

The JSON schema for this field is:

$schema: https://json-schema.org/draft/2020-12/schema
$id: MoneyRangeFilter.yaml
type: object
properties:
  operator:
    $ref: RangeOperators.yaml
    description: The operator to apply to the filter value
  value:
    type: object
    properties:
      min:
        $ref: Money.yaml
      max:
        $ref: Money.yaml
    required:
      - min
      - max
    examples:
      - min: { amount: "1000", currency: "USD" }
        max: { amount: "10000", currency: "USD" }
    description: The value to use for the filter operation
required:
  - operator
  - value
description: Filters by comparing a field to a range of monetary values

TypeSpec

The TypeSpec code for this field is:

/** Filters by comparing a field to a range of monetary values */
model MoneyRangeFilter {
  /** The operator to apply to the filter value */
  operator: RangeOperators;

  /** The value to use for the filter operation */
  @example(#{
    min: #{ amount: "1000", currency: "USD" },
    max: #{ amount: "10000", currency: "USD" },
  })
  value: {
    min: Fields.Money;
    max: Fields.Money;
  };
}

MoneyComparisonFilter

Filters by comparing a field to a monetary value.

Table

Property	Type	Description
operator	ComparisonOperators	The operator to apply to the filter value
value	Money	The value to use for the filter operation

Formats

Example

A JSON example of this field is:

{
  "operator": "eq",
  "value": {
    "amount": "1000",
    "currency": "USD"
  }
}

JSON Schema

The JSON schema for this field is:

$schema: https://json-schema.org/draft/2020-12/schema
$id: MoneyComparisonFilter.yaml
type: object
properties:
  operator:
    $ref: ComparisonOperators.yaml
    description: The operator to apply to the filter value
  value:
    $ref: Money.yaml
    description: The value to use for the filter operation
required:
  - operator
  - value
description: Filters by comparing a field to a monetary value

TypeSpec

The TypeSpec code for this field is:

/** Filters by comparing a field to a monetary value */
model MoneyComparisonFilter {
  /** The operator to apply to the filter value */
  operator: ComparisonOperators;

  /** The value to use for the filter operation */
  @example(#{ amount: "1000", currency: "USD" })
  value: Fields.Money;
}