> ## 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.

# Registrar un abono

> Registra un abono en una orden abierta. No puede superar el saldo
pendiente. Devuelve la orden actualizada.




## OpenAPI

````yaml /api-reference/openapi.yaml post /api/v1/accounts/{account_id}/orders/{order_id}/collections
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}/orders/{order_id}/collections:
    parameters:
      - name: account_id
        in: path
        required: true
        description: Identificador de la cuenta.
        schema:
          type: string
          format: uuid
      - name: order_id
        in: path
        required: true
        description: Identificador de la orden.
        schema:
          type: string
          format: uuid
    post:
      tags:
        - Órdenes
      summary: Registrar un abono
      description: |
        Registra un abono en una orden abierta. No puede superar el saldo
        pendiente. Devuelve la orden actualizada.
      operationId: createOrderCollection
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CollectionCreateRequest'
      responses:
        '201':
          description: La orden con el abono registrado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderEnvelope'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/OrdersForbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    CollectionCreateRequest:
      type: object
      required:
        - collection
      properties:
        collection:
          type: object
          required:
            - amount
            - forma_pago
          properties:
            amount:
              type: number
              description: Monto del abono; no puede superar el saldo pendiente.
            forma_pago:
              type: string
              description: >-
                Código SRI de forma de pago: `01` sin sistema financiero
                (efectivo), `19` tarjeta de crédito, `20` otros con sistema
                financiero (p. ej. transferencia)
            collected_on:
              type: string
              format: date
              description: Fecha del abono (por defecto hoy; no puede ser futura).
            notes:
              type: string
    OrderEnvelope:
      type: object
      required:
        - order
      properties:
        order:
          $ref: '#/components/schemas/Order'
    Order:
      allOf:
        - $ref: '#/components/schemas/OrderSummary'
        - type: object
          required:
            - contact
            - emission_point
            - notes
            - ready_to_emit
            - invoice_id
            - total_without_taxes
            - total_discount
            - taxes
            - total_ice
            - created_at
            - items
            - collections
          properties:
            contact:
              type: object
              required:
                - id
                - razon_social
                - identificacion
              properties:
                id:
                  type: string
                  format: uuid
                razon_social:
                  type: string
                identificacion:
                  type: string
            emission_point:
              description: >-
                Punto de emisión con el que se facturará; necesario para
                emitirlo.
              anyOf:
                - $ref: '#/components/schemas/EmissionPointReference'
                - type: 'null'
            notes:
              type:
                - string
                - 'null'
            ready_to_emit:
              type: boolean
              description: >-
                `true` si está abierto, tiene punto de emisión y los abonos
                cubren el total.
            invoice_id:
              type:
                - string
                - 'null'
              format: uuid
              description: La factura en que se emitió, si ya se emitió.
            total_without_taxes:
              type: number
            total_discount:
              type: number
            taxes:
              type: array
              description: Base e IVA por tipo de IVA, como los totaliza el RIDE.
              items:
                $ref: '#/components/schemas/TaxTotal'
            total_ice:
              type: number
            created_at:
              type: string
              format: date-time
            items:
              type: array
              items:
                $ref: '#/components/schemas/DocumentDetail'
            collections:
              type: array
              description: Abonos, del más reciente al más antiguo.
              items:
                $ref: '#/components/schemas/Collection'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Mensaje de error descriptivo, en español.
    OrderSummary:
      type: object
      required:
        - id
        - number
        - status
        - emission_date
        - contact_name
        - total
        - collected_amount
        - outstanding_amount
      properties:
        id:
          type: string
          format: uuid
        number:
          type: string
          description: Número de la orden, p. ej. `ORD-000042`.
        status:
          type: string
          enum:
            - open
            - cancelled
            - emitted
        emission_date:
          type: string
          format: date
        contact_name:
          type: string
          description: Razón social del cliente.
        total:
          type: number
          description: Total de la orden, con impuestos.
        collected_amount:
          type: number
          description: Suma de los abonos registrados.
        outstanding_amount:
          type: number
          description: Lo que falta abonar para cubrir el total.
    EmissionPointReference:
      type: object
      description: >-
        El punto de emisión de un documento, con los códigos del SRI y los
        nombres para mostrar.
      required:
        - id
        - code
        - description
        - store_code
        - store_name
      properties:
        id:
          type: string
          format: uuid
        code:
          type: string
          description: Código del punto de emisión, p. ej. `001`.
        description:
          type:
            - string
            - 'null'
          description: Nombre del punto de emisión, p. ej. "Caja 1".
        store_code:
          type:
            - string
            - 'null'
          description: Código del establecimiento, p. ej. `002`.
        store_name:
          type:
            - string
            - 'null'
          description: Nombre del establecimiento.
    TaxTotal:
      type: object
      required:
        - code
        - label
        - rate
        - base
        - iva
      properties:
        code:
          type: string
          description: Código de porcentaje de IVA del SRI.
        label:
          type: string
          description: Como lo nombra el RIDE, p. ej. "IVA 15%" o "no objeto de IVA".
        rate:
          type: number
        base:
          type: number
          description: Subtotal gravado con este tipo de IVA.
        iva:
          type: number
    DocumentDetail:
      type: object
      required:
        - id
        - product_id
        - product_variant_id
        - code
        - description
        - quantity
        - unit_price
        - discount
        - subtotal
        - tax_rate
        - tax_value
        - ice_rate
        - total
      properties:
        id:
          type: string
          format: uuid
        product_id:
          type:
            - string
            - 'null'
          format: uuid
        product_variant_id:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            Variante facturada. Para editar el documento, reenvíala como
            `product_variant_id`.
        code:
          type:
            - string
            - 'null'
        description:
          type: string
        quantity:
          type: number
        unit_price:
          type: number
        discount:
          type: number
        subtotal:
          type: number
        tax_rate:
          type: number
          description: Porcentaje de IVA aplicado.
        tax_value:
          type: number
        ice_rate:
          type:
            - number
            - 'null'
          description: Porcentaje de ICE del ítem, o `null` si no grava ICE.
        total:
          type: number
    Collection:
      type: object
      required:
        - id
        - amount
        - collected_on
        - forma_pago
        - forma_pago_label
        - notes
      properties:
        id:
          type: string
          format: uuid
        amount:
          type: number
        collected_on:
          type: string
          format: date
        forma_pago:
          type: string
          description: Código SRI de forma de pago.
        forma_pago_label:
          type: string
          description: Nombre SRI de la forma de pago.
        notes:
          type:
            - string
            - 'null'
  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'
    OrdersForbidden:
      description: >-
        Tu plan no incluye órdenes (disponibles desde Profesional), o tu rol no
        permite esta acción.
      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.