Clozo für Entwickler
Eine HTTP-API mit veröffentlichtem Schema
Rechnungen aus Ihrem eigenen System ausstellen, zustellen und abgleichen. Das Schema ist veröffentlicht und durchsuchbar; Schlüssel, Webhooks und Verbrauch verwalten Sie selbst in Ihrem Arbeitsbereich.
API-Referenz öffnenDie Referenz wird aus dem laufenden Dienst erzeugt und kann deshalb keine frühere Version beschreiben.
Schnellstart
curl https://api.useclozo.com/b2b/v1/documents \
-X POST \
-H "Authorization: Bearer clz_live_<keyid>_<secret>" \
-H "Idempotency-Key: order-4471-v1" \
-H "Content-Type: application/json" \
-d '{
"issuer_id": "3f6c1b8e-2d4a-4e7b-9a15-6c0d2e8f7a41",
"customer": {
"name": "Kestrel Logistics GmbH",
"country": "DE",
"vat_number": "DE123456789"
},
"currency": "EUR",
"line_items": [
{
"description": "Consulting, October",
"quantity": "1",
"unit_amount": 395000,
"tax_rate": 0,
"tax_category": "AE"
}
]
}'HTTP/1.1 201 Created
{
"object": "document",
"id": "doc_5Hq2m8Zr4Kd9",
"issuer_id": "3f6c1b8e-2d4a-4e7b-9a15-6c0d2e8f7a41",
"issuer_country": "NL",
"currency": "EUR",
"subtotal": 395000,
"tax_total": 0,
"total": 395000,
"reverse_charge": true,
"status_bucket": "created",
"status_detail": "draft",
"invoice_number": ""
}
// ...Legen Sie in Ihrem Arbeitsbereich einen API-Schlüssel an und senden Sie ihn als Bearer-Token. Anfragen, die Dokumente anlegen oder ausstellen oder Zahlungen erfassen, erwarten einen Idempotency-Key, damit ein erneuter Versuch nie ein Duplikat erzeugt. issuer_id ist die UUID einer Ihrer Gesellschaften.
Eine Regel, die man vorher lesen sollte
Die Organisation ergibt sich aus dem Credential, nie aus einem Request-Parameter. Ein Schlüssel für eine Organisation kann keine andere ansprechen — es gibt keine zu übergebende Organisations-ID und keine Möglichkeit, den Geltungsbereich über den Request zu erweitern. Ratenlimits werden über X-RateLimit-Header zurückgemeldet, bei Erfolg wie bei 429, sodass ein Client sich selbst takten kann.
Was die API abdeckt
Alles hier Aufgeführte ist heute verfügbar, sofern es nicht als Vorabzugang gekennzeichnet ist.
Veröffentlichtes Schema und ein Browser dafür
Ein OpenAPI-Schema und eine Swagger-UI, beide vom Dienst selbst ausgeliefert. Generieren Sie Ihren Client aus dem Schema statt Endpunkte abzuschreiben.
API-Schlüssel mit Scopes und Rotation
Schlüssel in Ihrem Arbeitsbereich anlegen, rotieren und widerrufen. Die Rotation gibt den neuen Schlüssel aus, bevor der alte aufhört zu funktionieren, sodass ein Deployment nicht gleichzeitig erfolgen muss.
Signierte Webhooks mit Zustellprotokoll und Replay
Endpunkte registrieren, ein Beispielereignis senden, das Zustellprotokoll lesen und ein einzelnes Ereignis oder die gesamte Dead-Letter-Queue erneut zustellen. Eine verpasste Zustellung lässt sich ohne Rückfrage bei uns nachholen.
Verbrauch selbst auslesen
Was die Organisation verbraucht hat, inklusive E-Mail, ist ein Endpunkt und keine Supportanfrage.
Gefilterte Exporte
CSV- und XLSX-Auszüge derselben Daten, die Sie über die API listen können — für die Stellen, an denen eine Tabelle noch die Antwort ist.
E-Rechnungszustellung über PeppolVorabzugang. Vorabzugang: Versand und Empfang über Peppol, KSeF und SdI werden gerade gemeinsam mit Kunden im Vorabzugang freigeschaltet.
Zustellung eines Dokuments an den Peppol-Teilnehmer des Empfängers, mit dem Zustellstatus über dieselbe API abrufbar. Wo die E-Rechnung verfügbar ist, zeigt die Länderseite.