- Özel entegratör platformundan imzalanmış belgeleri okumayı sağlayan servistir.
- E-Müstahsil belgesinin imzalı UBL-TR XML, PDF veya HTML olarak okumayı sağlar.
- Belirlenen kritere uygun kayıt bulunamamışsa sonuç boş dönecektir. Hata fırlatılmaz.
- Sonuç tek veya çoklu dönülmesine bakılmaksızın liste olarak dönülür.
Parametreler
| Ad | Tip | Zorunlu | Aciklama |
|---|---|---|---|
REQUEST_HEADER |
object |
Evet | Request Header objesi içerisinde SESSION_ID ve APPLICATION_NAME alanı zorunludur. Faturaları XML formatında sıkıştırılmadan çekmek için mutlaka COMPRESSED elemanı eklenmeli ve N değeri gönderilmelidir. Eğer gönderilmezse faturalar sıkıştırılmış/ziplenmiş olarak dönülecektir. |
└ 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 |
text |
Hayir | İç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. |
CREDITNOTE_SEARCH_KEY |
object |
Evet | Belge okumak için kullanılabilecek filtre kritirleri |
└ LIMIT |
text |
Hayir | Kaç kayıt okunmak istendiği. Eğer eleman gönderilmezse 10 adet kayıt dönülür. İçerikleri (PDF) ile beraber en fazla 100 adet kayıt dönülür. Sadece özet/başlıklarını çekildiğinde ise en fazla 25.000 adet kayıt dönülür. |
└ ID |
text |
Hayir | Belge numarası ile okumak için kullanılabilir. örnek: CREDITNOTE2018000000001 |
└ UUID |
text |
Hayir | Evrensel Tekil Tanımlama Numarası (ETTN) ile okumak için kullanılabilir. GUID formatında |
└ FROM |
text |
Hayir | Gönderici vergi kimlik/TC kimlik numarası ile sorgulamak için kullanılabilir. |
└ TO |
text |
Hayir | Alıcı vergi kimlik/TC kimlik numarası ile sadece belirli bir müşteriye gönderilen belgeleri okumak için kullanılabilir. |
└ START_DATE |
text |
Hayir | Belirli tarih aralığında ki belgeleri çekmek istendiğinde dönem başlangıç tarihi. format: YYYY-MM-DD |
└ END_DATE |
text |
Hayir | Belirli tarih aralığında ki belgeleri çekmek istendiğinde dönem bitiş tarihi format: YYYY-MM-DD |
└ READ_INCLUDED |
text |
Hayir | Daha önce okunmuş belgeleri dönüşe dahil edilip edilmeyeceğini belirleyen parametredir. Y değeri gönderilirse daha önce okunmuş olsa bile yanıta eklenir. Gönderilmezse veya N gönderilirse sadece yeni gelen belgeler dönülür. Gönderilebilecek değerler: Y/N |
HEADER_ONLY |
text |
Hayir | Sadece özet değerler mi yoksa içerik ile beraber mi okunmak istenildiğini belirleyen parametredir. Eleman gönderilmezse veya N değeri gönderilirse belgenin içeriği ile (XML) ile beraber dönülür. Y değeri gönderilirse belgenin özeti dönülür. Gönderilebilecek değerler: Y/N |
CONTENT_TYPE |
text |
Hayir | Talep edilen format. Gönderilebilecek değerler: PDF |