> ## Documentation Index
> Fetch the complete documentation index at: https://uqp.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# FactorCatalog

> Describe available pricing factors, their implementation status and whether businesses enable them by default.

Source: spec/schemas/factor-catalog.json. Draft v0.1; reference, not production.

Use the canonical JSON below for all constraints.

## Properties and definitions

| Property / definition | Required | Type / reference | Description / constraints |
| - | - | - | - |
| pack\_id | yes | common.json#/\$defs/packId | \{"\$ref":"common.json#/\$defs/packId"} |
| pack\_version | yes | common.json#/\$defs/packVersion | \{"\$ref":"common.json#/\$defs/packVersion"} |
| provenance | no | string | \{"type":"string","minLength":1} |
| factors | yes | array | \{"type":"array","items":\{"type":"object","properties":\{"id":\{"type":"string","minLength":1},"label":\{"type":"string","minLength":1},"question\_ids":\{"type":"array","items":\{"type":"string","minLength":1},"uniqueItems":true},"enabled\_by\_default":\{"type":"boolean"},"status":\{"enum":\["modeled","not\_yet\_modeled"]},"description":\{"type":"string","minLength":1},"mode":\{"type":"string","minLength":1},"modes":\{"type":"array","items":\{"type":"string","minLength":1}},"value":\{},"values":\{},"weight":\{"type":"number"},"provenance":\{"type":"string","minLength":1},"enabled":\{"type":"boolean"},"source\_ids":\{"type":"array","items":\{"type":"string","minLength":1},"uniqueItems":true},"evidence\_count":\{"type":"integer","minimum":0},"evidence\_status":\{"enum":\["assumption","unvalidated"]}},"required":\["id","label","question\_ids","enabled\_by\_default","status"],"additionalProperties":false,"allOf":\[\{"if":\{"properties":\{"status":\{"const":"not\_yet\_modeled"}}},"then":\{"properties":\{"enabled\_by\_default":\{"const":false}}}}]}} |

## Full JSON

```json theme={null}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://uqp.dev/spec/schemas/factor-catalog.json",
  "title": "FactorCatalog",
  "type": "object",
  "properties": {
    "pack_id": {
      "$ref": "common.json#/$defs/packId"
    },
    "pack_version": {
      "$ref": "common.json#/$defs/packVersion"
    },
    "provenance": {
      "type": "string",
      "minLength": 1
    },
    "factors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "question_ids": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1
            },
            "uniqueItems": true
          },
          "enabled_by_default": {
            "type": "boolean"
          },
          "status": {
            "enum": [
              "modeled",
              "not_yet_modeled"
            ]
          },
          "description": {
            "type": "string",
            "minLength": 1
          },
          "mode": {
            "type": "string",
            "minLength": 1
          },
          "modes": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1
            }
          },
          "value": {},
          "values": {},
          "weight": {
            "type": "number"
          },
          "provenance": {
            "type": "string",
            "minLength": 1
          },
          "enabled": {
            "type": "boolean"
          },
          "source_ids": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1
            },
            "uniqueItems": true
          },
          "evidence_count": {
            "type": "integer",
            "minimum": 0
          },
          "evidence_status": {
            "enum": [
              "assumption",
              "unvalidated"
            ]
          }
        },
        "required": [
          "id",
          "label",
          "question_ids",
          "enabled_by_default",
          "status"
        ],
        "additionalProperties": false,
        "allOf": [
          {
            "if": {
              "properties": {
                "status": {
                  "const": "not_yet_modeled"
                }
              }
            },
            "then": {
              "properties": {
                "enabled_by_default": {
                  "const": false
                }
              }
            }
          }
        ]
      }
    }
  },
  "required": [
    "pack_id",
    "pack_version",
    "factors"
  ],
  "additionalProperties": false
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.