EFA (E-Devlet)
E-Devlet modülüne ait servisler bu kısımda bulunmaktadır.
Kaynak URL
https://SUNUCUKODU.ws.dia.com.tr/api/v3/efa/json
efa_fatura_goruntule
E-Fatura ve e-arşiv görüntüler.
Yetki Kodu: E-Fatura Görüntüleme
Kontör: Evet
Dönüş Değeri: DiaDictResultV3
Örnek JSON İsteği: efa_fatura_goruntule.json
Örnek JSON Cevap: efa_fatura_goruntule_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| params | AnyDict | Evet | İçerisinde faturano, type, format_type alanlarını bulunduran parametreler. type alanı 'efatura' veya 'earsiv' olarak verilmelidir. |
efa_kayitli_kullanici_sorgula
E-fatura kayıtlı kullanıcı listesinde olan ve Vergi / TC numarası sorgulanan kullanıcının; unvan, posta kutusu, gönderici birim adreslerini getirir.
Yetki Kodu: E-Fatura Giden Kutusu
Kontör: Evet
Dönüş Değeri: DiaListResultV3
Örnek JSON İsteği: efa_kayitli_kullanici_sorgula.json
Örnek JSON Cevap: efa_kayitli_kullanici_sorgula_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| vergitcno | Unicode | Evet | Sorgulanması İstenilen Vergi / TC numarası girilmelidir. |
efa_efatura_listele
E-Fatura faturalarını listeler.
Yetki Kodu: E-Fatura Listeleme
İlgili Ekranlar: efa1030 - efa1010
Kontör: Evet
Dönüş Değeri: DiaListResultV3
Örnek JSON İsteği: efa_efatura_listele.json
Örnek JSON Cevap: efa_efatura_listele_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| filters | DiaWsFilter | Hayır | Liste filtresi |
| sorts | DiaSort | Hayır | Sıralama opsiyonları |
| params | AnyDict | Hayır | Servise gönderilecek ekstra parametreler ( wsGetirXml parametresini True göndermeniz halinde belgenin xml bilgisine ulaşabilirsiniz. ) |
| limit | Integer16 | Hayır | Kaç kayıt döndürülsün isteniyorsa girilir, sıfırsa veya hiç eklenmemişse parametre tüm kayıtlar döner. |
| offset | Integer16 | Hayır | Hangi kayıttan itibaren veriler gösterilsin isteniyorsa. |
efa_eirsaliye_listele
E-İrsaliye irsaliyelerini listeler.
Yetki Kodu: E-İrsaliye Listeleme
İlgili Ekranlar: efa3000 - efa3010
Kontör: Evet
Dönüş Değeri: DiaListResultV3
Örnek JSON İsteği: efa_eirsaliye_listele.json
Örnek JSON Cevap: efa_eirsaliye_listele_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| filters | DiaWsFilter | Hayır | Liste filtresi |
| sorts | DiaSort | Hayır | Sıralama opsiyonları |
| params | AnyDict | Hayır | Servise gönderilecek ekstra parametreler ( wsGetirXml parametresini True göndermeniz halinde belgenin xml bilgisine ulaşabilirsiniz. ) |
| limit | Integer16 | Hayır | Kaç kayıt döndürülsün isteniyorsa girilir, sıfırsa veya hiç eklenmemişse parametre tüm kayıtlar döner. |
| offset | Integer16 | Hayır | Hangi kayıttan itibaren veriler gösterilsin isteniyorsa. |
efa_earsiv_listele
E-Arşiv faturalarını listeler.
Yetki Kodu: E-Arşiv Listeleme
İlgili Ekranlar: efa2000
Kontör: Evet
Dönüş Değeri: DiaListResultV3
Örnek JSON İsteği: efa_earsiv_listele.json
Örnek JSON Cevap: efa_earsiv_listele_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| filters | DiaWsFilter | Hayır | Liste filtresi |
| sorts | DiaSort | Hayır | Sıralama opsiyonları |
| params | AnyDict | Hayır | Servise gönderilecek ekstra parametreler ( wsGetirXml parametresini True göndermeniz halinde belgenin xml bilgisine ulaşabilirsiniz. ) |
| limit | Integer16 | Hayır | Kaç kayıt döndürülsün isteniyorsa girilir, sıfırsa veya hiç eklenmemişse parametre tüm kayıtlar döner. |
| offset | Integer16 | Hayır | Hangi kayıttan itibaren veriler gösterilsin isteniyorsa. |
efa_earsiv_gonder
E-Arşiv faturalarını gönderir.
Yetki Kodu: E-Arşiv Gönderme
İlgili Ekranlar: efa2000
Kontör: Evet
Dönüş Değeri: DiaListResultV3
Örnek JSON İsteği: efa_earsiv_gonder.json
Örnek JSON Cevap: efa_earsiv_gonder_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| sorts | DiaSort | Hayır | Sıralama opsiyonları |
| params | AnyDict | Hayır | Servise gönderilecek ekstra parametreler ( efaearsivkeys parametresini göndermeniz halinde belgenin gönderildi bilgisine ulaşabilirsiniz. ) |
efa_ebelge_bilgi_getir
E-Belgeleri listeler.
Kontör: Hayır
Dönüş Değeri: DiaListResultV3
Örnek JSON İsteği: efa_ebelge_bilgi_getir.json
Örnek JSON Cevap: efa_ebelge_bilgi_getir_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| uuid | Array(Unicode) | Evet | Fatura uuid listesi. |
efa_efatura_gonder
E-Fatura gönderir.
Yetki Kodu: E-Fatura Gönderme
İlgili Ekranlar: efa2000
Kontör: Evet
Dönüş Değeri: DiaListResultV3
Örnek JSON İsteği: efa_efatura_gonder.json
Örnek JSON Cevap: efa_efatura_gonder_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| sorts | DiaSort | Hayır | Sıralama opsiyonları |
| params | AnyDict | Hayır | Servise gönderilecek ekstra parametreler ( keys parametresini göndermeniz halinde belgenin gönderildi bilgisine ulaşabilirsiniz. ) |
efa_efatura_olustur
E-Fatura Oluşturur.
Yetki Kodu: E-Fatura Oluştur
İlgili Ekranlar: efa2000
Kontör: Evet
Dönüş Değeri: DiaListResultV3
Örnek JSON İsteği: efa_efatura_olustur.json
Örnek JSON Cevap: efa_efatura_olustur_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| sorts | DiaSort | Hayır | Sıralama opsiyonları |
| params | AnyDict | Hayır | Servise gönderilecek ekstra parametreler ( faturakeys ve _key_xsltfile parametresini göndermeniz halinde belgenin oluşturuldu bilgisine ulaşabilirsiniz. ) |
efa_efatura_redkabul
E-Fatura Red-Kabul durumunu günceller.
Yetki Kodu: E-Fatura Durumu
İlgili Ekranlar: efa2000
Kontör: Evet
Dönüş Değeri: DiaListResultV3
Örnek JSON İsteği: efa_efatura_redkabul.json
Örnek JSON Cevap: efa_efatura_redkabul_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| sorts | DiaSort | Hayır | Sıralama opsiyonları |
| params | AnyDict | Hayır | Servise gönderilecek ekstra parametreler ( keys ,responsecode ve responsedesc parametresini göndermeniz halinde belgenin kabul-red durumunun değiştirilme bilgisine ulaşabilirsiniz. ) |
efa_efatura_sil
E-Fatura siler.
Yetki Kodu: E-Fatura Silme
Kontör: Evet
Dönüş Değeri: DiaWsResultV3
Örnek JSON İsteği: efa_efatura_sil.json
Örnek JSON Cevap: efa_efatura_sil_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| params | AnyDict | Hayır | Servise gönderilecek ekstra parametreler ( keys parametresini göndermeniz halinde belgenin silindi bilgisine ulaşabilirsiniz. ) |
efa_eirsaliye_arsivle
E-İrsaliye Arşivler.
Yetki Kodu: E-İrsaliye Arşivleme
Kontör: Evet
Dönüş Değeri: DiaListResultV3
Örnek JSON İsteği: efa_eirsaliye_arsivle.json
Örnek JSON Cevap: efa_eirsaliye_arsivle_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| sorts | DiaSort | Hayır | Sıralama opsiyonları |
| params | AnyDict | Hayır | Servise gönderilecek ekstra parametreler ( eirsaliyekeys parametresini göndermeniz halinde belgenin arşivlenme bilgisine ulaşabilirsiniz. ) |
efa_eirsaliye_gonder
E-İrsaliye irsaliyelerini gönderir.
Yetki Kodu: E-İrsaliye Gönderme
İlgili Ekranlar: efa3000 - efa3010
Kontör: Evet
Dönüş Değeri: DiaListResultV3
Örnek JSON İsteği: efa_eirsaliye_gonder.json
Örnek JSON Cevap: efa_eirsaliye_gonder_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| sorts | DiaSort | Hayır | Sıralama opsiyonları |
| params | AnyDict | Hayır | Servise gönderilecek ekstra parametreler ( keys parametresini göndermeniz halinde belgenin gönderildi bilgisine ulaşabilirsiniz. ) |
efa_eirsaliye_olustur
E-İrsaliye Oluşturur.
Yetki Kodu: E-Fatura Oluştur
İlgili Ekranlar: efa3000 - efa3010
Kontör: Evet
Dönüş Değeri: DiaListResultV3
Örnek JSON İsteği: efa_eirsaliye_olustur.json
Örnek JSON Cevap: efa_eirsaliye_olustur_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| sorts | DiaSort | Hayır | Sıralama opsiyonları |
| params | AnyDict | Hayır | Servise gönderilecek ekstra parametreler ( irsaliyekeys ve _key_xsltfile parametresini göndermeniz halinde belgenin oluşturuldu bilgisine ulaşabilirsiniz. ) |
efa_eirsaliye_redkabulkismi
E-İrsaliye Red-Kabul durumunu günceller.
Yetki Kodu: E-İrsaliye Durumu
İlgili Ekranlar: efa3000 - efa3010
Kontör: Evet
Dönüş Değeri: DiaListResultV3
Örnek JSON İsteği: efa_eirsaliye_redkabulkismi.json
Örnek JSON Cevap: efa_efatura_redkabulkismi_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| sorts | DiaSort | Hayır | Sıralama opsiyonları |
| params | AnyDict | Hayır | Servise gönderilecek ekstra parametreler ( keys ,responsecode ve responsedesc parametresini göndermeniz halinde belgenin kabul-red durumunun değiştirilme bilgisine ulaşabilirsiniz. ) |
efa_fatura_arsivle
E-Fatura Fatura Arşivler.
Yetki Kodu: E-Fatura Arşivleme
Kontör: Evet
Dönüş Değeri: DiaWsResultV3
Örnek JSON İsteği: efa_efatura_arvsivle.json
Örnek JSON Cevap: efa_efatura_arsivle_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| params | AnyDict | Hayır | Servise gönderilecek ekstra parametreler ( efaturakeys parametresini göndermeniz halinde belgenin silindi bilgisine ulaşabilirsiniz. ) |
efa_fatura_durum_sorgula
E-Fatura Fatura durumunu sorgular.
Yetki Kodu: E-Fatura Görüntüleme
Kontör: Evet
Dönüş Değeri: DiaDictResultV3
Örnek JSON İsteği: efa_fatura_durum_sorgula.json
Örnek JSON Cevap: efa_fatura_durum_sorgula_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| params | AnyDict | Evet | Servise gönderilecek ekstra parametreler ( keys parametresini göndermeniz halinde belgenin silindi bilgisine ulaşabilirsiniz. ) |
efa_iptal_et
E-Fatura Fatura İptal Eder.
Yetki Kodu: E-Fatura Silme
Kontör: Evet
Dönüş Değeri: DiaWsResultV3
Örnek JSON İsteği: efa_iptal_et.json
Örnek JSON Cevap: efa_efatura_sil_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| params | AnyDict | Hayır | Servise gönderilecek ekstra parametreler ( efaturakeys parametresini göndermeniz halinde belgenin durumunun iptal edildi bilgisine ulaşabilirsiniz. ) |
efa_eirsaliye_durum_sorgula
E-İrsaliye İrsaliye durumunu getirir.
Yetki Kodu: E-İrsaliye Durumu
İlgili Ekranlar: efa3000 - efa3010
Kontör: Evet
Dönüş Değeri: DiaListResultV3
Örnek JSON İsteği: efa_irsaliye_durum_sorgula.json
Örnek JSON Cevap: efa_irsaliye_durum_sorgula_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| sorts | DiaSort | Hayır | Sıralama opsiyonları |
| params | AnyDict | Hayır | Servise gönderilecek ekstra parametreler ( keys parametresini göndermeniz halinde belgenin durum bilgisine ulaşabilirsiniz. ) |
efa_irsaliye_goruntule
E-İrsaliye görüntüler.
Yetki Kodu: E-İrsaliye Görüntüleme
Kontör: Evet
Dönüş Değeri: DiaDictResultV3
Örnek JSON İsteği: efa_irsaliye_goruntule.json
Örnek JSON Cevap: efa_irsaliye_goruntule_cevap.json
| Parametre | Tipi | Zorunluluk | Açıklama |
|---|---|---|---|
| session_id | Unicode | Evet | Oturum id |
| firma_kodu | Integer16 | Evet | Firma kodu |
| donem_kodu | Integer16 | Hayır | Dönem kodu (Gönderilmezse ya da 0 gönderilirse öntanımlı dönemi alır) |
| params | AnyDict | Evet | İçerisinde irsaliyeno, type, format_type alanlarını bulunduran parametreler. type alanı 'eirsaliye' olarak verilmelidir. |