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

# Get all recurring rules

> Operacion: Get all recurring rules.



## OpenAPI

````yaml /generated/specs/finance.json get /api/v1/recurring/rules
openapi: 3.0.0
info:
  title: Raul API - Finanzas
  description: >-
    Facturas, boletas, ejecuciones de billing, cuentas por pagar y medios de
    pago.
  version: 2.0.0
  contact: {}
servers:
  - url: https://api.raul.ugps.io
    description: Production
security: []
tags: []
paths:
  /api/v1/recurring/rules:
    get:
      tags:
        - Recurring Expenses
      summary: Get all recurring rules
      description: 'Operacion: Get all recurring rules.'
      operationId: RecurringRuleController_getRules
      parameters:
        - name: type
          required: false
          in: query
          description: Filter recurring rules by type
          schema:
            example: expense
            type: string
            enum:
              - expense
              - income
              - all
        - name: projection_year
          required: false
          in: query
          description: >-
            Projection year used to expand the rule as a month-by-month view
            model
          schema:
            example: 2026
            type: number
        - name: from_month
          required: false
          in: query
          description: First projected month to include in the response
          schema:
            example: 2026-04
            type: string
        - name: to_month
          required: false
          in: query
          description: Last projected month to include in the response
          schema:
            example: 2026-12
            type: string
      responses:
        '200':
          description: Rules returned successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RecurringRuleResponseDto'
      security:
        - bearerAuth: []
components:
  schemas:
    RecurringRuleResponseDto:
      type: object
      properties:
        rule_id:
          type: string
        supplier_id:
          type: object
        category_id:
          type: object
        client_id:
          type: object
        description:
          type: string
        type:
          type: string
          enum:
            - expense
            - income
        source:
          type: object
        projection_group:
          type: object
        expected_amount:
          type: number
        expected_day:
          type: number
        end_date:
          type: object
        amount_schedule:
          type: array
          items:
            $ref: '#/components/schemas/RecurringRuleAmountScheduleItemDto'
        projection_months:
          type: array
          items:
            $ref: '#/components/schemas/RecurringRuleProjectionMonthDto'
        is_active:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - rule_id
        - supplier_id
        - description
        - type
        - expected_amount
        - expected_day
        - end_date
        - is_active
        - created_at
        - updated_at
    RecurringRuleAmountScheduleItemDto:
      type: object
      properties:
        effective_month:
          type: string
          description: Month where the new amount starts applying
          example: 2026-05
        amount:
          type: number
          description: Amount applied from the effective month onward
          example: 2500000
          minimum: 0
      required:
        - effective_month
        - amount
    RecurringRuleProjectionMonthDto:
      type: object
      properties:
        month:
          type: string
          description: Month represented in the dense projection matrix
          example: 2026-04
        amount:
          type: number
          description: Amount assigned to the projected month
          example: 2500000
        is_active:
          type: boolean
          description: Whether the rule is active for this month
          example: true
      required:
        - month
        - amount
        - is_active
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Token de sesión Better Auth para rutas de backoffice; las rutas de
        portal usan su token propio.

````

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