- E-İrsaliye sisteminden giden imzalı irsaliye veya gelen irsaliyeyi ERP/muhasebe paketine çekmek için kullanılır.
- İrsaliye özet bilgilerini veya irsaliye özet bilgileri ile beraber XML içeriğini de çekmek için kullanılabilir.
- Entegrasyon yapan iş ortaklarımızdan yeni gelen bütün irsaliye içerikleri (XML) beraber müşteri ortamına çekilmesini tavsiye ediyoruz.
- İçerik ile beraber en fazla 100 fatura çekilebilir.
- Fatura özet bilgileri ile en fazla 25000 adet fatura dönülmektedir.
- Alıcı tarafından zamanlanmış fatura çekme özelliği eklenecekse en fazla 15 dakika aralığında olmalıdı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 |
select |
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. |
SEARCH_KEY |
object |
Hayir | |
└ LIMIT |
text |
Hayir | Kaç kayıt okunmak istendiği. Eğer eleman gönderilmezse 10 adet, içerikleri (XML) ile beraber en fazla 100 adet, sadece özet/başlıklarını çekildiğinde ise en fazla 25.000 adet kayıt dönülür. |
└ ID |
text |
Hayir | İrsaliye numarası ile okumak için kullanılabilir. örnek: FYA2018000000001 |
└ UUID |
text |
Hayir | Evrensel Tekil Tanımlama Numarası (ETTN) ile okumak için kullanılabilir. GUID formatında |
└ 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 muhasebe departmanından gelen belgeleri okumak için kullanılabilir. örnek: urn:mail:muhasebegb@firma.com |
└ TO |
text |
Hayir | Birden fazla Posta Kutusu (PK) etiketi olan bir firmanın sadece bir PK adresine gelen belgeleri çekmek için kullanılabilir. Eğer etiket gönderilmez ise kullanıcının yetkisine bağlı olarak bütün irsaliyeler dönülür. urn:mail:muhasebepk@firma.com |
└ START_DATE |
text |
Hayir | Belirli tarih aralığında ki irsaliyeleri çekmek istendiğinde dönem başlangıç tarihi. format: YYYY-MM-DD |
└ END_DATE |
text |
Hayir | |
└ READ_INCLUDED |
select |
Hayir | |
HEADER_ONLY |
select |
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 irsaliyeler XML ile beraber dönülür. Y değeri gönderilirse irsaliyelerin özeti dönülür. Gönderilebilecek değerler: Y/N |