Docs
DE

Sprache wählen

eurinvoice.com
Docs
DE

Sprache wählen

API-Referenz

Jede Operation, die ein Partner aufrufen kann, erzeugt aus der OpenAPI-Datei.

  • In der Sandboxgebaute Operationen
  • Geplantgeplante Operationen

In einfachen Worten

Jeder Aufruf, den ein Partner machen kann, erzeugt aus der OpenAPI-Datei der API. Die Basisadresse der Sandbox ist https://api-sandbox-eu.eurinvoice.com.

Jede Seite unten wird aus der OpenAPI-Datei in Version 0.19.3 erzeugt, gegen die der Service getestet wird. Wo eine aufgezeichnete Antwort gezeigt wird, stammt sie vom Service und ist auf ihrer Seite datiert. Die Seiten in Abschnitt 3 erklären die Aufrufe in einfachen Worten.

Operationen, die der Service hat

AufrufWas er tutStatus
GET /invoicesRechnungen auflisten und suchenIn der Sandbox
POST /invoicesEine Rechnung oder Gutschrift als kanonisches JSON übermittelnIn der Sandbox
POST /invoices/xmlEin fertiges UBL- oder CII-Dokument übermitteln (Durchreichen)In der Sandbox
GET /invoices/seriesEingegangene und abgelehnte Rechnungen je Tag und ÜbermittlungswegIn der Sandbox
GET /invoices/{id}Den aktuellen Zustand einer Rechnung abrufenIn der Sandbox
POST /invoices/{id}/cancelEine Rechnung stoppen, die noch nicht übermittelt wurdeIn der Sandbox
GET /invoices/{id}/eventsDie Statusereignisse einer Rechnung auflistenIn der Sandbox
GET /invoices/{id}/documents/{kind}Ein erzeugtes Dokument oder die Quittung des Übermittlungswegs herunterladenIn der Sandbox
POST /validateEin Dokument erstellen und prüfen, ohne es zu sendenIn der Sandbox
GET /webhookDie Webhook-Einstellungen abrufen (die des Betreibers, oder mit dem Admin-Schlüssel eines Kunden dessen eigene)In der Sandbox
PUT /webhookDie Webhook-URL setzen oder ihr Secret rotierenIn der Sandbox
POST /webhook/testEin signiertes Testereignis an die Webhook-URL sendenIn der Sandbox
GET /catalogue/{code}Einen Fehler- oder Grundcode nachschlagenIn der Sandbox
GET /healthSystemzustandIn der Sandbox
GET /careDie Betreuungsliste: abgelehnte und im Zustand dead_letter gelandete Rechnungen mit dem Katalogcode und wer handeltIn der Sandbox
POST /care/{id}/handledDie Betreuungszeilen einer Rechnung als erledigt markierenIn der Sandbox
GET /care/{id}/evidenceDie gespeicherten Dateien einer Rechnung der Betreuungsliste mit ihrem SHA-256In der Sandbox
GET /credentialsGespeicherte Zugangsdaten, ohne ihre WerteIn der Sandbox
POST /credentialsZugangsdaten verschlüsselt speichern; der Wert wird nie zurückgegebenIn der Sandbox
GET /credentials/{id}Ein Zugangsdatum, ohne seinen WertIn der Sandbox
POST /credentials/{id}Den Wert (und das Ablaufdatum) eines aktiven Zugangsdatums ersetzenIn der Sandbox
POST /credentials/{id}/revokeEin Zugangsdatum widerrufen; der Datensatz bleibt für den PrüfpfadIn der Sandbox
GET /keysAPI-Schlüssel auflisten (der Betreiber sieht alle; der Admin-Schlüssel eines Kunden seine eigenen)In der Sandbox
POST /keysEinen API-Schlüssel für einen Kunden erzeugen; der Schlüssel wird einmal angezeigtIn der Sandbox
POST /keys/{id}/revokeEinen API-Schlüssel widerrufen; er funktioniert sofort nicht mehrIn der Sandbox

Geplante Operationen

Die OpenAPI-Datei führt diese auf. Der Service hat sie noch nicht, deshalb bekommen sie keine Seite und keine Beispielanfrage.

AufrufWas er tun wirdStatus
POST /invoices/{id}/statusesEinen Status auf Verkäuferseite melden (nur Frankreich)Geplant

Die Dokumentation fragen

Die Dokumentation in einfachen Worten durchsuchen.

API-Schlüssel auflisten (der Betreiber sieht alle; der Admin-Schlüssel eines Kunden seine eigenen) GET

Weiter

Auf dieser Seite

Operationen, die der Service hatGeplante Operationen