İçeriğe geç
siparis.app geliştiriciAnahtarları yönet ↗

Fatura

Faturayı önizle

POST/v1/orders/{id}/invoices/preview

Fatura kesmeden önce alıcıyı, kalemleri, tutarı ve fatura türünü görün.

Gereken izin

Bearer anahtarı ve invoices:write

Yanıtı genişleten izin

personal_data:read: yanıttaki ilgili alanları açar; izin yoksa bu alanlar atlanır, istek reddedilmez.

Maliyet

10 puan (bağlantı başına 60 saniyede 600 puan)

Tekrar anahtarı

Gerekmez; istek hiçbir şeyi değiştirmez.

İstek

Temel adres: https://api.siparis.app/v1

Yol parametreleri

AlanTürZorunluAçıklamaÖrnek
idmetinEvetOkunacak kaynağın ord_ önekli dış kimliği."ord_1234567890abcdef1234567890abcdef"

Gövde (application/json)

AlanTürZorunluAçıklamaÖrnek

Örnek istek

curl --fail-with-body --silent --show-error --request POST \
  "${SIPARIS_API_URL:-https://api.siparis.app/v1}/orders/ord_1234567890abcdef1234567890abcdef/invoices/preview" \
  -H "Authorization: Bearer $SIPARIS_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{}
JSON
import json
import os
from urllib.request import Request, build_opener, HTTPRedirectHandler
from urllib.error import HTTPError

# İmzalı indirme hedefine Bearer taşımamak için yönlendirme kendiliğinden izlenmez.
class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None

base = os.environ.get("SIPARIS_API_URL", "https://api.siparis.app/v1")
headers = {
    "Authorization": "Bearer " + os.environ["SIPARIS_API_KEY"],
    "Content-Type": "application/json",
}
request = Request(base + "/orders/ord_1234567890abcdef1234567890abcdef/invoices/preview", headers=headers, method="POST",
    data="{}".encode("utf-8"))
try:
    with build_opener(NoRedirect).open(request, timeout=30) as response:
        print(response.read().decode("utf-8"))
except HTTPError as error:
    print(error.code, error.read().decode("utf-8"))
    raise
