Die Peppol-API auf einen Blick
Vom API-Schlüssel bis zur ersten Anfrage
Unser Onboarding-Team begleitet Sie bei der Integration und den Tests.
export ACCOUNT_REG_NO=YOUR_ACCOUNT_REGISTRATION_NUMBER
# Identifies the account in every Transaction API requestVerwenden Sie diesen Wert im Anfragepfad für jeden Aufruf der Transaktions-API.
export QVALIA_API_KEY=YOUR_SANDBOX_API_KEY
export QVALIA_BASE_URL=https://api-test.qvalia.comHalten Sie die Anmeldedaten für die Sandbox und die Produktionsumgebung getrennt.
curl -X POST \
${QVALIA_BASE_URL}/transaction/${ACCOUNT_REG_NO}/invoices/outgoing \
-H Authorization:${QVALIA_API_KEY} \
-H Content-Type:application/json \
-d @invoice.jsonDie Antwort bestätigt, dass das Dokument eingegangen ist. Die Validierungsergebnisse und der Zustellstatus werden über Webhooks oder den Dokumentstatus übermittelt.
export QVALIA_API_KEY=YOUR_PRODUCTION_API_KEY
export QVALIA_BASE_URL=https://api.qvalia.comVerfolgen Sie die Bearbeitung und Zustellung über Webhooks oder den Dokumentstatus.
Ein Konto, sechs APIs
Rechnungsstellungs-API
Versenden und empfangen Sie Rechnungen und Gutschriften über Peppol – mit Validierung vor der Übermittlung.
API bestellen
Versenden und empfangen Sie Bestellungen über Peppol, einschließlich Bestellbestätigungen, Änderungen und Stornierungen für den gesamten Bestellprozess.
Partner-API
Erstellen und verwalten Sie Endkundenkonten und Peppol-IDs über Ihre eigene Plattform – mit Webhooks für Dokumentenereignisse.
OCR-API
Extrahieren Sie strukturierte Daten aus PDF-Rechnungen zur Überprüfung und weiteren Verarbeitung.
Enrichment-API
Dokumente und Einzelposten klassifizieren und Transaktionen mit strukturierten Daten anreichern.
Rechnungswesen-API
Erstellen Sie Buchungsvorschläge auf Basis eingehender Rechnungen, um die Prüfung und Verbuchung zu beschleunigen.
Weitere Möglichkeiten, Kontakt aufzunehmen
Wenn eine API-Integration nicht die richtige Lösung ist oder Sie mehr als nur den Austausch von Dokumenten benötigen.
- SFTP
Tauschen Sie Dateien im XML- oder CSV-Format über SFTP aus, wenn eine API-Integration nicht möglich ist. - ERP-Schnittstellen
Fertige Schnittstellen für gängige ERP- und Buchhaltungssysteme. - Peppol-MCP-Server
Bietet KI-Agenten und MCP-Clients strukturierten Zugriff auf Transaktionen, Einzelposten, Lieferstatus und Validierung. - Punchout
Verbinden Sie einen Lieferantenkatalog mit dem Beschaffungssystem des Einkäufers. - B2B-Kasse
Fügen Sie einem WooCommerce-Shop eine B2B-Zahlungs- und Rechnungsstellungsoption hinzu, wobei die Übermittlung über Peppol erfolgt.
Peppol-Referenz für Entwickler
Auf dieser Seite werden die APIs von Qvalia und die darin enthaltenen Peppol-Dokumente behandelt. Der zugrunde liegende Peppol-Standard mit Spezifikationen, Validierungsregeln und Codelisten wird in unserer Peppol-Dokumentation und im Implementierungsleitfaden behandelt. Die vollständige Endpunktreferenz finden Sie unter api.qvalia.io. Die normativen Peppol-Spezifikationen werden von OpenPeppol unter docs.peppol.eu veröffentlicht.
Peppol-Dokumente und deren APIs
| Dokument | Peppol-Spezifikation | Qvalia-API |
| Rechnung | Peppol BIS Billing 3.0 | Rechnungs-APIs |
| Gutschrift | Peppol- BIS Billing s 3.0, Gutschrift | Gutschrifts-APIs |
| Bestellung und Bestellbestätigung | Peppol BIS Ordering | Bestell-APIs, Antwort-APIs für Bestellungen |
| Auftragsvereinbarung | Peppol BIS Order Agreement | Bestellvereinbarung-APIs |
| Änderung und Stornierung von Bestellungen | Peppol BIS Advanced Ordering | APIs zur Bestelländerung, APIs zur Bestellstornierung |
| Versandhinweise | Peppol BIS Despatch Advice | APIs für Versandbenachrichtigungen |
| Katalog | Peppol- BIS Catalogue -Nachricht mit Antwort | Katalog-APIs |
| Lieferstatus | Antwort auf Nachrichtenebene und Status auf Nachrichtenebene | API-Schnittstellen für die Reaktion auf Nachrichtenebene, API-Schnittstellen für den Status auf Nachrichtenebene |
Validierung und Fehler
Codelisten
Adressierung und Nachschlagen
Test und Betrieb
Sandkasten
Testen Sie Ihre Integration mit Ihren eigenen Systemen, ohne dass echte Kunden oder Finanzströme davon betroffen sind.
Versionsverwaltung
Kompatibilitätsbrechende Änderungen werden als neue API-Version veröffentlicht, wobei eine Vorankündigung von mindestens einem Monat erfolgt.
Systemstatus
Aktuelle Informationen zur Verfügbarkeit der Dienste und zu Störungsmeldungen anzeigen.
Sicherheit
Erfahren Sie, wie Qvalia in den Bereichen Informationssicherheit, Geschäftskontinuität und Vertrauen arbeitet.
Peppol für Ihr Unternehmen oder Ihre Kunden?
Peppol Zugangspunkt
Sie möchten Peppol-Dokumente für Ihr eigenes Unternehmen versenden und empfangen. Stellen Sie eine Verbindung zum Peppol-Zugangspunkt von Qvalia her und integrieren Sie diesen in Ihr ERP-System oder über die API.
Partner-Lösungen
Bieten Sie Ihren eigenen Kunden Peppol mit dem Modell an, das am besten zu Ihrer Rolle passt. Integrieren Sie „Embedded Peppol“ über die API von Qvalia in Ihr Produkt oder betreiben Sie einen „Hosted Access Point“ unter Ihrer eigenen Identität als Peppol-Dienstanbieter.
Fragen, die Entwickler stellen
Weitere Hinweise zur Implementierung finden Sie in unserer Wissensdatenbank.
Gibt es eine Testumgebung?
Ja. Die Sandbox unter api-test.qvalia.com verwendet einen separaten API-Schlüssel, sodass Sie Tests durchführen können, ohne dass echte Kunden oder Finanzströme davon betroffen sind. Befolgen Sie die Schritt-für-Schritt-Anleitung zur Peppol-API in der Wissensdatenbank.
Welche Formate akzeptiert die API?
Standardmäßig JSON oder XML. Beide verwenden UBL 2.1-basierte Strukturen für die entsprechenden Peppol-Dokument-Endpunkte. Setzen Sie „Content-Type“ und „Accept“ auf „application/json“ oder „application/xml“. Informationen zu den vom Netzwerk unterstützten Geschäftsdokumenten und -prozessen finden Sie unter „Peppol-Nachrichtentypen “.
Wie kann ich mich authentifizieren?
Mit einem API-Schlüssel im „Authorization“-Header oder mit einem kurzlebigen Token (JWT), das Sie über den Endpunkt /token unter Verwendung Ihres Schlüssels erhalten. Sie erhalten separate Schlüssel für die Test- und die Produktionsumgebung.
Wie kann ich feststellen, ob ein Dokument zugestellt wurde?
Abonnieren Sie Webhooks oder fragen Sie die API ab. Qvalia sendet Ereignisse, wenn ein Dokument eingeht, wenn es zugestellt wird und wenn die Zustellung fehlschlägt. Informationen zu Antwortnachrichten auf Peppol-Ebene finden Sie unter „Status auf Nachrichtenebene “ in der Wissensdatenbank.
Muss ich den Peppol-Transport selbst implementieren?
Nein. Qvalia betreibt den Access Point und übernimmt die Empfängersuche, den AS4-Transport sowie die Zustellung. Sie senden ein Dokument an die API. Lesen Sie hier, wie die SMP- und SML-Service-Discovery den empfangenden Endpunkt ermittelt.
Kann ich die Integration vornehmen, ohne Code zu schreiben?
Ja. Verwenden Sie einen ERP-Konnektor oder tauschen Sie XML- oder CSV-Dateien über SFTP aus.
Welche Peppol-Dokumente kann ich austauschen?
Rechnungen, Gutschriften, Bestellungen, Bestellbestätigungen, Bestellvereinbarungen, Bestelländerungen und -stornierungen, Versandbenachrichtigungen, Kataloge und Antworten auf Nachrichtenebene. Die Tabelle unter „Peppol-Referenz für Entwickler“ enthält die jeweiligen Spezifikationen. Welche Dokumenttypen Ihre Konfiguration umfasst, hängt vom ausgewählten Dienst und der jeweiligen Integration ab. Einen Überblick finden Sie unter „Was sind die Nachrichtentypen in Peppol? “.
Wie ermittelt die API den Endpunkt des Empfängers?
Qvalia nutzt die „ Peppol ID “ des Empfängers, um seinen Service Metadata Publisher (SMP) über den Service Metadata Locator (SML) zu ermitteln. Der SMP gibt die für die Zustellung erforderlichen Dokumentfunktionen sowie den Prozess- und Transport-Endpunkt zurück. Lesen Sie dazu den Artikel „Peppol SMP und SML: So funktioniert die Dienstermittlung“.
Was passiert, wenn ein Dokument die Peppol-Validierung nicht besteht?
Ein Dokument mit einem schwerwiegenden Validierungsfehler muss vor dem Versand korrigiert werden. Der Fehlercode gibt den Regelsatz und den Teil des Dokuments an, der überprüft werden muss. Siehe „So funktioniert die Peppol-Validierung “ und „Peppol-Validierungsregelsätze“.
Wie kann ich die „ Peppol ID “- und Dokumentenfunktionen eines Empfängers überprüfen?
Nutzen Sie die „Peppol ID “-Suche von Qvalia, um den Teilnehmer und die im Verzeichnis veröffentlichten Dokumentfunktionen zu finden. Informationen zur Struktur und zu den Schemata der Identifikatoren finden Sie im Artikel „Was ist ‚ Peppol ID ‘?“ in der Wissensdatenbank.