Introducción
La API de Faxtal permite que un programa tuyo trabaje con las facturas de una empresa sin pasar por la aplicación: guardar borradores, emitir, registrar facturas recibidas y consultar su estado ante Hacienda.
Qué es
- Una API REST sobre HTTPS que recibe y devuelve JSON.
- URL base:
https://app.faxtal.com/api/v1.1. - Se autentica con una API key en la cabecera
X-API-Key. Cada clave pertenece a una sola empresa, así que la empresa no va en la URL. - Las facturas se envían en el formato canónico
json_1_1. Es el mismo contrato para borradores, emitidas y recibidas.
Para quién es
Para quien conecta un programa propio con Faxtal. Por ejemplo:
- un ERP o un programa de gestión que emite sus facturas a través de Faxtal;
- una tienda online que factura cada pedido;
- un proceso que registra las facturas de los proveedores;
- un script que revisa los envíos a VeriFactu o al SII.
Qué cubre
| Recurso | Rutas | Para qué |
|---|---|---|
| General | GET /health | Comprobar que la API responde. No pide API key. |
| Empresa | /company, /companies, /certificates | Consultar la empresa de la clave y sus certificados. |
| Borradores | /drafts | Guardar, validar, consultar y borrar borradores de facturas emitidas. |
| Facturas emitidas | /issued-invoices | Emitir un borrador, importar facturas emitidas fuera de Faxtal, anular, enviar por email, descargar el PDF, exportar a FacturaE, UBL o CII y adjuntar documentos. |
| Facturas recibidas | /received-invoices | Registrar recibidas en JSON o importarlas desde FacturaE, UBL o CII, validarlas, descargar el PDF y adjuntar documentos. |
| Terceros y productos | /third-parties, /products, /received-invoices/recognize | Buscar y dar de alta terceros, buscar productos y obtener una propuesta de factura recibida a partir de un documento. |
| VeriFactu | /verifactu/..., /invoices/{invoice_id}/verifactu/... | Configuración, registros, envíos, incidencias y eventos del sistema de facturación. |
| SII | /sii/..., /invoices/{invoice_id}/sii/status | Configuración, facturas pendientes, vencimientos y envíos al SII. |
Cada operación, con sus parámetros y esquemas, está en la referencia interactiva.
Qué no cubre
- Crear API keys, usuarios o series. Se gestiona en la aplicación.
- Varias empresas con una misma clave. Cada clave es de una empresa. Ver Multiempresa.
- Avisos a tu sistema cuando cambia una factura. La API no llama a tu sistema: consulta el estado con las operaciones de lectura. Ver Webhooks.
Por dónde seguir
- Primeros pasos: de la API key a la primera llamada.
- Autenticación: la clave, sus permisos y los límites de uso.
- Conceptos: estados, series, paginación e idempotencia.
- Formato canónico: el contrato de la factura.