Clozo dla programistów
API HTTP z opublikowanym schematem
Wystawiaj, dostarczaj i uzgadniaj faktury z własnego systemu. Schemat jest opublikowany i można go przeglądać; klucze, webhooki i zużycie obsługujesz samodzielnie w swoim obszarze roboczym.
Otwórz dokumentację APIDokumentacja jest generowana z działającej usługi, więc nie może opisywać poprzedniej wersji.
Szybki start
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": ""
}
// ...Utwórz klucz API w swoim obszarze roboczym, a następnie wysyłaj go jako token Bearer. Żądania, które tworzą lub wystawiają dokumenty albo rejestrują ruchy pieniędzy, przyjmują nagłówek Idempotency-Key, dzięki czemu ponowna próba nigdy nie utworzy duplikatu. issuer_id to UUID jednego z Twoich podmiotów.
Jedna zasada, którą warto przeczytać na początku
Organizacja wynika z poświadczenia, nigdy z parametru żądania. Klucz wydany dla jednej organizacji nie może zaadresować innej — nie ma identyfikatora organizacji do przekazania ani sposobu rozszerzenia zakresu przez zmianę żądania. Limity są zwracane w nagłówkach X-RateLimit, zarówno przy sukcesie, jak i przy 429.
Co obejmuje API
Wszystko, co tu wymieniono, jest dostępne już dziś, chyba że oznaczono to jako Wczesny dostęp.
Opublikowany schemat i przeglądarka do niego
Schemat OpenAPI i interfejs Swagger, serwowane przez samo API. Wygeneruj klienta ze schematu, zamiast przepisywać endpointy.
Klucze API z zakresami i rotacją
Twórz, rotuj i unieważniaj klucze w swoim obszarze roboczym. Rotacja wydaje nowy klucz, zanim stary przestanie działać, więc wdrożenie nie musi odbywać się jednocześnie.
Podpisane webhooki z dziennikiem dostaw i ponowieniem
Rejestruj endpointy, wyślij przykładowe zdarzenie, czytaj dziennik dostarczeń i ponów jedno zdarzenie albo całą kolejkę nieudanych. Utraconą dostawę odzyskasz bez kontaktowania się z nami.
Zużycie, które sprawdzisz samodzielnie
To, co organizacja zużyła — łącznie z pocztą — jest endpointem, a nie pytaniem do wsparcia.
Filtrowane eksporty
Wyciągi CSV i XLSX tych samych danych, które możesz listować przez API.
Dostarczanie e-faktur przez PeppolWczesny dostęp. Wczesny dostęp: wysyłka i odbiór przez Peppol, KSeF i SdI są właśnie uruchamiane razem z klientami z wczesnym dostępem.
Dostarczenie dokumentu do uczestnika Peppol po stronie odbiorcy, ze stanem dostawy dostępnym przez to samo API. Strona krajów pokazuje, gdzie e-fakturowanie jest dostępne.