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
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
id | metin | Evet | Okunacak kaynağın ord_ önekli dış kimliği. | "ord_1234567890abcdef1234567890abcdef" |
Gövde (application/json)
| Alan | Tür | Zorunlu | Açı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'
{}
JSONimport 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)
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
kind | metin (seçenekler: e_fatura, e_arsiv) · null olabilir | Evet | Mükellef sorgusu sonucu; sağlayıcı yanıt vermediyse null. | "e_arsiv" |
lines | liste: nesne | Evet | Panelin faturaya yazacağı ürün ve hizmet satırları. | |
discount | metin | Evet | Satırın KDV hariç indirimi, TRY. | "0.00" |
name | metin | Evet | Panelin fatura satırı açıklaması. | "Örnek ürün" |
net | metin | Evet | İndirimden sonra KDV hariç tutar, TRY. | "100.00" |
quantity | metin | Evet | Satır miktarı; ondalık metin. | "2" |
tax_amount | metin | Evet | Satırın KDV tutarı, TRY. | "20.00" |
tax_rate | metin | Evet | KDV oranı, yüzde. | "20" |
total | metin | Evet | Satırın KDV dahil tutarı, TRY. | "120.00" |
unit | metin | Evet | Miktarın birimi. | "adet" |
unit_price | metin | Evet | KDV hariç birim fiyat, TRY; dört ondalık haneye kadar. | "50.0000" |
order | metin | Evet | Önizlenen siparişin ord_ kimliği. | "ord_1234567890abcdef1234567890abcdef" |
tax_total | metin | Evet | Fatura KDV toplamı, TRY. | "20.00" |
total | metin | Evet | Fatura toplamı, TRY. | "120.00" |
warnings | liste: nesne | Evet | Mükellef sorgusu ve alıcı unvanı uyarıları. | |
code | metin | Evet | Uyarının sabit kodu. | "invoice_kind_unknown" |
detail | metin | Evet | Uyarının Türkçe açıklaması. | "Belge türü sağlayıcı yanıt verdiğinde kesinleşir." |
buyer | nesne · null olabilir | Hayır | Alıcı; personal_data:read yoksa alan atlanır. | |
address | metin | Evet | Fatura adresinin açık adresi. | "Örnek adres" |
city | metin | Evet | Fatura adresinin ili. | "İstanbul" |
corporate | true/false | Evet | Şirket adına faturada true. | false |
district | metin | Evet | Fatura adresinin ilçesi. | "Kadıköy" |
email | metin | Evet | Sipariş verenin e-posta adresi. | "ornek@example.com" |
name | metin | Evet | Panelin seçtiği alıcı adı veya unvanı. | "Örnek Alıcı" |
phone | metin | Evet | Sipariş verenin telefonu. | "" |
tax_number | metin | Evet | VKN/TCKN; bireyselde panelin nihai tüketici numarası. | "11111111111" |
tax_office | metin | Evet | Vergi dairesi; bireyselde boş. | "" |
currency | sabit "TRY" | Hayır | Tutarların para birimi. | "TRY" |
registered_title | metin · null olabilir | Hayır | Sağlayıcıdaki unvan; personal_data:read yoksa atlanır. | null |
Hatalar
| HTTP | code | Anlamı | Nasıl düzelir? |
|---|---|---|---|
| 409 | invoice_not_connected | Fatura sağlayıcısı bağlı değil. | İşletme > Entegrasyonlar bölümünden sağlayıcınızı bağlayın. |
| 409 | invoice_order_not_allowed | Bu siparişe fatura kesilemez. | Siparişin iptal/iade durumunu kontrol edin. |
| 409 | invoice_zero_total | Sipariş tutarı 0 TL; fatura kesilmez. | Sipariş tutarını kontrol edin. |
| 409 | invoice_payment_required | Ödeme gelince fatura kesilebilir. | Ödeme kaydını kontrol edin. |
| 409 | invoice_billing_invalid | Siparişin fatura bilgileri uygun değil. | Paneldeki açıklamaya göre fatura bilgilerini tamamlayın. |
| 400 | invoice_seller_invalid | İşletmenin vergi bilgileri eksik. | İşletme bilgilerini tamamlayın. |
| 409 | invoice_empty_order | Siparişte ürün yok; fatura kesilemez. | Sipariş kalemlerini kontrol edin. |
| 409 | invoice_exists | Siparişin etkin faturası var. | Mevcut faturayı okuyun; hazırlanan fatura için yeni istek açmayın. |
| 409 | invoice_not_allowed | Fatura işlemi şu an yapılamıyor. | Açıklamadaki panel kuralını izleyin. |
| 409 | invoice_already_cancelled | Fatura zaten iptal edilmiş. | Güncel faturayı okuyun. |
| 409 | invoice_not_ready | Fatura belgesi henüz hazır değil. | Faturanın numarası kesinleşince yeniden deneyin. |
| 409 | invoice_portal_required | Sağlayıcı portalından iptal gerekiyor. | Portalda tamamladıktan sonra portal_done=true gönderin. |
| 409 | invoice_cancel_running | Fatura iptali sürüyor. | Süren çağrının bitmesini bekleyin. |
| 409 | invoice_connection_changed | Fatura sağlayıcı bağlantısı değişti. | Önceki sağlayıcı hesabında faturayı kontrol edin. |
| 409 | invoice_cancel_uncertain | Fatura iptalinin sonucu belirsiz. | Yeni dış iptal gönderilmez; portalda doğrulayıp portal_done=true ile tamamlayın. |
| 409 | invoice_provider_auth | Fatura sağlayıcısı bağlantı bilgilerini kabul etmedi. | İşletme > Entegrasyonlar bölümünden bağlantıyı düzeltin; aynı faturayı izleyin. |
| 409 | invoice_provider_error | Fatura 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.