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

# Consultar el resumen del mes

> Lo vendido y comprado en el mes, y lo que hoy está por cobrar y por
pagar. Son los mismos totales de los reportes de ventas, cuentas por
cobrar y cuentas por pagar.

Ventas, compras propias (liquidaciones) y por cobrar siguen el ambiente
de la cuenta (pruebas o producción). Las compras recibidas del SRI no
tienen ambiente. Requiere poder ver reportes (`permissions.read_reports`).




## OpenAPI

````yaml /api-reference/openapi.yaml get /api/v1/accounts/{account_id}/summary
openapi: 3.1.0
info:
  title: Tellen API
  version: 1.0.0
  description: |
    API REST de Tellen para facturación electrónica en Ecuador.

    Autentícate con un token de API (`Authorization: Bearer tellen_tk_...`) que
    generas desde tu cuenta de Tellen. Todas las solicitudes actúan sobre una
    cuenta, indicada por su identificador en la ruta:
    `/api/v1/accounts/{account_id}/...`.

    Normalmente ese identificador es el de tu propia cuenta. Si administras
    varias cuentas, usa el identificador de cada una para operar sobre ella. Si
    intentas acceder a una cuenta que no administras, la API responde `404`.
servers:
  - url: https://dashboard.tellen.app
    description: Producción
security:
  - bearerAuth: []
tags:
  - name: Cuentas
    description: Tu cuenta y, si administras varias, las cuentas que gestionas.
  - name: Resumen
    description: Las cifras del mes de una cuenta, lo vendido y comprado y lo que se debe.
  - name: Certificados
    description: >-
      Certificados de firma electrónica (.p12) usados para firmar documentos
      ante el SRI.
  - name: Contactos
    description: Clientes y proveedores de la cuenta.
  - name: Establecimientos
    description: Establecimientos (sucursales) de la cuenta, sincronizados desde el SRI.
  - name: Puntos de emisión
    description: >-
      Puntos de emisión por establecimiento, desde donde se emiten los
      comprobantes.
  - name: Productos
    description: >
      Catálogo de productos y servicios de la cuenta, con su configuración de

      impuestos e inventario.


      **Variantes.** Cada producto tiene al menos una variante interna. Un

      producto de un solo SKU se representa de forma plana (su variante por

      defecto es un detalle de implementación y no aparece en la respuesta), por

      lo que `variants` llega vacío. El arreglo `variants` solo lista variantes

      **con nombre** (talla, color, etc.), cuando existen.


      **Inventario.** El stock vive en las variantes, no en el producto; el
      campo

      `stock` es un consolidado de solo lectura sobre las variantes vendibles.

      Es `null` cuando el producto no controla inventario (todos los servicios,
      y

      los bienes con el control desactivado), lo que permite distinguir "no

      controla stock" de "controla stock, con 0 existencias".


      **El stock no se edita directamente.** Las existencias se mueven a través

      del kardex (entradas y salidas registradas por documentos autorizados,

      compras o ajustes), nunca escribiendo `stock_quantity`. Al **crear** un

      producto puedes fijar las existencias iniciales con `initial_stock`, que
      se

      registra como una entrada en el kardex. En una **actualización**,

      `initial_stock` se ignora.
  - name: Facturas
    description: Facturas de venta (comprobante electrónico 01).
  - name: Notas de crédito
    description: >-
      Notas de crédito (comprobante electrónico 04). Cada una acredita una
      factura autorizada.
  - name: Notas de débito
    description: >-
      Notas de débito (comprobante electrónico 05). Cada una carga a una factura
      autorizada, p. ej. intereses por mora o gastos de cobranza.
  - name: Cotizaciones
    description: |
      Cotizaciones (proformas) para tus clientes. No son comprobantes del SRI;
      se convierten en factura cuando el cliente acepta. Disponibles desde el
      plan Profesional.
  - name: Órdenes
    description: |
      Órdenes de tus clientes: acumulan abonos y se emiten como
      factura cuando los abonos cubren el total. No son comprobantes del SRI.
      Disponibles desde el plan Profesional.
  - name: Comprobantes recibidos
    description: |
      Comprobantes que te emitieron tus proveedores, tal como llegan del SRI.
      Por ahora, los que tienen detalle de productos: facturas, notas de
      crédito y liquidaciones de compra. Siempre son de producción.
  - name: Reportes
    description: |
      Los reportes de la web, con las mismas cifras. Los comprobantes emitidos
      siguen el ambiente de la cuenta (pruebas o producción); los recibidos del
      SRI no tienen ambiente. Requieren poder ver reportes
      (`permissions.read_reports`).
