• 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

Cómo obtener el esquema de un modelo mediante API

La API de FacturaScripts, además de listar, crear, modificar y eliminar registros de modelos, también permite obtener el esquema de la tabla. Para ello simplemente hay que usar el identificador scheme después del endpoint.

Ejemplo

En este ejemplo obtendremos el esquema de la tabla del modelo Familia.

http://localhost:8000/api/3/familias/schema

La API nos devolverá la lista de campos de la tabla:

{
    "codfamilia": {
        "type": "varchar(8)",
        "default": null,
        "is_nullable": "NO"
    },
    "codsubcuentacom": {
        "type": "varchar(15)",
        "default": null,
        "is_nullable": "YES"
    },
    "codsubcuentairpfcom": {
        "type": "varchar(15)",
        "default": null,
        "is_nullable": "YES"
    },
    "codsubcuentaven": {
        "type": "varchar(15)",
        "default": null,
        "is_nullable": "YES"
    },
    "descripcion": {
        "type": "varchar(100)",
        "default": null,
        "is_nullable": "NO"
    },
    "madre": {
        "type": "varchar(8)",
        "default": null,
        "is_nullable": "YES"
    },
    "numproductos": {
        "type": "int(11)",
        "default": "0",
        "is_nullable": "NO"
    }
}