Frequency

How often a recurring event (e.g., income, benefit payment) repeats.

Frequency

Frequency of a recurring monetary amount, modeled as an extensible enum so implementations can supply a custom frequency via the `description` field when none of the predefined options apply.

Property	Type	Required	Description
value	FrequencyOptions	Yes	The selected value, typed to `T`.
customValue	string	No	Caller-defined value when `value` is the `custom` option (or otherwise does not fit a predefined option in `T`).
description	string	No	Human-readable description or annotation for the value.

Example

{
  "value": "monthly",
  "description": ""
}

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: Frequency.yaml
type: object
properties:
  value:
    $ref: FrequencyOptions.yaml
    description: The selected value, typed to `T`.
  customValue:
    type: string
    description: |-
      Caller-defined value when `value` is the `custom` option (or otherwise
      does not fit a predefined option in `T`).
  description:
    type: string
    description: Human-readable description or annotation for the value.
required:
  - value
examples:
  - value: monthly
    description: ""
description: |-
  Frequency of a recurring monetary amount, modeled as an extensible enum so
  implementations can supply a custom frequency via the `description` field
  when none of the predefined options apply.

TypeSpec

/** Frequency of a recurring monetary amount, modeled as an extensible enum so
 * implementations can supply a custom frequency via the `description` field
 * when none of the predefined options apply.
 */
@example(Examples.Frequency.monthly)
@Versioning.added(Versions.v0_1)
model Frequency is ExtensibleEnumT<FrequencyOptions>;

namespace Examples.Frequency {
  const monthly = #{ value: FrequencyOptions.monthly, description: "" };
}

FrequencyOptions

Predefined set of frequencies for recurring monetary amounts (e.g., income, estimated benefits).

Value	Description
weekly	Once per week.
bi_weekly	Once every two weeks.
semi_monthly	Twice per month.
monthly	Once per month.
annual	Once per year.
custom	A caller-defined frequency captured in the description.

Example

"weekly"

JSON Schema

$schema: https://json-schema.org/draft/2020-12/schema
$id: FrequencyOptions.yaml
type: string
enum:
  - weekly
  - bi_weekly
  - semi_monthly
  - monthly
  - annual
  - custom
description: |-
  Predefined set of frequencies for recurring monetary amounts (e.g., income,
  estimated benefits).

  - `weekly`: Once per week.
  - `bi_weekly`: Once every two weeks.
  - `semi_monthly`: Twice per month.
  - `monthly`: Once per month.
  - `annual`: Once per year.
  - `custom`: A caller-defined frequency captured in the description.

TypeSpec

/** Predefined set of frequencies for recurring monetary amounts (e.g., income,
 * estimated benefits).
 *
 * - `weekly`: Once per week.
 * - `bi_weekly`: Once every two weeks.
 * - `semi_monthly`: Twice per month.
 * - `monthly`: Once per month.
 * - `annual`: Once per year.
 * - `custom`: A caller-defined frequency captured in the description.
 */
@Versioning.added(Versions.v0_1)
enum FrequencyOptions {
  weekly,
  bi_weekly,
  semi_monthly,
  monthly,
  annual,
  custom,
}