Skip to main content

Geliştiriciler için Clozo

Şeması yayımlanmış bir HTTP API

Faturaları kendi sisteminizden düzenleyin, iletin ve mutabakatını yapın. Şema yayımlanmıştır ve göz atılabilir; anahtarları, webhook'ları ve kullanımı çalışma alanınızda kendiniz yönetirsiniz.

API referansını aç

Referans çalışan servisten üretilir; bu yüzden önceki bir sürümü anlatamaz.

Hızlı başlangıç

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": ""
}
// ...

Çalışma alanınızda bir API anahtarı oluşturun ve onu Bearer token olarak gönderin. Belge oluşturan veya düzenleyen ya da para hareketi kaydeden istekler bir Idempotency-Key alır; böylece yeniden deneme asla mükerrer kayıt oluşturmaz. issuer_id, tüzel kişilerinizden birinin UUID'sidir.

Başlamadan önce okumaya değer bir kural

Kuruluş hiçbir zaman bir istek parametresinden değil, her zaman kimlik bilgisinden belirlenir. Bir kuruluş için verilen anahtar başka bir kuruluşa erişemez — iletilecek bir kuruluş kimliği yoktur ve isteği değiştirerek kapsamı genişletmenin de bir yolu yoktur. Hız sınırları her yanıtta X-RateLimit başlıklarıyla bildirilir; başarılı yanıtta da, 429 yanıtında da. Böylece istemci tahmin yürütmek yerine kendi hızını ayarlayabilir.

API neleri kapsıyor

Burada listelenen her şey, Erken erişim olarak işaretlenmedikçe bugün kullanılabilir.

Yayımlanmış şema ve ona göz atma arayüzü

API'nin kendisinin sunduğu bir OpenAPI şeması ve Swagger arayüzü. Uç noktaları elle aktarmak yerine istemcinizi şemadan üretin.

Kapsam ve yenileme destekli, kendi yönettiğiniz API anahtarları

Anahtarları çalışma alanınızda oluşturun, yenileyin ve iptal edin. Yenileme, eski anahtar çalışmayı bırakmadan önce yenisini verir; bu yüzden dağıtımın aynı anda yapılması gerekmez.

Teslimat günlüğü ve yeniden teslim özellikli imzalı webhook'lar

Uç noktaları kaydedin, örnek bir olay gönderin, teslimat günlüğünü okuyun ve tek bir olayı ya da teslim edilemeyenler kuyruğunun (DLQ) tamamını yeniden teslim edin. Kaçırılan bir teslimatı bize sormadan kurtarabilirsiniz.

Kendiniz okuyabileceğiniz kullanım

Kuruluşun e-posta dahil ne kadar tükettiği, bir destek sorusu değil, bir uç noktadır.

Filtrelenmiş dışa aktarımlar

API üzerinden listeleyebildiğiniz verilerin aynısının CSV ve XLSX çıktıları; elektronik tablonun hâlâ en iyi çözüm olduğu yerler için.

Peppol üzerinden e-fatura teslimiErken erişim. Erken erişim: Peppol, KSeF ve SdI üzerinden gönderim ve alım, erken erişim müşterileriyle birlikte devreye alınıyor.

Bir belgenin alıcının Peppol katılımcısına teslimi; teslimat durumu aynı API üzerinden okunabilir. E-belgenin hangi ülkelerde kullanılabildiğini ülkeler sayfasında görebilirsiniz.

Çalışma alanı neler yaparÜlkelere göre e-belge