API REST
API REST de FacturaDirecta: guías de autenticación, paginación, errores e idempotencia, y referencia de cada recurso con ejemplos listos para copiar.
La API pública de FacturaDirecta es una API REST con JSON. Con ella puedes crear y consultar facturas, presupuestos, gastos, contactos, productos, nóminas o apuntes contables, y suscribirte a webhooks para enterarte al momento de cada cambio.
Está disponible en todos los planes, también en el Gratis, y cada empresa puede tener sus propios entornos de pruebas con API keys independientes.
- Autenticación: API key por empresa en la cabecera
facturadirecta-api-key, u OAuth 2.0 con PKCE para actuar en nombre de un usuario. Ver Autenticación. - Límites: sin cupo mensual de peticiones, solo un límite de ritmo por minuto que depende del plan. Ver precios.
- Contrato: la especificación OpenAPI completa está siempre publicada y al día.
Guías
API Pública de FacturaDirecta
Conecta tu software con FacturaDirecta mediante la API REST pública. Accede a contactos, productos, facturas, presupuestos, albaranes, …
Inicio rápido con la API
Haz tu primera llamada a la API de FacturaDirecta en minutos. Guía paso a paso con ejemplos de cURL.
Autenticación
La API pública de FacturaDirecta soporta dos métodos de autenticación, OAuth2 y API key.
Paginación y filtros estándar
La API pública usa tres patrones de listado distintos, no uno. Cada operación que devuelve una lista escoge el patrón que mejor encaja con …
Errores y validaciones
Las respuestas de error de la API pública siguen siempre la misma forma base, independientemente del recurso.
Idempotencia y reintentos seguros
Cuando una petición que modifica datos termina en timeout o se corta la conexión, no sabes si el servidor llegó a ejecutarla.
Versiones de documentos
Cada vez que se crea, modifica, elimina o recupera un documento, FacturaDirecta guarda una copia completa de cómo queda.
Catálogo de impuestos
Esta guía trata los tipos impositivos que se aplican a las líneas de los documentos (IVA, IRPF, IGIC…).
VeriFactu
Esta guía cubre cómo se integra VeriFactu con la API pública de FacturaDirecta.
TicketBAI
Esta guía cubre cómo se integra TicketBAI con la API pública de FacturaDirecta.
Facturas rectificativas
Una factura rectificativa corrige una factura emitida previamente.
Facturas sustitutivas (F3)
Una factura sustitutiva es una factura completa que reemplaza a un conjunto de facturas simplificadas previamente emitidas.
Flujo de pedidos y órdenes de compra
El pedido de cliente (clientOrder) registra un encargo en firme de un cliente antes de su entrega y facturación.
Ventas
Facturas de venta
Una factura de venta (invoice) es el documento fiscal que emite la empresa para cobrar a sus clientes.
16 operacionesFacturas de venta recurrentes
Una factura recurrente es una plantilla de factura programada: cuando llega el momento configurado, FacturaDirecta genera automáticamente la …
10 operacionesPresupuestos
Un presupuesto es una propuesta económica que envías a un cliente antes de emitir la factura correspondiente.
13 operacionesPedidos
Un pedido de cliente registra un encargo en firme de un cliente antes de su entrega y facturación.
13 operacionesCompras y gastos
Facturas de compra y tickets
Una factura de compra representa un gasto: una factura que has recibido de un proveedor, o un ticket de caja (con o sin identificación …
12 operacionesÓrdenes de compra
Una orden de compra registra un encargo en firme a un proveedor antes de la recepción de la mercancía y su facturación.
13 operacionesBandeja de entrada
La bandeja de entrada (inbox) es el flujo para incorporar documentos externos (PDFs de facturas de proveedores, tickets escaneados o …
7 operacionesUploads (subida de archivos)
El recurso uploads permite subir archivos binarios a FacturaDirecta para luego vincularlos como adjuntos a documentos (facturas, gastos, …
2 operacionesContactos y productos
Contactos
Un contacto representa una persona física o empresa con la que mantienes una relación contable: clientes a los que facturas, proveedores de …
8 operacionesProductos
Un producto es un concepto facturable preconfigurado que se reutiliza en líneas de documentos (facturas, presupuestos, albaranes, facturas …
10 operacionesCampos personalizados
El recurso customFields permite descubrir y gestionar las definiciones de campos personalizados de una empresa.
6 operacionesTesorería
Bancos y cuentas de tesorería
Un banco (bank) en FacturaDirecta es una cuenta de tesorería de la empresa: una cuenta corriente con IBAN, una cuenta de tarjeta o una caja …
4 operacionesExtractos bancarios
Un extracto bancario (statement) es un movimiento individual de una cuenta bancaria sincronizada con FacturaDirecta.
5 operacionesContabilidad, impuestos y nóminas
Diario contable
El diario contable es la lista cronológica de apuntes (líneas de asiento) generados por todos los documentos contabilizables de la empresa: …
1 operacionesInformes
Los informes devuelven, ya calculadas, las mismas cifras que los informes de la web. Son de solo lectura y se generan en el momento a partir …
5 operacionesDeclaraciones de impuestos
Una declaración de impuestos (taxDeclaration) es un modelo de impuestos que el usuario ha generado y guardado en FacturaDirecta desde la …
5 operacionesNóminas
Una nómina (payroll) representa la retribución mensual a un empleado: salario bruto, deducciones, retenciones de IRPF y aportaciones de …
12 operacionesCuenta y configuración
Configuración de la empresa
Bajo /settings/… vive la configuración de la empresa que la API pública expone como solo lectura: la ficha de la empresa y su forma de …
5 operacionesPerfil de usuario
El recurso profile devuelve los datos básicos del usuario autenticado y las empresas disponibles para la credencial actual.
1 operacionesAPI keys
Una API key es una credencial por empresa para autenticar integraciones de máquina a máquina.
5 operacionesActividad
El registro de actividad es el historial de lo que pasa en la empresa: altas, modificaciones y eliminaciones de documentos, envíos por email …
1 operacionesBúsqueda y análisis
Búsqueda
La búsqueda global localiza en una sola llamada cualquier elemento de la empresa a partir de un texto: un cliente por su nombre o su NIF, …
1 operacionesConsulta analítica
La consulta analítica agrega los datos de la empresa en una sola llamada: eliges una fuente, las medidas que quieres sumar, las dimensiones …
1 operacionesWebhooks
Webhooks
Los webhooks notifican en tiempo real cuando ocurren cambios en los recursos de tu empresa.
%!d(float64=41) eventos