API REST de Frihet
Acceso programático a facturas, clientes, gastos, productos y presupuestos. Diseñada para integraciones que escalan.
Hecha para desarrolladores
Actualizaciones parciales PATCH
Actualiza solo los campos que necesitas. Schemas parciales validados con Zod garantizan la integridad.
Búsqueda y filtros
Búsqueda full-text con parámetro ?q=. Mapeo de campos por recurso para resultados precisos.
Operaciones batch
Crea hasta 50 recursos en una sola petición. Respuestas HTTP 207 multi-status.
Claves de idempotencia
Reintenta peticiones de forma segura con el header Idempotency-Key. Las claves se reconocen durante 24 horas.
Headers de límite de tasa
X-RateLimit-Limit, Remaining y Reset en cada respuesta. Planifica en consecuencia.
Spec OpenAPI 3.1
Especificación legible por máquinas en /openapi.yaml. 16 paths, 18 schemas. Genera SDKs automáticamente.
Endpoints de inteligencia
Contexto de negocio, resúmenes mensuales y datos fiscales trimestrales vía /context, /monthly, /quarterly.
Eliminación segura VeriFactu
Soft delete para facturas y presupuestos no borrador. Trazabilidad completa para cumplimiento fiscal español.
Endpoints
Muestra representativa de endpoints core — la especificación completa OpenAPI 3.1 cubre 82 rutas y 137 operaciones.
| Method | Path |
|---|---|
| GET | /v1/invoices |
| POST | /v1/invoices |
| PATCH | /v1/invoices/:id |
| DELETE | /v1/invoices/:id |
| POST | /v1/invoices/batch |
| GET | /v1/clients |
| POST | /v1/clients |
| GET | /v1/expenses |
| POST | /v1/expenses |
| GET | /v1/products |
| GET | /v1/quotes |
| GET | /v1/context |
| GET | /v1/monthly |
| GET | /v1/quarterly |
| GET | /openapi.yaml |
Ejemplos de código
import { Frihet } from '@frihet/sdk';
const apiKey = process.env.FRIHET_API_KEY;
if (!apiKey) throw new Error('Set FRIHET_API_KEY before running this example');
const frihet = new Frihet({ apiKey });
// Follow each page's nextCursor until all paid invoices have been read.
let cursor: string | undefined;
do {
const page = await frihet.invoices.list({ status: 'paid', limit: 25, cursor });
for (const invoice of page.data) {
console.log(invoice.documentNumber, invoice.total);
}
cursor = page.nextCursor;
} while (cursor);
Autenticación
Genera claves API desde Ajustes > API en tu panel de Frihet. Incluye tu clave como Bearer token en el header Authorization.
Authorization: Bearer fri_...
Empieza a integrar hoy
Acceso a la API incluido en todos los planes. Tu clave API está lista en Ajustes.
Empieza gratis