// Node.js 22+; anahtar yalnız sunucunun ortam değişkenindedir.
const base = process.env.SIPARIS_API_URL ?? "https://api.siparis.app/v1";
if (!process.env.SIPARIS_API_KEY) throw new Error("SIPARIS_API_KEY gerekli");
const response = await fetch(base + "/orders/ord_1234567890abcdef1234567890abcdef/invoices/preview", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.SIPARIS_API_KEY}`,
    "Content-Type": "application/json",
  },
  redirect: "manual", // 307 hedefini Bearer olmadan ayrı istekte okuyun.
  signal: AbortSignal.timeout(30_000),
  body: JSON.stringify({}),
});
const text = await response.text();
if (!response.ok) throw new Error(`${response.status}: ${text}`);
console.log(text);

Kimlik içeren yollarda örnek kimliği kendi liste yanıtınızdan alın. SIPARIS_API_KEY sunucu ortamında tanımlı olmalı; yerelde SIPARIS_API_URL ile /v1 içeren adresi değiştirin. Üretimde tekrar kurallarını uygulayın.

Yanıt

200 İstek başarıyla tamamlandı.

İçerik türü: application/json

{
  "kind": "e_arsiv",
  "lines": [
    {
      "discount": "0.00",
      "name": "Örnek ürün",
      "net": "100.00",
      "quantity": "2",
      "tax_amount": "20.00",
      "tax_rate": "20",
      "total": "120.00",
      "unit": "adet",
      "unit_price": "50.0000"
    }
  ],
  "order": "ord_1234567890abcdef1234567890abcdef",
  "tax_total": "20.00",
  "total": "120.00",
  "warnings": [
    {
      "code": "invoice_kind_unknown",
      "detail": "Belge türü sağlayıcı yanıt verdiğinde kesinleşir."
    }
  ]
}
Yanıt alanları (29)
AlanTürZorunluAçıklamaÖrnek
kindmetin (seçenekler: e_fatura, e_arsiv) · null olabilirEvetMükellef sorgusu sonucu; sağlayıcı yanıt vermediyse null."e_arsiv"
linesliste: nesneEvetPanelin faturaya yazacağı ürün ve hizmet satırları.
discountmetinEvetSatırın KDV hariç indirimi, TRY."0.00"
namemetinEvetPanelin fatura satırı açıklaması."Örnek ürün"
netmetinEvetİndirimden sonra KDV hariç tutar, TRY."100.00"
quantitymetinEvetSatır miktarı; ondalık metin."2"
tax_amountmetinEvetSatırın KDV tutarı, TRY."20.00"
tax_ratemetinEvetKDV oranı, yüzde."20"
totalmetinEvetSatırın KDV dahil tutarı, TRY."120.00"
unitmetinEvetMiktarın birimi."adet"
unit_pricemetinEvetKDV hariç birim fiyat, TRY; dört ondalık haneye kadar."50.0000"
ordermetinEvetÖnizlenen siparişin ord_ kimliği."ord_1234567890abcdef1234567890abcdef"
tax_totalmetinEvetFatura KDV toplamı, TRY."20.00"
totalmetinEvetFatura toplamı, TRY."120.00"
warningsliste: nesneEvetMükellef sorgusu ve alıcı unvanı uyarıları.
codemetinEvetUyarının sabit kodu."invoice_kind_unknown"
detailmetinEvetUyarının Türkçe açıklaması."Belge türü sağlayıcı yanıt verdiğinde kesinleşir."
buyernesne · null olabilirHayırAlıcı; personal_data:read yoksa alan atlanır.
addressmetinEvetFatura adresinin açık adresi."Örnek adres"
citymetinEvetFatura adresinin ili."İstanbul"
corporatetrue/falseEvetŞirket adına faturada true.false
districtmetinEvetFatura adresinin ilçesi."Kadıköy"
emailmetinEvetSipariş verenin e-posta adresi."ornek@example.com"
namemetinEvetPanelin seçtiği alıcı adı veya unvanı."Örnek Alıcı"
phonemetinEvetSipariş verenin telefonu.""
tax_numbermetinEvetVKN/TCKN; bireyselde panelin nihai tüketici numarası."11111111111"
tax_officemetinEvetVergi dairesi; bireyselde boş.""
currencysabit "TRY"HayırTutarların para birimi."TRY"
registered_titlemetin · null olabilirHayırSağlayıcıdaki unvan; personal_data:read yoksa atlanır.null

Hatalar

HTTPcodeAnlamıNasıl düzelir?
409invoice_not_connectedFatura sağlayıcısı bağlı değil.İşletme > Entegrasyonlar bölümünden sağlayıcınızı bağlayın.
409invoice_order_not_allowedBu siparişe fatura kesilemez.Siparişin iptal/iade durumunu kontrol edin.
409invoice_zero_totalSipariş tutarı 0 TL; fatura kesilmez.Sipariş tutarını kontrol edin.
409invoice_payment_requiredÖdeme gelince fatura kesilebilir.Ödeme kaydını kontrol edin.
409invoice_billing_invalidSiparişin fatura bilgileri uygun değil.Paneldeki açıklamaya göre fatura bilgilerini tamamlayın.
400invoice_seller_invalidİşletmenin vergi bilgileri eksik.İşletme bilgilerini tamamlayın.
409invoice_empty_orderSiparişte ürün yok; fatura kesilemez.Sipariş kalemlerini kontrol edin.
409invoice_existsSiparişin etkin faturası var.Mevcut faturayı okuyun; hazırlanan fatura için yeni istek açmayın.
409invoice_not_allowedFatura işlemi şu an yapılamıyor.Açıklamadaki panel kuralını izleyin.
409invoice_already_cancelledFatura zaten iptal edilmiş.Güncel faturayı okuyun.
409invoice_not_readyFatura belgesi henüz hazır değil.Faturanın numarası kesinleşince yeniden deneyin.
409invoice_portal_requiredSağlayıcı portalından iptal gerekiyor.Portalda tamamladıktan sonra portal_done=true gönderin.
409invoice_cancel_runningFatura iptali sürüyor.Süren çağrının bitmesini bekleyin.
409invoice_connection_changedFatura sağlayıcı bağlantısı değişti.Önceki sağlayıcı hesabında faturayı kontrol edin.
409invoice_cancel_uncertainFatura iptalinin sonucu belirsiz.Yeni dış iptal gönderilmez; portalda doğrulayıp portal_done=true ile tamamlayın.
409invoice_provider_authFatura sağlayıcısı bağlantı bilgilerini kabul etmedi.İşletme > Entegrasyonlar bölümünden bağlantıyı düzeltin; aynı faturayı izleyin.
409invoice_provider_errorFatura sağlayıcısı işlemi tamamlayamadı.Faturanın durumunu ve sağlayıcı portalını kontrol edin.

Ortak hatalar (anahtar, izin, istek biçimi, hız sınırı, tekrar anahtarı) her uçta aynıdır: Hata kodları › Ortak hatalar.