paths:
  /api/v1/accounts/{account_id}/summary:
    parameters:
      - name: account_id
        in: path
        required: true
        description: Identificador de la cuenta.
        schema:
          type: string
          format: uuid
    get:
      tags:
        - Resumen
      summary: Consultar el resumen del mes
      description: >
        Lo vendido y comprado en el mes, y lo que hoy está por cobrar y por

        pagar. Son los mismos totales de los reportes de ventas, cuentas por

        cobrar y cuentas por pagar.


        Ventas, compras propias (liquidaciones) y por cobrar siguen el ambiente

        de la cuenta (pruebas o producción). Las compras recibidas del SRI no

        tienen ambiente. Requiere poder ver reportes
        (`permissions.read_reports`).
      operationId: getAccountSummary
      parameters:
        - name: month
          in: query
          required: false
          description: Mes a resumir, como `AAAA-MM`. Por defecto, el mes en curso.
          schema:
            type: string
            pattern: ^\d{4}-\d{2}$
            example: 2026-10
      responses:
        '200':
          description: El resumen del mes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountSummaryEnvelope'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ReportsForbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    AccountSummaryEnvelope:
      type: object
      required:
        - summary
      properties:
        summary:
          $ref: '#/components/schemas/AccountSummary'
    AccountSummary:
      type: object
      required:
        - month
        - sales
        - receivable
        - purchases
        - payable
      properties:
        month:
          type: string
          description: El mes resumido, como `AAAA-MM`.
          example: 2026-10
        sales:
          type: object
          description: Facturas autorizadas emitidas en el mes.
          required:
            - total
            - count
          properties:
            total:
              type: number
            count:
              type: integer
        receivable:
          type: object
          description: >-
            Lo que hoy deben los clientes por facturas a crédito, sin importar
            el mes.
          required:
            - total
            - overdue
          properties:
            total:
              type: number
            overdue:
              type: number
              description: La parte ya vencida.
        purchases:
          type: object
          description: |
            Facturas y notas de débito recibidas emitidas en el mes, más las
            liquidaciones de compra autorizadas.
          required:
            - total
          properties:
            total:
              type: number
        payable:
          type: object
          description: >-
            Lo que hoy se debe a proveedores por documentos recibidos, sin
            importar el mes.
          required:
            - total
            - count
          properties:
            total:
              type: number
            count:
              type: integer
              description: Documentos con saldo pendiente.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Mensaje de error descriptivo, en español.
  responses:
    Unauthorized:
      description: >-
        Falta el token, o es inválido o está inactivo. Verifica el encabezado
        `Authorization`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ReportsForbidden:
      description: Tu rol no permite ver reportes.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: La cuenta no existe o no la administras.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationError:
      description: Los datos enviados no son válidos.
      content:
        application/json:
          schema:
            type: object
            required:
              - errors
            properties:
              errors:
                type: array
                items:
                  type: string
              field_errors:
                type: object
                description: |
                  Los mismos mensajes agrupados por atributo (`razon_social`,
                  `identificacion`…), para mostrarlos junto a cada campo. Solo
                  viene cuando el error es de validación de datos; los errores
                  que no son de un campo concreto llegan bajo `base`.
                additionalProperties:
                  type: array
                  items:
                    type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Token de API enviado como `Authorization: Bearer tellen_tk_...`. Genera
        tu token desde tu cuenta de Tellen. Tu cuenta debe tener el acceso a la
        API habilitado.

````

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