Referencia de endpoints
La referencia completa y siempre actualizada se genera a partir de la especificación OpenAPI de la API en funcionamiento:
- Abrir la referencia interactiva →: todos los endpoints, parámetros, peticiones y respuestas, navegables y con búsqueda (Redoc).
- Descargar la especificación OpenAPI (JSON) →: la especificación en crudo, para importar en Postman/Insomnia, generar un cliente o alimentar tus propias herramientas.
Como se genera directamente desde el backend en ejecución, nunca se desincroniza
de la API real. Todas las rutas son relativas a la
URL base y requieren un
token Bearer; los importes van en
céntimos y los nombres de campo son snake_case.
Un flujo de integración típico
- Crea el destinatario con
POST /v1/entities(o reutiliza uno existente deGET /v1/entities). - (Opcional) Previsualiza los impuestos con
POST /v1/taxes/prefill. - Crea el borrador con
POST /v1/invoices. - Emítelo con
POST /v1/invoices/{id}/issue: asigna el número de factura y, para emisores españoles, la comunica a la AEAT. - Descarga el PDF con
GET /v1/invoices/{id}/pdf.
Si estás establecido en España
La emisión está bloqueada hasta que hayas otorgado el apoderamiento ante la
AEAT y la AEAT lo haya confirmado (se comprueba una vez al día: confirmar el
otorgamiento en la app no levanta el bloqueo por sí solo). Hasta entonces la
factura sigue siendo un borrador y issue devuelve 403 con
error: "verifactu_authorization_required". Consulta la
guía de Veri*Factu.
Una petición mutante realizada con un token de API que no presenta una
cabecera X-Human-Proof válida no se ejecuta: se registra para revisión humana
y devuelve 202 pending_approval. Después, una persona la aprueba (la reejecuta)
o la rechaza. Consulta la guía de Auditoría de IA.