How do I list change reasons?

Table of Contents

List change reasons via ores.cli. See the CLI inventory for sibling recipes.

Question

How do I list change reasons?

Answer

List all as JSON

export ORES_CLI_DB_PASSWORD
./ores.cli dq change-reasons list ${db_args} ${log_args} --format json | jq .[:5]
[
  {
    "version": 1,
    "code": "system.initial_load",
    "description": "Initial system bootstrap or migration",
    "category_code": "system",
    "applies_to_amend": false,
    "applies_to_delete": false,
    "requires_commentary": false,
    "display_order": 0,
    "recorded_by": "system",
    "change_commentary": "System seed data - standard regulatory taxonomy",
    "recorded_at": "2026-01-11 21:39:05.000000000Z"
  },
  {
    "version": 1,
    "code": "common.non_material_update",
    "description": "Non-material update (Touch)",
    "category_code": "common",
    "applies_to_amend": true,
    "applies_to_delete": false,
    "requires_commentary": false,
    "display_order": 10,
    "recorded_by": "system",
    "change_commentary": "System seed data - standard regulatory taxonomy",
    "recorded_at": "2026-01-11 21:39:05.000000000Z"
  },
  {
    "version": 1,
    "code": "system.new_record",
    "description": "New record created during normal operations",
    "category_code": "system",
    "applies_to_amend": false,
    "applies_to_delete": false,
    "requires_commentary": false,
    "display_order": 10,
    "recorded_by": "system",
    "change_commentary": "System seed data - standard regulatory taxonomy",
    "recorded_at": "2026-01-11 21:39:05.000000000Z"
  },
  {
    "version": 1,
    "code": "trade.fat_finger",
    "description": "Erroneous execution (wrong quantity/price)",
    "category_code": "trade",
    "applies_to_amend": true,
    "applies_to_delete": true,
    "requires_commentary": false,
    "display_order": 10,
    "recorded_by": "system",
    "change_commentary": "System seed data - standard regulatory taxonomy",
    "recorded_at": "2026-01-11 21:39:05.000000000Z"
  },
  {
    "version": 1,
    "code": "common.rectification",
    "description": "User/Booking Error",
    "category_code": "common",
    "applies_to_amend": true,
    "applies_to_delete": true,
    "requires_commentary": false,
    "display_order": 20,
    "recorded_by": "system",
    "change_commentary": "System seed data - standard regulatory taxonomy",
    "recorded_at": "2026-01-11 21:39:05.000000000Z"
  }
]

List all as table

export ORES_CLI_DB_PASSWORD
./ores.cli dq change-reasons list ${db_args} ${log_args} --format table
+-----------------------------+----------+----------------------------------------------------+-------+--------+--------------+-------+-------------+---------+
| Code                        | Category | Description                                        | Amend | Delete | Req. Comment | Order | Recorded By | Version |
+-----------------------------+----------+----------------------------------------------------+-------+--------+--------------+-------+-------------+---------+
| system.initial_load         | system   | Initial system bootstrap or migration              | N     | N      | N            | 0     | system      | 1       |
| common.non_material_update  | common   | Non-material update (Touch)                        | Y     | N      | N            | 10    | system      | 1       |
| system.new_record           | system   | New record created during normal operations        | N     | N      | N            | 10    | system      | 1       |
| trade.fat_finger            | trade    | Erroneous execution (wrong quantity/price)         | Y     | Y      | N            | 10    | system      | 1       |
| common.rectification        | common   | User/Booking Error                                 | Y     | Y      | N            | 20    | system      | 1       |
| system.external_data_import | system   | External data import (requires data lineage)       | Y     | N      | Y            | 20    | system      | 1       |
| trade.system_malfunction    | trade    | Technical glitch or algorithm issue                | Y     | Y      | Y            | 20    | system      | 1       |
| common.duplicate            | common   | Duplicate Record                                   | N     | Y      | N            | 30    | system      | 1       |
| trade.corporate_action      | trade    | Stock split, dividend, or merger adjustment        | Y     | Y      | N            | 30    | system      | 1       |
| common.stale_data           | common   | Data not updated within required liquidity horizon | Y     | Y      | N            | 40    | system      | 1       |
| trade.allocation_swap       | trade    | House to client sub-account reallocation           | Y     | Y      | N            | 40    | system      | 1       |
| common.outlier_correction   | common   | Manual override after plausibility check failure   | Y     | Y      | Y            | 50    | system      | 1       |
| trade.re_booking            | trade    | Wrong legal entity correction                      | Y     | Y      | Y            | 50    | system      | 1       |
| common.feed_failure         | common   | Upstream vendor/API data issue                     | Y     | Y      | Y            | 60    | system      | 1       |
| common.mapping_error        | common   | Incorrect ID translation (e.g., ISIN to FIGI)      | Y     | Y      | Y            | 70    | system      | 1       |
| common.judgmental_override  | common   | Expert judgment when market prices unavailable     | Y     | Y      | Y            | 80    | system      | 1       |
| common.regulatory           | common   | Mandatory compliance adjustment                    | Y     | Y      | Y            | 90    | system      | 1       |
| common.other                | common   | Exceptional (requires audit note)                  | Y     | Y      | Y            | 1000  | system      | 1       |
| trade.other                 | trade    | Exceptional (requires audit note)                  | Y     | Y      | Y            | 1000  | system      | 1       |
+-----------------------------+----------+----------------------------------------------------+-------+--------+--------------+-------+-------------+---------+


List specific change reason

export ORES_CLI_DB_PASSWORD
./ores.cli dq change-reasons list ${db_args} ${log_args} \
  --format json --key "data_correction" | jq .

Emacs 29.3 (Org mode 9.6.15)