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

# Resumen de ventas

> Obtiene un resumen estadístico de las ventas con filtros opcionales.

Incluye totales, promedios y distribución por estado.




## OpenAPI

````yaml /openapi.yaml get /sales/summary
openapi: 3.0.0
info:
  title: SmartPYME External API
  description: >
    API Externa de SmartPYME para proveedores terceros.


    Permite consultar y registrar ventas, consultar inventario y devoluciones, e
    importar paquetes usando autenticación por API Key.


    ## Autenticación

    Todas las requests requieren un API Key válido en el header Authorization:

    ```

    Authorization: Bearer {tu_api_key}

    ```


    ## Rate Limiting

    - Sin filtros de fecha: 1000 requests/hora

    - Con filtros de fecha: 2000 requests/hora


    ## Paginación

    Todos los endpoints de lista soportan paginación:

    - `page`: Número de página (default: 1)

    - `per_page`: Registros por página (1-200, default: 100)
  version: 1.4.0
  contact:
    name: SmartPYME Support
    email: soporte@smartpyme.com
  license:
    name: Propietario
    url: https://smartpyme.com/terms
servers:
  - url: https://tu-dominio.com/api/external/v1
    description: Servidor de Producción
  - url: http://localhost/api/external/v1
    description: Servidor de Desarrollo
security:
  - ApiKeyAuth: []
paths:
  /sales/summary:
    get:
      tags:
        - Ventas
      summary: Resumen de ventas
      description: |
        Obtiene un resumen estadístico de las ventas con filtros opcionales.

        Incluye totales, promedios y distribución por estado.
      parameters:
        - name: fecha_inicio
          in: query
          description: Fecha de inicio para el resumen
          schema:
            type: string
            format: date
        - name: fecha_fin
          in: query
          description: Fecha de fin para el resumen
          schema:
            type: string
            format: date
        - name: estado
          in: query
          description: Filtrar resumen por estado
          schema:
            type: string
            enum:
              - Completada
              - Pendiente
              - Anulada
              - Cotizacion
      responses:
        '200':
          description: Resumen de ventas obtenido exitosamente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SalesSummaryResponse'
components:
  schemas:
    SalesSummaryResponse:
      allOf:
        - $ref: '#/components/schemas/BaseResponse'
        - type: object
          properties:
            data:
              type: object
              properties:
                cantidad_ventas:
                  type: integer
                  example: 125
                total_ventas:
                  type: number
                  format: float
                  example: 18750.5
                total_iva:
                  type: number
                  format: float
                  example: 1687.55
                total_descuentos:
                  type: number
                  format: float
                  example: 250
                promedio_venta:
                  type: number
                  format: float
                  example: 150
                ventas_por_estado:
                  type: array
                  items:
                    type: object
                    properties:
                      estado:
                        type: string
                        example: Completada
                      cantidad:
                        type: integer
                        example: 120
                      total:
                        type: number
                        format: float
                        example: 18000
    BaseResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indica si la operación fue exitosa
        meta:
          $ref: '#/components/schemas/Meta'
      required:
        - success
    Meta:
      type: object
      properties:
        empresa:
          type: string
          description: Nombre de la empresa
          example: Mi Empresa S.A.
        timestamp:
          type: string
          format: date-time
          description: Timestamp de la respuesta
        filters_applied:
          type: object
          description: Filtros aplicados en la consulta
      required:
        - empresa
        - timestamp
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: |
        API Key de la empresa en formato Bearer token.

        Ejemplo: `Authorization: Bearer G8RCjH11DabBNjnX7wO5`

````