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

# Obtener notificaciones de plazos

> Utiliza este endpoint para obtener los plazos activos que se encuentran dentro de su ventana de notificación, ordenados por urgencia. Úsalo para mostrar a tus usuarios los plazos próximos y vencidos.



## OpenAPI

````yaml es/openapi/v3-current/reporter.yaml get /v1/deadlines/notifications
openapi: 3.1.0
info:
  contact:
    name: Discord community
    url: https://discord.gg/DnhqKwkGv3
  description: >-
    Esta es la documentación OpenAPI de Reporter. El binario unificado de
    Reporter ejecuta la API REST (RUN_MODE=api), el worker de generación de
    informes de RabbitMQ (RUN_MODE=worker) o ambos; RUN_MODE=all ejecuta los dos
    en un único proceso para el desarrollo local. Todos los endpoints REST
    documentados aquí solo están disponibles cuando RUN_MODE=api o RUN_MODE=all
    (puerto :4005); el worker (puerto :4006) expone únicamente los endpoints de
    health y readyz.
  license:
    name: Lerian Studio General License
  title: Midaz Reporter API
  version: 4.0.0
servers:
  - url: http://localhost:4005
  - url: https://localhost:4005
security:
  - BearerAuth: []
tags:
  - description: Instancias de informes generados y su ciclo de vida.
    name: Informes
  - description: Definiciones de informes reutilizables.
    name: Plantillas
  - description: Creación interactiva de plantillas de informes.
    name: Constructor de plantillas
  - description: Seguimiento de las fechas de vencimiento de informes programados.
    name: Plazos
  - description: Entradas configuradas que proporcionan datos a los informes.
    name: Fuentes de datos
  - description: Métricas agregadas de informes.
    name: Métricas
  - description: Catálogo publicado de eventos de negocio y políticas de entrega.
    name: Streaming
paths:
  /v1/deadlines/notifications:
    get:
      tags:
        - Plazos
      summary: Obtener notificaciones de plazos
      description: >-
        Utiliza este endpoint para obtener los plazos activos que se encuentran
        dentro de su ventana de notificación, ordenados por urgencia. Úsalo para
        mostrar a tus usuarios los plazos próximos y vencidos.
      operationId: listDeadlineNotifications
      parameters:
        - description: >-
            Número máximo de notificaciones que se devuelven. Debe ser un entero
            entre 1 y 100.
          example: 10
          explode: false
          in: query
          name: limit
          schema:
            default: 10
            description: >-
              Número máximo de notificaciones que se devuelven. Debe ser un
              entero entre 1 y 100.
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationResponse'
          description: Correcto
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Solicitud incorrecta
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: No autorizado
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Prohibido
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error interno del servidor
components:
  schemas:
    NotificationResponse:
      properties:
        items:
          description: Notificaciones de plazos dentro de su ventana de notificación.
          examples:
            - - color: '#EF4444'
                daysUntilDue: 3
                description: Monthly regulatory report
                dueDate: '2026-07-31T00:00:00Z'
                frequency: monthly
                id: 00000000-0000-0000-0000-000000000001
                name: CADOC 4010
                notifyDaysBefore: 5
                severity: warning
                type: regulatory
          items:
            $ref: '#/components/schemas/NotificationItem'
          type:
            - array
            - 'null'
        total:
          description: Número de notificaciones devueltas.
          examples:
            - 3
          format: int64
          type: integer
      type: object
    Detail:
      properties:
        code:
          description: >-
            Código de error de dominio estable y legible por máquina, limitado
            al servicio emisor (formato: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: Explicación legible específica de esta instancia del problema.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Lista opcional de detalles individuales del error
          examples:
            - - location: body.templateId
                message: expected string to match 'uuid' format
                value: not-a-uuid
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: Referencia URI que identifica la instancia específica del problema.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: Código de estado HTTP
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            Resumen breve y legible del tipo de problema. Este valor no debe
            cambiar entre instancias del error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: Referencia URI a la documentación legible del error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    NotificationItem:
      properties:
        color:
          description: >-
            Color usado para identificar visualmente el plazo (formato
            hexadecimal).
          examples:
            - '#ef4444'
          type: string
        daysUntilDue:
          description: Días restantes hasta el plazo, o días negativos si está vencido.
          examples:
            - 3
          format: int64
          type: integer
        description:
          description: Descripción del plazo.
          examples:
            - Monthly regulatory report
          type: string
        dueDate:
          description: Fecha y hora de vencimiento del plazo, en formato RFC 3339.
          examples:
            - '2026-07-31T00:00:00Z'
          format: date-time
          type: string
        frequency:
          description: Con qué frecuencia se repite el plazo (p. ej., `monthly`, `annual`).
          examples:
            - monthly
          type: string
        id:
          description: Identificador único del plazo (UUID).
          examples:
            - 00000000-0000-0000-0000-000000000001
          type: string
        monthsOfYear:
          description: Meses del año (1-12) en los que aplica el plazo.
          examples:
            - - 1
              - 6
              - 12
          items:
            format: int64
            type: integer
          type:
            - array
            - 'null'
        name:
          description: Nombre legible del plazo.
          examples:
            - CADOC 4010
          type: string
        notifyDaysBefore:
          description: >-
            Número de días antes de la fecha de vencimiento en que comienzan las
            notificaciones.
          examples:
            - 5
          format: int64
          type: integer
        severity:
          description: Nivel de urgencia de la notificación.
          examples:
            - warning
          type: string
        type:
          description: Tipo del plazo (p. ej., `regulatory`, `custom`).
          examples:
            - regulatory
          type: string
      type: object
    ErrorDetail:
      properties:
        location:
          description: >-
            Lugar donde ocurrió el error, por ejemplo, 'body.items[3].tags' o
            'path.thing-id'
          examples:
            - body.templateId
          type: string
        message:
          description: Texto del mensaje de error
          examples:
            - expected string to match 'uuid' format
          type: string
        value:
          description: Valor en la ubicación indicada
          examples:
            - not-a-uuid
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: >-
        Autenticación mediante token Bearer. Formato: 'Bearer {access_token}'.
        Solo es obligatoria cuando el plugin de autenticación está habilitado.
      scheme: bearer
      type: http

````