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

# List the rule catalogue

> Returns the CLOSED catalogue of things a rule can measure. Solya ships the list; the merchant sets the threshold, the perimeter, the mode and the switch — there is no free-form rule builder, on purpose. Every entry is measurable with the Centrale's own data: a measurement needing sales velocity, a purchase cost or a supplier minimum is absent rather than listed-and-inert, because a rule that can never fire is one the merchant believes in. Read this before `POST /rules`: `templateId` must come from here. The catalogue is a dozen entries and pages like every other list purely for consistency.



## OpenAPI

````yaml /openapi.json get /v1/rules/templates
openapi: 3.0.3
info:
  title: Solya POS API
  version: 1.0.0
  description: >-
    The Solya POS backend HTTP surface. Every documented operation is
    agent-ready: it carries an `operationId`, an agent-facing `description`, the
    `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`.
    Success responses return the payload as raw JSON; failures return the
    `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`).
servers:
  - url: /
    description: The backend, relative to its deployed origin.
security: []
paths:
  /v1/rules/templates:
    get:
      tags:
        - Settings
      summary: List the rule catalogue
      description: >-
        Returns the CLOSED catalogue of things a rule can measure. Solya ships
        the list; the merchant sets the threshold, the perimeter, the mode and
        the switch — there is no free-form rule builder, on purpose. Every entry
        is measurable with the Centrale's own data: a measurement needing sales
        velocity, a purchase cost or a supplier minimum is absent rather than
        listed-and-inert, because a rule that can never fire is one the merchant
        believes in. Read this before `POST /rules`: `templateId` must come from
        here. The catalogue is a dozen entries and pages like every other list
        purely for consistency.
      operationId: listRuleTemplates
      parameters:
        - schema:
            default: 1
            type: integer
            minimum: 1
            maximum: 9007199254740991
          in: query
          name: page
          required: false
          description: 1-based page index to return. Defaults to 1.
        - schema:
            default: 20
            type: integer
            minimum: 1
            maximum: 100
          in: query
          name: pageSize
          required: false
          description: Rows per page, 1..100. Defaults to 20.
      responses:
        '200':
          description: The catalogue, in the order the screen offers it.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        category:
                          type: string
                        applicableFamilies:
                          type: array
                          items:
                            type: string
                        nameKey:
                          type: string
                        descriptionKey:
                          type: string
                        contextType:
                          type: string
                        operator:
                          type: string
                        defaultThreshold:
                          type: number
                        defaultCheckLevel:
                          type: string
                        defaultEvaluationPoints:
                          type: array
                          items:
                            type: string
                        unit:
                          type: string
                      required:
                        - id
                        - category
                        - applicableFamilies
                        - nameKey
                        - descriptionKey
                        - contextType
                        - operator
                        - defaultThreshold
                        - defaultCheckLevel
                        - defaultEvaluationPoints
                        - unit
                      additionalProperties: false
                    description: The rows on this page, in the query's sort order.
                  total:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                    description: >-
                      Total rows matching the filter across ALL pages, not just
                      this one.
                  page:
                    type: integer
                    minimum: 0
                    exclusiveMinimum: true
                    maximum: 9007199254740991
                    description: The 1-based page number served.
                  pageSize:
                    type: integer
                    minimum: 0
                    exclusiveMinimum: true
                    maximum: 9007199254740991
                    description: Rows requested per page.
                  pageCount:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                    description: >-
                      Total number of pages; stop walking when `page` reaches
                      it.
                required:
                  - items
                  - total
                  - page
                  - pageSize
                  - pageCount
                additionalProperties: false
                description: The catalogue, in the order the screen offers it.
                example:
                  items:
                    - id: exchange_reorder_ratio
                      category: COMPLIANCE
                      applicableFamilies:
                        - SUPPLIER_EXCHANGE_PLAN
                      nameKey: ruleExchangeReorderRatio
                      descriptionKey: ruleExchangeReorderRatioDesc
                      contextType: EXCHANGE_RECEIVE_RATIO
                      operator: LOWER_THAN
                      defaultThreshold: 110
                      defaultCheckLevel: PLAN
                      defaultEvaluationPoints:
                        - PRE_PLAN_VALIDATE
                      unit: percent
                  total: 11
                  page: 1
                  pageSize: 20
                  pageCount: 1
        '400':
          description: >-
            The request failed schema validation; `error.fieldErrors` lists the
            fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: No valid credential was presented — send a bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The actor is authenticated but lacks the required `pos.*` scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected server error — safe to retry idempotent requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ValidationErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: >-
        A `VALIDATION_FAILED` envelope carrying the offending fields in
        `fieldErrors`.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
            message:
              type: string
            statusCode:
              type: integer
            fieldErrors:
              type: array
              description: >-
                One entry per rejected field: the field path and why it was
                rejected.
              items:
                type: object
                required:
                  - field
                  - message
                additionalProperties: false
                properties:
                  field:
                    type: string
                    description: Dot-path of the offending field.
                  message:
                    type: string
                    description: Why the field was rejected.
    ErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: The uniform failure envelope every non-2xx response returns.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - CONFLICT
                - BUSINESS_RULE_VIOLATION
                - INTERNAL_ERROR
              description: >-
                Machine-readable kernel `ResultCode` — branch on this, not on
                `message`.
            message:
              type: string
              description: >-
                Human-readable explanation. Safe to surface; never leaks server
                internals.
            statusCode:
              type: integer
              description: >-
                The HTTP status, mirrored into the body so a client need not
                read headers.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        `Authorization: Bearer <token>`. Accepts EITHER a Keycloak access token
        (scopes-in-token) OR an opaque POS session token; both resolve to the
        same `pos.*` scope vocabulary the route guards enforce.

````