openapi: 3.1.0
info:
  title: Comunidesk API — Convenios de pago
  version: 1.0.0
  description: Convenios de pago por deuda.
servers:
  - url: "https://gateway.comunidesk.com"
    description: Gateway producción
tags:
  - name: convenios
    description: Convenios de pago — Convenios de pago por deuda.
paths:
  /v1/rest/Convenios:
    get:
      tags:
        - convenios
      operationId: listConvenioPago
      summary: Listar Convenios de pago
      description: Convenios de pago por deuda.
      security:
        - OAuth2App: []
          ComunideskUser: []
      parameters:
        - name: edificioId
          in: query
          required: false
          schema:
            type: string
          description: Contexto de edificio (requerido en la mayoría de módulos).
        - name: $filter
          in: query
          required: false
          schema:
            type: string
          description: "Filtro OData, p.ej. edificioId eq 'abc'"
        - name: $top
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
        - name: $skip
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/ConvenioPago"
                  count:
                    type: integer
        401:
          description: Token inválido
        403:
          description: Sin permiso
    post:
      tags:
        - convenios
      operationId: createConvenioPago
      summary: Crear Convenios de pago
      security:
        - OAuth2App: []
          ComunideskUser: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConvenioPago"
      responses:
        200:
          description: Creado
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConvenioPago"
        403:
          description: Sin permiso
        422:
          description: Contrato inválido
  /v1/rest/Convenios/{id}:
    get:
      tags:
        - convenios
      operationId: getConvenioPago
      summary: Obtener Convenios de pago
      security:
        - OAuth2App: []
          ComunideskUser: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: edificioId
          in: query
          required: false
          schema:
            type: string
          description: Contexto de edificio (requerido en la mayoría de módulos).
        - name: $filter
          in: query
          required: false
          schema:
            type: string
          description: "Filtro OData, p.ej. edificioId eq 'abc'"
        - name: $top
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
        - name: $skip
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: "#/components/schemas/ConvenioPago"
        404:
          description: No encontrado
    patch:
      tags:
        - convenios
      operationId: updateConvenioPago
      summary: Actualizar Convenios de pago
      security:
        - OAuth2App: []
          ComunideskUser: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConvenioPago"
      responses:
        200:
          description: Actualizado
        403:
          description: Sin permiso
        422:
          description: Contrato inválido
    delete:
      tags:
        - convenios
      operationId: deleteConvenioPago
      summary: Eliminar Convenios de pago
      security:
        - OAuth2App: []
          ComunideskUser: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: edificioId
          in: query
          required: false
          schema:
            type: string
      responses:
        200:
          description: Eliminado
        403:
          description: Sin permiso
        404:
          description: No encontrado
components:
  securitySchemes:
    OAuth2App:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token OAuth2 de tu aplicación.
    ComunideskUser:
      type: apiKey
      in: header
      name: x-comunidesk-user-authorization
      description: "Bearer <JWT de la cuenta Comunidesk del usuario>."
  schemas:
    ConvenioPago:
      type: object
      description: Convenios de pago por deuda.
      properties:
        _id:
          type: string
        _rev:
          type: string
        type:
          type: string
          const: convenio_pago
        edificioId:
          type: string
        departamentoId:
          type: string
        montoTotal:
          type: number
        numeroCuotas:
          type: number
        fechaInicio:
          type: string
        estado:
          type: string
          enum:
            - activo
            - cumplido
            - incumplido
            - cancelado
        observaciones:
          type: string
        createdAt:
          type: string
          readOnly: true
        updatedAt:
          type: string
          readOnly: true
      required:
        - edificioId
        - departamentoId
        - montoTotal
        - numeroCuotas
        - fechaInicio
    OAuthScopes:
      type: string
      enum:
        - "comunidesk:read"
        - "comunidesk:write"
        - "files:pdf"
        - "files:excel"
        - "ai:models"
        - "ai:chat"
        - "ai:extract"
        - "ai:web"
        - "flex-pro:manage"
        - "flex-pro:runtime"
        - "flex-pro:marketplace"
      description: Scopes OAuth soportados por el gateway.
security:
  - OAuth2App: []
    ComunideskUser: []