.png)
API Fidly · v1.0
Verbinden Sie Ihre Tools mit Fidly.
Onlineshop, CRM, Kasse, ERP oder Fachanwendung: Die Fidly-API erstellt Ihre Rechnungen, versendet sie über Peppol, importiert Ihre Dokumente und synchronisiert Ihre Geschäftspartner. Schluss mit doppelter Erfassung, Ihre gesetzliche Fakturierung bleibt zentral in Fidly.
✓ REST-API in JSON
✓ OAuth2, Rechte pro Ressource
✓ Isolierte Sandbox
✓ Peppol-Versand per API
Kurz gesagt
01
Ihre Software spricht automatisch mit Fidly.
Mit der Fidly-API kann Ihre Software, oder die eines Partners, die Daten Ihres Unternehmens lesen und schreiben: Dokumente, Geschäftspartner, Bankkonten, Journale und Corporate Designs. Was Sie in der Anwendung tun, kann auch Ihr Code.
01
Aus Ihren Tools fakturieren
Ein Verkauf in Ihrem Shop oder CRM erstellt die Rechnung in Fidly und versendet sie über Peppol.
02
Ihre Dokumente importieren
PDF, Bilder oder Peppol-XML: Fidly analysiert sie wie bei Drag & Drop.
03
Ihre Daten synchronisieren
Kunden, Lieferanten, Lieferadressen, Konten und Journale, ohne doppelte Erfassung.
04
Status verfolgen
Zahlung, Peppol-Versand, Übergabe an den Buchhalter: alles in Echtzeit abrufbar.
Loslegen
02
Vier Schritte bis zu Ihrer ersten Rechnung per API.
1
Schlüssel erstellen
Einstellungen, Reiter API: Bezeichnung, Umgebung (Produktion oder Sandbox), Gültigkeitsdauer und Rechte.
2
Token anfordern
Ihre client_id und Ihr client_secret werden gegen ein Zugriffstoken getauscht, das eine Stunde gültig und erneuerbar ist.
3
In der Sandbox testen
Demodaten, dieselben Prüfungen und Fehlercodes wie in der Produktion, ohne etwas zu verändern.
4
In Produktion gehen
Ein Produktionsschlüssel, und Ihre Integration arbeitet mit Ihren echten Daten.
Erstellen und über Peppol senden, mit einem Aufruf
POST https://api.fidly.be/documents?send_peppol=true
Authorization: Bearer eyJhbGciOi…
{
"type": "sale_invoice",
"relation_id": "8f3c2a…",
"lines": [{
"item_name": "Beratung",
"quantity": 4,
"unit_price": 95,
"vat_code": "standard",
"vat_rate": 21
}]
}
→ 201: Nummer, MwSt., Summen und strukturierte Mitteilung von Fidly berechnet
Was die API abdeckt
03
Der Umfang der API, Ressource für Ressource.
01
Dokumente
Lesen · erstellen · ändern · löschen
–
Typen
Ausgangsrechnungen und Gutschriften, Selbstfakturierung, Proformas und alle empfangenen Dokumente (Peppol, E-Mail, Upload…).
Erstellung
Sie geben den Geschäftspartner und die Positionen an (bis zu 500); Fidly berechnet Nummer, MwSt., Summen, Fälligkeit und strukturierte Mitteilung.
MwSt.
Normalsatz, Befreiung, 0 %, Umkehrung der Steuerschuld, innergemeinschaftlich, Export, nicht MwSt.-pflichtig. Rabatte und Zuschläge pro Position oder pro Dokument.
Peppol-Versand
Bei der Erstellung oder später, mit Statusverfolgung: gesendet, angenommen, abgelehnt. Ein fehlgeschlagener Versand kann wiederholt werden.
Dateien
Download von PDF und UBL-XML, Anhänge (PDF, Bilder, CSV, Tabellen), Import automatisch analysierter Dokumente.
Zahlungen
Erfassung eines Zahlungseingangs, den Fidly nicht sieht (bar, nicht verfolgtes Konto), auch auf einem bereits gesendeten Dokument.
Schutzmechanismen
Ein gesendetes oder an den Buchhalter übergebenes Dokument kann nicht mehr geändert werden; nur die letzte Nummer einer Reihe kann gelöscht werden.
02
Geschäftspartner
Lesen · erstellen · ändern · löschen
–
Firmen und Kontakte
Eine einzige Ressource für Ihre Kunden und Lieferanten, mit Adresse, Sprache, MwSt.-Nummer und Peppol-ID.
Dubletten
Eine bereits bekannte Firma (gleiche MwSt.-Nummer, Kennung oder Peppol-Adresse) wird gemeldet statt doppelt angelegt.
Lieferadressen
Beim Geschäftspartner gespeichert und auf seinen Dokumenten wiederverwendbar, mit ihrer Peppol-ID (GLN).
03
Bankkonten
Lesen · erstellen · ändern
–
Lesen
Verbundene Konten (PSD2), aus CODA-Auszügen oder manuell, mit ihrem Saldo, wenn Fidly ihn synchronisiert.
Verwaltung
Anlage manueller Konten (geprüfte IBAN) und Wahl des Standardkontos auf den Dokumenten.
04
Journale
Lesen · erstellen · ändern
–
Nummerierung
Freies Format (Code, Jahr, Monat, Geschäftsjahr, Zähler) und Rücksetzung monatlich, jährlich oder pro Geschäftsjahr.
Standardjournal
Eines pro Kategorie (Verkäufe, Gutschriften, Einkäufe, Eingang); es erhält die Dokumente, die ohne Journalangabe erstellt werden.
05
Designs und Referenzlisten
Lesen
–
Designs
Die Corporate Designs Ihrer Dokumente und die Wahl des Standarddesigns.
Referenzen
Einheiten, Währungen und Länder, übersetzt ins Französische, Niederländische, Englische und Deutsche.
06
Sicherheit und Konventionen
Für Ihre Entwickler
–
Authentifizierung
OAuth2 Client Credentials, Token für eine Stunde, Einmal-Refresh-Token. Secrets werden bei Fidly gehasht gespeichert.
Schlüssel
Bis zu 10 aktive Schlüssel, gültig von 30 Tagen bis 1 Jahr oder unbegrenzt, sofort widerrufbar.
Rechte
Erstellen, lesen, ändern, löschen: Jede Aktion wird Ressource für Ressource erlaubt.
Konventionen
JSON, paginierte und filterbare Listen, Alles-oder-nichts-Anfragen, Fehler mit lesbarem Code und einer Request-ID für den Support.
Gut zu wissen
04
Bevor Sie loslegen.
Tarif
Die API ist im Growth-Tarif enthalten
Zusammen mit Leistungen, automatischen Erinnerungen und E-Mail-Kampagnen. Ein Sandbox-Schlüssel reicht, um Ihre Integration zu entwickeln und zu testen.
Gut zu wissen
Die API kann mehr als die Anwendung
Sie akzeptiert Kombinationen, die die Oberfläche nicht anzeigt, etwa nicht belgische MwSt.-Sätze oder mehrere Rabatte pro Position. Der Versand per E-Mail ist über die API noch nicht verfügbar: Der Versand erfolgt über Peppol.
FAQ
05
Fragen zur API.
Welcher Tarif enthält die API?
Der Growth-Tarif. Sie können einen Sandbox-Schlüssel erstellen, um Ihre Integration zu entwickeln und zu testen, bevor Sie in Produktion gehen.
Wie erhalte ich meine Schlüssel?
In Ihren Einstellungen, Reiter API, Schaltfläche „Neuer Schlüssel“. Das Client Secret wird nur einmal angezeigt: Bewahren Sie es sicher auf.
Kann ich testen, ohne meine Daten anzurühren?
Ja. Ein Sandbox-Schlüssel arbeitet mit Demodaten, mit genau denselben Prüfungen und Fehlercodes wie in der Produktion, aber es wird nichts gespeichert.
Kann ich meine Rechnungen per API über Peppol senden?
Ja, bei der Erstellung oder später, und Sie verfolgen den Versandstatus bis zur Annahme durch den Empfänger. Der Versand per E-Mail ist über die API noch nicht verfügbar.
Wie begrenze ich, was eine Integration tun darf?
Jeder Schlüssel hat eigene Rechte (erstellen, lesen, ändern, löschen) pro Ressource und eine Gültigkeitsdauer und kann jederzeit über die Oberfläche widerrufen werden.
Welcher Tarif enthält die API?
Der Growth-Tarif. Sie können einen Sandbox-Schlüssel erstellen, um Ihre Integration zu entwickeln und zu testen, bevor Sie in Produktion gehen.
Wie erhalte ich meine Schlüssel?
In Ihren Einstellungen, Reiter API, Schaltfläche „Neuer Schlüssel“. Das Client Secret wird nur einmal angezeigt: Bewahren Sie es sicher auf.
Kann ich testen, ohne meine Daten anzurühren?
Ja. Ein Sandbox-Schlüssel arbeitet mit Demodaten, mit genau denselben Prüfungen und Fehlercodes wie in der Produktion, aber es wird nichts gespeichert.
Kann ich meine Rechnungen per API über Peppol senden?
Ja, bei der Erstellung oder später, und Sie verfolgen den Versandstatus bis zur Annahme durch den Empfänger. Der Versand per E-Mail ist über die API noch nicht verfügbar.
Wie begrenze ich, was eine Integration tun darf?
Jeder Schlüssel hat eigene Rechte (erstellen, lesen, ändern, löschen) pro Ressource und eine Gültigkeitsdauer und kann jederzeit über die Oberfläche widerrufen werden.
Welcher Tarif enthält die API?
Der Growth-Tarif. Sie können einen Sandbox-Schlüssel erstellen, um Ihre Integration zu entwickeln und zu testen, bevor Sie in Produktion gehen.
Wie erhalte ich meine Schlüssel?
In Ihren Einstellungen, Reiter API, Schaltfläche „Neuer Schlüssel“. Das Client Secret wird nur einmal angezeigt: Bewahren Sie es sicher auf.
Kann ich testen, ohne meine Daten anzurühren?
Ja. Ein Sandbox-Schlüssel arbeitet mit Demodaten, mit genau denselben Prüfungen und Fehlercodes wie in der Produktion, aber es wird nichts gespeichert.
Kann ich meine Rechnungen per API über Peppol senden?
Ja, bei der Erstellung oder später, und Sie verfolgen den Versandstatus bis zur Annahme durch den Empfänger. Der Versand per E-Mail ist über die API noch nicht verfügbar.
Wie begrenze ich, was eine Integration tun darf?
Jeder Schlüssel hat eigene Rechte (erstellen, lesen, ändern, löschen) pro Ressource und eine Gültigkeitsdauer und kann jederzeit über die Oberfläche widerrufen werden.
Hallo, ich bin Chloé,
Eine Frage zu Fidly, den Funktionen oder dem Einstieg? Ich berate und begleite Sie gern.
Mit uns sprechenEine Frage zu Fidly, den Funktionen oder dem Einstieg? Ich berate und begleite Sie gern.