• Antes de empezar a programar +
  • Sistema de Prioridades de Plugins
  • Diagramas de tablas
  • Cómo hacer un pull-request
• Creación de Plugins +
  • El archivo facturascripts.ini
  • El archivo Init.php
  • Los Controladores +
    • Controladores extendidos +
      • ListController en FacturaScripts +
        • addFilterAutocomplete()
        • addFilterCheckbox()
        • addFilterDatePicker()
        • addFilterNumber()
        • addFilterPeriod()
        • addFilterSelect()
        • addFilterSelectWhere()
      • EditController
      • PanelController +
        • addHtmlView()
        • addEditView()
        • addEditListView()
        • addListView()
      • Personalizando con Settings
      • Método disableColumn()
      • Interacción con las Vistas
    • Obtener Parámetros de la URL, Formularios o Cookies
    • Cómo guardar una cookie
    • Consultar el usuario y sus permisos
    • Formularios de edición de facturas, albaranes, etc
  • Añadir un Endpoint a la API
  • Los modelos +
    • Operaciones comunes con modelos
    • XML de la tabla
    • Modelos de Más de Una Tabla
    • Modelos Especiales
    • Cómo crear una factura, albarán, pedido o presupuesto
    • Herencia de Modelos
    • $modelo->getModelFields()
    • $modelo->all()
    • $modelo->clear()
    • $modelo->count()
    • $modelo->delete()
    • $modelo->loadFromData()
    • $modelo->install()
    • $modelo->exists()
    • $modelo->get()
    • $modelo->load() ...
    • $modelo->primaryColumnValue()
    • $modelo->primaryColumn()
    • $modelo->newCode()
    • $modelo->save()
    • $modelo->primaryDescription()
    • $modelo->tableName()
    • $modelo->primaryDescriptionColumn()
    • $modelo->url()
    • $modelo->test()
  • Las vistas HTML +
    • Iconos disponibles
    • Herencia de plantillas
  • Las vistas XML (XMLView) +
    • Columns
    • Rows +
      • Row status
      • Row statistics
      • Row actions
      • Row header y footer
    • Modals
    • Group
    • Column
    • Widgets +
      • Autocomplete
      • Bytes
      • Checkbox
      • Color
      • Datalist
      • Date
      • Datetime
      • File
      • Library
      • Link
      • Money
      • Number
      • Password
      • Select
      • Stars
      • Text
      • Textarea
      • Time
      • Subcuenta
      • Radio
      • Variante
  • Las traducciones en Plugins
  • Las extensiones +
    • Extensiones de controladores
    • Extensiones de modelos
    • Extensiones de tablas
    • Extensiones de XMLView
    • Extensiones de Vistas HTML
  • Mostrar mensajes, errores y alertas
  • Acceso a la Base de Datos +
    • DbQuery
    • Where
    • DataBaseWhere (obsoleta)
  • Settings: opciones del panel de control +
    • Cómo crear preferencias de aplicación para su plugin
  • Generación de PDF y Excel
  • AssetManager
  • El archivo Cron.php
  • Cómo publicar plugins
• Profundizando en el CORE +
  • Enrutado
  • Gestión de Errores
  • Gestión de Plugins
  • La cola de trabajos
  • La clase Request
  • La clase Response
  • Uso de la caché
  • Descarga archivos de MyFiles
  • La clase Tools
  • Cliente de API de OpenAI
  • Cliente HTTP +
    • Conectar con otro FacturaScripts mediante API
  • Validar Emails, Cadenas y URLs
  • Enviar emails con NewMail
• Test unitarios en plugins +
  • Añadir github action
• Migración de plugins antiguos +
  • Row Business (Obsoleto)
  • Migrar los XML de las tablas de 2017
  • Migrar Modelos de 2017
  • addGridView() - (obsoleto)
  • ¿Qué versión de Symfony utiliza?
  • ModelOnChange (obsoleto)
• La API REST
  • Listado de recursos
  • Listar, filtrar y ordenar registros
  • Obtener un registro concreto
  • Crear o añadir registros
  • Cómo crear facturas, albaranes ...
  • Marcar factura como pagada
  • Hacer una factura rectificativa
  • Obtener el PDF de una factura, albarán ...
  • Subir archivos
  • Modificar registros
  • Eliminar registros
  • Obtener esquema modelo

Obtener el PDF de una factura desde la API

A partir de la versión 2024.5 de FacturaScripts ya es posible descargar el PDF de una factura de cliente a través de la API. Simplemente hay que hacer una petición GET al endpoint api/3/exportarFacturaCliente/123, reemplazando 123 por el id de la factura.

También es posible obtener un Excel o CSV usando el parámetro type (admite PDF, XLS y CSV). Siguiendo el ejemplo anterior, si queremos la factura en Excel, haríamos la siguiente llamada: api/3/exportarFacturaCliente/123?type=XLS.

Parámetros opcionales disponibles en todos los endpoints de exportación:

• type: formato de salida. Valores admitidos PDF (por defecto), XLS y CSV.
• lang: código de idioma (por ejemplo es_ES o en_EN) para generar el documento traducido.
• format: identificador numérico del formato de impresión a utilizar. Si no se indica, se aplica el formato predeterminado del documento. Aquí puedes leer más sobre los formatos de impresión personalizados en la documentación de formatos de impresión.

Ejemplo:

GET 'https://miFacturaScripts.com/api/3/exportarFacturaCliente/123?type=PDF&lang=es_ES'

Albaranes, pedidos y presupuestos

Siguiendo el mismo patrón es posible exportar el resto de documentos de ventas y compras usando estos endpoints:

• api/3/exportarAlbaranCliente/{id}
• api/3/exportarAlbaranProveedor/{id}
• api/3/exportarFacturaProveedor/{id}
• api/3/exportarPedidoCliente/{id}
• api/3/exportarPedidoProveedor/{id}
• api/3/exportarPresupuestoCliente/{id}
• api/3/exportarPresupuestoProveedor/{id}

Si trabajas con formatos de impresión personalizados, añade el parámetro format con el identificador numérico del formato que quieras aplicar. Por ejemplo: api/3/exportarFacturaCliente/123?type=PDF&format=5 devolverá la factura usando el formato 5. Si no se indica ningún format se usará el formato predeterminado del documento.