Überblick über die API

Die NovaFisko-API ist die Schnittstelle, die die Anwendung selbst im Web, auf dem Desktop und auf Mobilgeräten verwendet. Alles, was Sie in den Reitern Buchungen, Belege, Bank, MwSt., Exporte oder Peppol sehen, läuft über sie. Ihre Integration verfügt daher über genau dieselben Möglichkeiten: ein Mandat anlegen, eine Rechnung samt PDF übermitteln, das Hauptbuch lesen, die vollständige Akte eines Geschäftsjahres herunterladen oder Änderungen fortlaufend verfolgen.

Kurz gefasst#

Mit einem minimalen Aufruf ohne Authentifizierung prüfen Sie, ob der Dienst antwortet:

curl https://api.novafisko.com/v1/status

{
  "ok": true,
  "time": "2026-10-05T08:12:44+00:00"
}

GET /v1/ping liefert dieselbe Information in der Form {"ok": true, "server_time": "..."}, ohne die Datenbank zu berühren. Verwenden Sie diese Route als Verbindungstest.

Umgebungen#

Es gibt keinen separaten Test-Host. Die Sandbox ist eine Demo-Kanzlei, die auf derselben API läuft: Sie erhalten ein Token mit einem einzigen Aufruf, ohne ein Konto anzulegen.

curl -X POST https://api.novafisko.com/v1/auth/demo \
  -H "Content-Type: application/json" \
  -d '{"locale": "fr", "device_name": "integration-sandbox"}'

{
  "token": "412|Qm9uam91ciBsZSBtb2RlIGTDqW1v",
  "user": {
    "id": 9034,
    "name": "Visiteur démo",
    "email": "demo-7f3a9c@demo.novafisko.com",
    "locale": "fr",
    "is_platform_admin": false,
    "is_demo": true,
    "firms": [
      {"public_token": "Fd7hQ2mN8sXa", "name": "Fiduciaire Démo", "role": "manager"}
    ],
    "managed_firms": [
      {"public_token": "Fd7hQ2mN8sXa", "name": "Fiduciaire Démo"}
    ]
  },
  "demo": {
    "firm": {"public_token": "Fd7hQ2mN8sXa", "name": "Fiduciaire Démo"},
    "companies": [
      {"public_token": "k3Jd9fPq2LmX", "code": "COMPTOIR", "name": "Le Comptoir Montois SRL"},
      {"public_token": "Pw8sTz4YbN1c", "code": "PIXELWERK", "name": "Pixelwerk SRL"},
      {"public_token": "Lb5vRe7HuK2d", "code": "LAMBERT", "name": "Lambert Électricité"},
      {"public_token": "Sc2oUv9XaM6e", "code": "SCENES", "name": "Scènes Ouvertes ASBL"}
    ],
    "expires_at": "2026-10-06T08:12:44+00:00",
    "resets_at": "2026-10-06T03:15:00+02:00"
  }
}

Die Demo-Kanzlei enthält vier fiktive belgische Mandate mit zwei Geschäftsjahren, Buchungen, Kontoauszügen, MwSt.-Erklärungen und zu prüfenden Belegen. Sie können dort nach Belieben schreiben.

Ist die Demo-Kanzlei vorübergehend nicht verfügbar, antwortet der Aufruf mit 503 und dem Code demo_unavailable.

Formate#

• Request-Bodys sind JSON (Content-Type: application/json), mit Ausnahme des Datei-Uploads, der multipart/form-data verwendet.
• Antworten sind immer JSON, auch im Fehlerfall, mit Ausnahme der Exporte (PDF, XLSX, CSV, ZIP, XML), die die Datei zurückgeben.
• Datumsangaben folgen ISO 8601, Beträge sind Dezimalzeichenfolgen mit Punkt. Einzelheiten finden Sie unter Konventionen.
• Fehler haben eine einheitliche Form {message, code, errors}, die unter Fehler und Limits beschrieben ist.

Bereitgestellte Werkzeuge#

Die Spezifikation beschreibt jede Route mit ihren Parametern, ihren Schemas und Beispielen. Sie können sie in Postman, Insomnia oder Bruno importieren oder mit dem Werkzeug Ihrer Wahl einen Client generieren.

Was die API abdeckt#

Wo Sie anfangen#

1. Besorgen Sie sich ein Token: Lesen Sie Authentifizierung.
2. Gehen Sie die Konventionen durch, um Formatfallen zu vermeiden.
3. Folgen Sie einem Anwendungsfall, zum Beispiel Eine Einkaufsrechnung übermitteln.
4. Binden Sie die Webhooks an, um über Änderungen benachrichtigt zu werden, statt die API abzufragen.

Siehe auch#

• Authentifizierung
• Fehler und Limits
• Versionsrichtlinie
• API-Referenz