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 model.

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

JSON Schema

The JSON Schema for this model.

$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
    unevaluatedProperties:
      not: {}
    examples:
      - min:
          amount: "1000"
          currency: USD
        max:
          amount: "10000"
          currency: USD
    description: The value to use for the filter operation
required:
  - operator
  - value
unevaluatedProperties:
  not: {}
description: Filters by comparing a field to a range of monetary values

TypeSpec

The TypeSpec code for this model.

/** Filters by comparing a field to a range of monetary values */
@Versioning.added(CommonGrants.Versions.v0_1)
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;
  };
}

Python

The Python code for this model.

class MoneyRangeFilter(CommonGrantsBaseModel):
    """Filter for money ranges using comparison operators."""

    operator: RangeOperator = Field(
        ...,
        description="The operator to apply to the filter value",
    )
    value: MoneyRange = Field(..., description="The money range value")

TypeScript

The TypeScript code for this model.

export const MoneyRangeFilterSchema = z.object({
  operator: RangeOperatorsEnum,
  value: z.object({
    min: MoneySchema,
    max: MoneySchema,
  }),
});

Changelog

Version	Changes	Schema
0.1.0	Added MoneyRangeFilter model	MoneyRangeFilter.yaml

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 model.

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

JSON Schema

The JSON Schema for this model.

$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
    examples:
      - amount: "1000"
        currency: USD
    description: The value to use for the filter operation
required:
  - operator
  - value
unevaluatedProperties:
  not: {}
description: Filters by comparing a field to a monetary value

TypeSpec

The TypeSpec code for this model.

/** Filters by comparing a field to a monetary value */
@Versioning.added(CommonGrants.Versions.v0_1)
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;
}

Python

The Python code for this model.

class MoneyComparisonFilter(CommonGrantsBaseModel):
    """Filter for money values using comparison operators."""

    operator: ComparisonOperator = Field(
        ...,
        description="The operator to apply to the filter value",
    )
    value: Money = Field(..., description="The money value to compare against")

    @field_validator("operator", mode="before")
    @classmethod
    def validate_operator(cls, v):
        """Convert string to enum if needed."""
        if isinstance(v, str):
            return ComparisonOperator(v)
        return v

TypeScript

The TypeScript code for this model.

export const MoneyComparisonFilterSchema = z.object({
  operator: ComparisonOperatorsEnum,
  value: MoneySchema,
});

Changelog

Version	Changes	Schema
0.1.0	Added MoneyComparisonFilter model	MoneyComparisonFilter.yaml