API Übersicht

Unsere REST API ermöglicht es Ihnen, E-Rechnungen programmatisch zu erstellen, zu verwalten und zu versenden. Diese Dokumentation bietet einen Überblick über die verfügbaren Funktionen und deren Verwendung.

API-Versionen

Die aktuelle Version unserer API ist v2. Wir unterstützen auch noch v1, jedoch empfehlen wir die Verwendung der neuesten Version für alle neuen Integrationen.

Authentifizierung

Alle API-Anfragen erfordern eine Authentifizierung mittels API-Schlüssel. Der API-Schlüssel muss im Authorization-Header jeder Anfrage mitgesendet werden.

Verfügbare Endpunkte

Rechnungen

• POST /invoices - Neue Rechnung erstellen
• GET /invoices - Liste aller Rechnungen abrufen
• GET /invoices/${invoiceId} - Details einer Rechnung abrufen
• PUT /invoices/${invoiceId} - Rechnung aktualisieren
• DELETE /invoices/${invoiceId} - Rechnung löschen

Empfänger

• POST /recipients - Neuen Empfänger anlegen
• GET /recipients - Liste aller Empfänger abrufen
• GET /recipients/${recipientId} - Details eines Empfängers abrufen

Formate

• POST /convert - Rechnungsformat konvertieren
• GET /formats - Verfügbare Formate abrufen

Datenformate

Anfragen

Alle Anfragen müssen im JSON-Format gestellt werden. Setzen Sie den Content-Type-Header entsprechend:

Antworten

Alle Antworten werden im JSON-Format zurückgegeben und haben folgende Struktur:

{
  "success": true,
  "data": { ... },
  "message": "Optional message",
  "errors": [ ... ] // Bei Fehlern
}

Fehlerbehandlung

Die API verwendet Standard-HTTP-Statuscodes zur Anzeige des Erfolgs oder Misserfolgs einer Anfrage:

• 200 - Erfolgreiche Anfrage
• 201 - Ressource erfolgreich erstellt
• 400 - Ungültige Anfrage
• 401 - Nicht authentifiziert
• 403 - Nicht autorisiert
• 404 - Ressource nicht gefunden
• 429 - Zu viele Anfragen
• 500 - Serverfehler

Ratenlimits

Um die Stabilität unserer API zu gewährleisten, gelten folgende Ratenlimits:

• Basic Plan: 100 Anfragen pro Minute
• Professional Plan: 500 Anfragen pro Minute
• Enterprise Plan: Individuell anpassbar