İzibiz Developer Portal
SOAP WS · E-Fatura WS (EInvoiceWS)

Fatura Listeleme (GetInvoice)

SOAPGetInvoiceRequest
  • E-Fatura sisteminde satış (giden) veya alış (gelen) faturaların üst başlık ve dosyalarını sorgulamak için kullanılır.

Parametreler

AdTipZorunluAciklama
REQUEST_HEADER object Evet Her webservis isteğinde gönderilmesi beklen ortak elemandır
└ SESSION_ID text Evet Kimlik doğrulama servisi (AuthenticationWS) oturum açma metodundan (Login) alına oturum/token/session bilgisi.
└ CLIENT_TXN_ID text Hayir İstemci uygulama tarafından işlem için üretilen işlem bilgisi (transaction id) varsa istek esnasında gönderilip, sonuçta alabileceğiniz bir değerdir. request/response eşleşmesi yapmak için kullanılabilir.
└ APPLICATION_NAME text Evet Metodu çağıran uygulamanın adı. Örnek: AppName-v1.4.67
└ COMPRESSED select Evet İçerikte taşınan bilginin ZIP formatında sıkıştırılmış mı gönderildiği/talep edildiği bilgisi. Belge gönderim ve belge okuma servislerinde gönderilen değere göre işlem yapılmaktadır.
INVOICE_SEARCH_KEY object Evet Belge sorgulamak için kullanılacak kriterler. En az bir parametre gönderilmelidir.
└ LIMIT text Hayir Sayfalama. Sonuçta dönülecek belge sayısı. Eğer eleman gönderilmezse varsayılan 10 adet fatura dönülür, fatura içerikleri (dosya) ile beraber en fazla 100 adet fatura, sadece fatura başlıklarını çekildiğinde ise en fazla 25.000 adet fatura dönülür.
└ UUID text Hayir Belgeye ait Evrensel Tekil Tanımlama Numarası (ETTN) ile fatura sorgulamak için kullanılır. GUID formatında olmalıdır.
└ FROM text Hayir Gönderici firma gönderici birim (GB) etiketine göre çekmek için kullanılabilir. Örneğin birden fazla GB etiketi olan bir firmanın sadece bir etiketinden gönderilen faturaları sorgulama için kullanılabilir. format: urn:mail:muhasebegb@firma.com
└ TO text Hayir Birden fazla Posta Kutusu (PK) etiketi olan bir firmanın sadece bir PK adresine gelen faturaları çekmek için kullanılabilir. Eğer etiket gönderilmez ise kullanıcının yetkisine bağlı olarak bütün faturalar dönülür. format: urn:mail:muhasebepk@firma.com
└ DATE_TYPE select Hayir Belirli tarih aralığında fatura sorgulamak istendiğinde belirlenen tarih tipidir. CREATE değeri gönderilirse fatura oluşturulma/sisteme ulaşma tarihine göre getirilir, boş veya ISSUE değeri gönderilirse fatura tarihine göre sonuç dönülmektedir.
└ START_DATE text Hayir Belirli tarih aralığında fatura sorgulamak istendiğinde dönem başlangıç tarihi format: YYYY-MM-DD
└ END_DATE text Hayir Belirli tarih aralığında fatura sorgulamak istendiğinde dönem bitiş tarihi format: YYYY-MM-DD
└ READ_INCLUDED select Hayir Fatura sorgulanırken daha önce istemciye çekilmiş/okunmuş faturaları dönüşe dahil edilip edilmeyeceğini belirler. 'true' değeri gönderilirse fatura daha önce okunmuş olsa bile sonuca eklenir. Gönderilmezse veya false gönderilirse sadece yeni gelen faturalar dönülür. Değerler: true/false
└ DIRECTION select Hayir Belge yönü. Gelen veya Giden faturaları sorgulamak için kullanılabilir. Gelen faturaları sorgulamak için IN, giden faturaları çekmek için OUT değeri gönderilebilir. Varsayılan değer IN olduğu için eğer parametre gönderilmezse sadece gelen faturalar dönülecektir. Gönderilebilecek değerler: IN, OUT
└ SENDER text Hayir Faturayı gönderen firma VKN'si. Sadece bir firmadan gelen faturaları sorgualamak için kullanılabilir
└ RECEIVER text Hayir Faturayı alan firma VKN'si. Sadece bir firmadan gönderilen faturaları sorgualamak için kullanılabilir
└ DRAFT_FLAG select Hayir Taslak faturaları sonuca eklenmesi için kullanılan parametredir. Y değeri gönderilirse taslak faturalar diğer kriterlere uyan faturalarla beraber sonuca eklenir. Parametre gönderilmezse veya N gönderilirse taslak faturalar sonuca eklenmez. Değerler: Y/N
└ ID text Hayir
HEADER_ONLY select Hayir Değerler: Y/N : Fatura dosya ile beraber mi yoksa sadece özet üst bilgisi mi sorgulanmak istenildiğini belirler. Eleman gönderilmezse veya N değeri gönderilirse faturalar üst başlık ve dosya ile beraber dönülür. Y değeri gönderilirse faturaların üst başlığı dönülür.