Fatura
Faturayı iptal et
POST/v1/invoices/{id}/cancel
Kesilmiş faturayı iptal edin.
- Gereken izin
Bearer anahtarı ve
invoices:write,money_out:write- Yanıtı genişleten izin
personal_data:read: yanıttaki ilgili alanları açar; izin yoksa bu alanlar atlanır, istek reddedilmez.- Maliyet
1 puan (bağlantı başına 60 saniyede 600 puan)
- Tekrar anahtarı
Gerekir:
Idempotency-Keybaşlığı.
İstek
Temel adres: https://api.siparis.app/v1
Yol parametreleri
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
id | metin | Evet | Okunacak kaynağın inv_ önekli dış kimliği. | "inv_1234567890abcdef1234567890abcdef" |
Başlıklar
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
Idempotency-Key | metin · null olabilir | Evet | Zorunlu tekrar anahtarı; en çok 200 karakter. Yeni işte yeni değer; ağ tekrarında aynı gövde ve aynı değer. | "ilk-esitleme-20261016-001" |
Gövde (application/json)
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
portal_done | true/false | Hayır | Yalnız sağlayıcı portalında iptal gerçekten tamamlandıysa true. | false |
reason | metin (en çok 450 karakter) · null olabilir | Hayır | İptal gerekçesi; muhasebe kaydında korunur. | "Yanlış fatura düzenlendi." |
Örnek istek
curl --fail-with-body --silent --show-error --request POST \
"${SIPARIS_API_URL:-https://api.siparis.app/v1}/invoices/inv_1234567890abcdef1234567890abcdef/cancel" \
-H "Authorization: Bearer $SIPARIS_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: ornek-post-v1-invoices-inv-1234567890abcdef1234567890abcdef-cancel-001' \
--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",
"Idempotency-Key": "ornek-post-v1-invoices-inv-1234567890abcdef1234567890abcdef-cancel-001",
}
request = Request(base + "/invoices/inv_1234567890abcdef1234567890abcdef/cancel", 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 + "/invoices/inv_1234567890abcdef1234567890abcdef/cancel", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.SIPARIS_API_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": "ornek-post-v1-invoices-inv-1234567890abcdef1234567890abcdef-cancel-001",
},
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 İptal kaydedildi veya fatura zaten iptal edilmiş.
İçerik türü: application/json
{
"cancellation_status": "succeeded",
"cancelled_at": null,
"created_at": "2026-10-16T09:00:00Z",
"currency": "TRY",
"id": "inv_1234567890abcdef1234567890abcdef",
"issued_at": "2026-10-16T09:00:00Z",
"kind": "e_arsiv",
"status": "cancelled",
"tax_total": "20.00",
"total": "120.00",
"updated_at": "2026-10-16T09:00:00Z"
}Yanıt alanları (15)
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
cancelled_at | tarih-saat · null olabilir | Evet | İptal zamanı; RFC 3339 UTC. Değer yoksa null. | "2026-10-16T09:00:00Z" |
created_at | tarih-saat | Evet | Oluşturulma zamanı; RFC 3339 UTC. | "2026-10-16T09:00:00Z" |
id | metin | Evet | Kaynağın dış kimliği; inv_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz. | "inv_1234567890abcdef1234567890abcdef" |
issued_at | tarih-saat | Evet | Fatura düzenleme zamanı; RFC 3339 UTC. | "2026-10-16T09:00:00Z" |
kind | metin | Evet | Fatura türü. | "e_arsiv" |
status | metin | Evet | Faturanın düzenlenme/iptal durumu. Değerler: pending, issued, failed, cancelled. Türkçe karşılıkları: https://developer.siparis.app/referans#fatura-durumlari. | "issued" |
tax_total | metin | Evet | Toplam vergi; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin. | "20.00" |
total | metin | Evet | Toplam tutar; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin. | "120.00" |
updated_at | tarih-saat | Evet | Son değişiklik zamanı; RFC 3339 UTC. | "2026-10-16T09:00:00Z" |
buyer_name | metin · null olabilir | Hayır | Alıcı adı; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez. | null |
buyer_tax_number | metin · null olabilir | Hayır | Alıcı vergi/kimlik numarası; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez. | null |
cancellation_status | metin · null olabilir | Hayır | İptal isteğinin durumu; iptal istenmediyse alan atlanır. Değerler: pending, unknown, failed, succeeded. Türkçe karşılıkları: https://developer.siparis.app/referans#fatura-iptal-durumlari. | null |
currency | sabit "TRY" | Hayır | Para birimi; v1 tutarları Türk lirasıdır. | "TRY" |
error_code | metin · null olabilir | Hayır | Kesim veya iptalin sabit hata kodu; sağlayıcının serbest metni yayımlanmaz. | null |
number | metin · null olabilir | Hayır | Fatura numarası; personal_data:read gerekir. | null |
Bu uca özgü yanıt başlıkları: Location (Faturayı izleme yolu.).
202 Fatura işlemi kuyruğa alındı; Location ile izleyin.
İçerik türü: application/json
{
"cancellation_status": "pending",
"cancelled_at": null,
"created_at": "2026-10-16T09:00:00Z",
"currency": "TRY",
"id": "inv_1234567890abcdef1234567890abcdef",
"issued_at": "2026-10-16T09:00:00Z",
"kind": "e_arsiv",
"status": "issued",
"tax_total": "20.00",
"total": "120.00",
"updated_at": "2026-10-16T09:00:00Z"
}Yanıt alanları (15)
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
cancelled_at | tarih-saat · null olabilir | Evet | İptal zamanı; RFC 3339 UTC. Değer yoksa null. | "2026-10-16T09:00:00Z" |
created_at | tarih-saat | Evet | Oluşturulma zamanı; RFC 3339 UTC. | "2026-10-16T09:00:00Z" |
id | metin | Evet | Kaynağın dış kimliği; inv_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz. | "inv_1234567890abcdef1234567890abcdef" |
issued_at | tarih-saat | Evet | Fatura düzenleme zamanı; RFC 3339 UTC. | "2026-10-16T09:00:00Z" |
kind | metin | Evet | Fatura türü. | "e_arsiv" |
status | metin | Evet | Faturanın düzenlenme/iptal durumu. Değerler: pending, issued, failed, cancelled. Türkçe karşılıkları: https://developer.siparis.app/referans#fatura-durumlari. | "issued" |
tax_total | metin | Evet | Toplam vergi; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin. | "20.00" |
total | metin | Evet | Toplam tutar; TRY cinsinden ondalık metin. Kuruş kaybını önlemek için ondalık sayı kütüphanesiyle işleyin. | "120.00" |
updated_at | tarih-saat | Evet | Son değişiklik zamanı; RFC 3339 UTC. | "2026-10-16T09:00:00Z" |
buyer_name | metin · null olabilir | Hayır | Alıcı adı; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez. | null |
buyer_tax_number | metin · null olabilir | Hayır | Alıcı vergi/kimlik numarası; yalnız personal_data:read kapsamında görünür. Örnek kişisel veri içermez. | null |
cancellation_status | metin · null olabilir | Hayır | İptal isteğinin durumu; iptal istenmediyse alan atlanır. Değerler: pending, unknown, failed, succeeded. Türkçe karşılıkları: https://developer.siparis.app/referans#fatura-iptal-durumlari. | null |
currency | sabit "TRY" | Hayır | Para birimi; v1 tutarları Türk lirasıdır. | "TRY" |
error_code | metin · null olabilir | Hayır | Kesim veya iptalin sabit hata kodu; sağlayıcının serbest metni yayımlanmaz. | null |
number | metin · null olabilir | Hayır | Fatura numarası; personal_data:read gerekir. | null |
Bu uca özgü yanıt başlıkları: Location (Faturayı izleme yolu.).
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.