Passer au contenu

API REST de Frihet

Accès programmatique aux factures, clients, dépenses, produits et devis. Conçue pour des intégrations qui évoluent.

https://api.frihet.io/v1 v1 — 2026-03-18 OpenAPI 3.1 · 82 paths · 137 operations

Conçue pour les développeurs

Mises à jour partielles PATCH

Mettez à jour uniquement les champs dont vous avez besoin. Les schémas partiels validés avec Zod garantissent l'intégrité.

Recherche et filtres

Recherche en texte intégral avec le paramètre ?q=. Mappage des champs par ressource pour des résultats précis.

Opérations par lots

Créez jusqu'à 50 ressources en une seule requête. Réponses HTTP 207 multi-statut.

Clés d'idempotence

Réessayez les requêtes en toute sécurité avec l'en-tête Idempotency-Key. Les clés sont reconnues pendant 24 heures.

En-têtes de limite de débit

X-RateLimit-Limit, Remaining et Reset dans chaque réponse. Planifiez en conséquence.

Spécification OpenAPI 3.1

Spécification lisible par machine dans /openapi.yaml. 16 chemins, 18 schémas. Génère des SDKs automatiquement.

Endpoints d'intelligence

Contexte métier, résumés mensuels et données fiscales trimestrielles via /context, /monthly, /quarterly.

Suppression sécurisée VeriFactu

Soft delete pour les factures et devis non brouillons. Traçabilité complète pour la conformité fiscale espagnole.

Endpoints

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

Exemples de code

                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);
              

Authentification

Générez des clés API depuis Paramètres > API dans votre tableau de bord Frihet. Incluez votre clé en tant que jeton Bearer dans l'en-tête Authorization.

Authorization: Bearer fri_...

Commencez à intégrer aujourd'hui

L'accès à l'API est inclus dans tous les plans. Votre clé API est prête dans Paramètres.

Démarrer Gratuitement