REST API v2.1.0 Dokümantasyonu

Bu dokümantasyon NES Bilgi REST API'nin çalışma prensiplerini anlatmaktadır. NES Bilgi ile kendi uygulamalarını entegre etmek isteyen firmalar bu dokümanı baz alarak REST API'yi kullanabilirler.

GENEL Bilgiler

NES Bilgi REST API'yi kullanabilmek için sistemimizde kayıtlı bir hesabınızın bulunması gerekmektedir.

Token

Örnek İstek - [AJAX]

Firma İle Alakalı Metodlar - Account

URL Parametreleri
Parametre Zorunluluk Açıklama
enum xsltType
eInvoice = 'EFatura'
eArchive = 'E-Arşiv'
eSMM = 'e-Serbest Meslek M.'
eMM = 'e-Mustahsil M.'
eDespatch = 'e-İrsaliye'
eDespatchAnswer = 'e-İrsaliye Yanıtı'
Yanıt Parametreleri - [List<AccountTemplate> Nesnesi]
Parametre Açıklama Değer
string Title
XSLT Başlığı
bool IsDefault
XSLT'nin Varsayılan Olup Olmadığı Bilgisi
true Varsayılan
false Varsayılan Değil
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
URL Parametreleri
Parametre Zorunluluk Açıklama
enum xsltType
eInvoice = 1
eArchive = 2
eSMM = 6
eMM = 7
eDespatch = 4
eDespatchAnswer = 99
string title
TemplateList den dönen XSLT Başlığı girilmelidir.
Örnek İstek - [AJAX]
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Detay
176 DOSYA DISKTEN OKUNAMADI
177 DOSYA HESABINIZDA BULUNAMADI! Title'a girilen değere ait XSLT olmadığında bu hatayı alırsınız
Yanıt Parametreleri - CreditDetailResponse
CreditDetailResponse Nesnesi
Parametre Açıklama
int EInvoiceUseCount
E-Fatura tarafında kullanılan kontör sayısı bu alanda dönülür.
int EArchiveUseCount
E-Arşiv tarafında kullanılan kontör sayısı bu alanda dönülür.
int EBookUseCount
E-Defter tarafında kullanılan kontör sayısı bu alanda dönülür.
int MailUseCount
Mail için kullanılan kontör sayısı bu alanda dönülür.
int SMSUseCount
SMS için kullanılan kontör sayısı bu alanda dönülür.
Datetime CalculateDate
Kontör kullanımının en son ne zaman hesaplandığı bilgisi bu alanda dönülür.
int TotalUseCount
Toplam kullanılan kontör sayısı bu alanda dönülür.
int TotalBuyCount
Toplam satın alınan kontör sayısı bu alanda dönülür.
int Result
Kalan kontör sayısı bu alanda dönülür.
int UsePercentage
Kullanılan kontörün yüzde cinsinden değeri bu alanda dönülür.
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Detay
197 HESAP KONTORLU DEGIL Sorgulanan hesabın aylık faturalandırma modelini kullanması durumunda bu hata dönülür.

E-Fatura Mükellefleri İle Alakalı Metodlar - Customer

URL Parametreleri
Parametre Zorunluluk Açıklama
string regsterNumber
Sorgulanacak firmanın VKN/TCKN bilgisi
Yanıt Parametreleri - CustomerCheckResult
CustomerCheckResult Nesnesi
Parametre Açıklama Değer
List<GlobalCustomer> CustomerList
Sorgulanan mükellef e-Fatura olması durumunda, mükellefin etiket listesi ve diğer bilgileri bu nesnede döner
bool ISEInvoiceCustomer
E-Fatura mükellefi olup olmadığının bilgisi
true  : E-Fatura Mükellefi
false  : E-Fatura Mükellefi Değil
GlobalCustomer Nesnesi
Parametre Açıklama
string RegisterNumber
Sorgulanan firma/kişi VKN/TCKN bilgisi bu alanda döner
string Title
Firma/Kişinin GIB'de kayıtlı ünvan bilgisi bu alanda döner
string Alias
Firma/Kişinin GIB'de kayıtlı Etiket bilgisi bu alanda döner
string Type
Firma/Kişinin Özel/Kamu bilgisi bu alanda döner.
Datetime FirstCreationTime
Firma/Kişinin E-Fatura'ya ilk kayıt olduğu tarih bu alanda döner.
Datetime AliasCreationTime
İlgili etiketin güncellenme/kayıt edilme tarihi bu alanda döner.
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
Yanıt Parametreleri - GlobalCustomer Listesi
List<GlobalCustomer> Nesnesi Döner
Örnek İstek - [AJAX]
Yanıt
Örnek İstek - [AJAX]

E-Fatura, E-Arşiv Genel Metodlar - InvoiceGeneral

URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
Faturanın ETTN değeri
Örnek İstek - [AJAX]
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
160 FATURA HESABINIZDA BULUNAMADI
175 FATURA DISKTEN OKUNAMADI
190 E-FATURA/E-ARSIV URUNU HESABINIZDA TANIMLI DEGIL!
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
Faturanın ETTN değeri
Örnek İstek - [AJAX]
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
160 FATURA HESABINIZDA BULUNAMADI
175 FATURA DISKTEN OKUNAMADI
190 E-FATURA/E-ARSIV URUNU HESABINIZDA TANIMLI DEGIL!
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
Faturanın ETTN değeri
Örnek İstek - [AJAX]
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
160 FATURA HESABINIZDA BULUNAMADI
175 FATURA DISKTEN OKUNAMADI
190 E-FATURA/E-ARSIV URUNU HESABINIZDA TANIMLI DEGIL!
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
Faturanın ETTN değeri
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]

Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
160 FATURA HESABINIZDA BULUNAMADI
190 E-FATURA/E-ARSIV URUNU HESABINIZDA TANIMLI DEGIL!
İstek Parametreleri
Parametre Zorunluluk Açıklama
UBLInvoiceSendRequest request
İstek detayları aşağıda anlatılmıştır
UBLInvoiceSendRequest Nesne Detayı
Parametre Zorunluluk Açıklama
NESTransferDocument transferDocument
Gönderilecek olan UBL faturanın detay bilgileri bu alana eklenir.
NESTransferDocument Nesne Detayları
Parametre Açıklama
string UUID
Faturanın UUID değeri.
string FileName
{Fatura UUID}.xml şeklinde olmalıdır.
string ZIPFileBase64

Gönderilecek XML formatındaki faturanın zip halindeki string Base64 değeri bu alana eklenir.

bool IsDirectSend
Faturanın direkt gönderilip/gönderilmeyeceği bu alanla belirlenir.
true olduğu durumda fatura direkt alıcısına iletilir.
false olması durumunda faturayı portal üzerinden onaylayıp göndermek gerekir.
enum invoiceProfile
TEMELFATURA = 0 , TICARIFATURA = 1 , IHRACAT = 2 , YOLCUBERABERFATURA = 3 , EARSIVFATURA = 4
string customerRegisterNumber
Fatura alıcısının vkn/tckn bilgisi.
string eInvoiceAlias
Faturayı alıcısının etiket/alias bilgisi.
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
178 DOSYA ZIP FORMATINDA OLMALIDIR 191 E-ARSIV URUNU HESABINIZDA TANIMLI DEGIL!
192 E-FATURA URUNU HESABINIZDA TANIMLI DEGIL
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
İstek Parametreleri
Parametre Zorunluluk Açıklama
NESInvoiceSendRequest request
İstek detayları aşağıda anlatılmıştır
NESInvoiceSendRequest Nesne Detayı
Parametre Zorunluluk Açıklama
NESInvoice nesInvoice
NESInvoice nesnesinin detayları için tıklayınız.
enum invoiceProfile
TEMELFATURA = 0 , TICARIFATURA = 1 , IHRACAT = 2 , YOLCUBERABERFATURA = 3 , EARSIVFATURA = 4
string customerRegisterNumber
Alıcı firma/kişi nin vkn/tckn bilgisi.
bool isDirectSend
Faturanın direkt gönderilip/gönderilmeyeceği bu alanla belirlenir.
true olduğu durumda fatura direkt alıcısına iletilir.
false olması durumunda faturayı portal üzerinden onaylayıp göndermek gerekir.
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
180 NESINVOICE NESNESI UBL'E CEVRILEMEDI! 191 E-ARSIV URUNU HESABINIZDA TANIMLI DEGIL!
192 E-FATURA URUNU HESABINIZDA TANIMLI DEGIL
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
URL Parametreleri
Parametre Zorunluluk Açıklama
string UUID
Faturanın ETTN değeri
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
160 FATURA HESABINIZDA BULUNAMADI
URL Parametreleri
Parametre Zorunluluk Açıklama
string UUID
Faturanın ETTN değeri
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
160 FATURA HESABINIZDA BULUNAMADI 110 MUTESELSILLIK PROBLEMI

E-Arşivle Alakalı Metodlar - EArchive

URL Parametleri
Parametre Zorunluluk Açıklama
string uuid
Faturanın ETTN değeri
Yanıt Parametreleri - InvoiceStatus
InvoiceStatus Nesnesi
Parametre Açıklama
int InvoiceStatusCode
Fatura durumunun kodu bu alanda döner
string InvoiceStatusDescription
Fatura durum açıklaması bu alanda döner
string InvoiceStatusDetailDescription
Fatura durum açıklamasının detayı bu alanda döner
bool IsCancel
Faturanın iptal edilip edilmediği bu alanda dönülür. true = 'İptal Edildi' , false = 'İptal Edilmedi'
Yanıt Olarak Dönebilecek Durum Kodları Listesi
Durum Kodu Açıklama
102 FATURA KUYRUKTA HATA ALDI
103 FATURA KUYRUKTA ISLENMEYI BEKLIYOR
104 FATURA KUYRUKTA ISLENIYOR
105 FATURA KUYRUK ISLEMLERI TAMAMLANDI
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
101 FATURA KUYRUKTA BULUNAMADI
106 FATURA KUYRUK DURUMU BILINMIYOR
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
URL Parametleri
Parametre Zorunluluk Açıklama
string uuid
Faturanın ETTN değeri
Yanıt Parametreleri - List <MailSendInfo>
MailSendInfo Nesnesi
Parametre Açıklama Değer
string ReceiverMail
Mailin gönderildiği adres bilgisi bu alanda döner.
bool IsRead
Gönderilen mailin okunup okunmadığı bilgisi bu alanda döner.
true Okundu | 
false Okunmadı
Datetime ReadDate
Mailin okunma tarihi.
bool IsSend
Mailin başarıyla gönderilip gönderilmediği bilgisi bu alanda döner.
true Gönderildi | 
false Gönderilemedi
Datetime SendDate
Mailin gönderilme tarihi.
bool IsStatusCheck
Gönderilen mailing durumunun sorgulanıp sorgulanmadığının bilgisi bu alanda döner.
true Sorgulandı | 
false Henüz Sonuçlanmadı
bool IsDownload
Mailin içerisindeki XML/PDF dosyasının indirilip indirilemediği bilgisi bu alanda döner.
true İndirildi | 
false İndirilmedi
bool IsView
Mailin içerisindeki faturanın görüntülenip görüntülenmediği bilgisi bu alanda döner.
true Görüntülendi | 
false Görüntülenmedi
string SendErrorDescription
Mail gönderiminde hata olması durumunda hata detayı bu alnda döner.
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
160 FATURA HESABINIZDA BULUNAMADI
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
URL Parametleri
Parametre Zorunluluk Açıklama
string uuid
Faturanın ETTN değeri
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
101 FATURA KUYRUKTA BULUNAMADI
102 FATURA KUYRUKTA HATA ALDI
103 FATURA KUYRUKTA ISLENMEYI BEKLIYOR
104 FATURA KUYRUKTA ISLENIYOR
106 FATURA KUYRUK DURUMU BILINMIYOR
179 FATURA DAHA ONCE IPTAL EDILMIS
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
İstek Parametreleri
Parametre Zorunluluk Açıklama
SendMailRequest request
İstek detayları aşağıda anlatılmıştır
SendMailRequest Nesne Detayı
Parametre Zorunluluk Açıklama
string InvoiceUUID
Mail gönderilmek istenen faturanın ETTN değeri.
List<string>  ReceiverMailList Faturanın mail olarak gönderilmesini istediğiniz mail adresi listesi girilir.
Yanıt Parametreleri - SendMailResult
List<SendMailResult> Nesnesi Döner
SendMailResult Nesne Detayları
Parametre Açıklama Değer
bool ResultStatus
Mail gönderim sonucu
true Başarılı | 
false Hatalı
string ReceiverMail
Alıcı mail adresi
string Description
Mail gönderim durum açıklaması. Hata olması durumunda bu alanda detayları döner.
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]

E-Fatura İle Alakalı Metodlar - EInvoice

URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
Faturanın ETTN değeri
Yanıt Parametreleri - EInvoiceStatusResult
EInvoiceStatusResult Nesnesi
Parametre Açıklama
string InvoiceProfile
Faturanın senaryo bilgisi bu alanda döner
Datetime? InvoiceDate
Fatura tarihi bu alanda döner
EInvoiceAnswerResult Answer
Ticari Fatura olması durumunda cevap bilgileri ve durumu bu alanda dönülür. (Nesne detayları aşağıda anlatılmıştır)
EInvoiceAnswerResult Nesne Detayları
Parametre Açıklama
EInvoiceAnswerStatus Status
Cevap durumu bu alanda dönülür. (Nesne detayları aşağıda anlatılmıştır)
EInvoiceAnswerStatus Nesne Detayları
int Code
Cevap durumu kodu bu alanda dönülür.
Durum Kodları Listesi
Durum Kodu Açıklama Durum Kodu Açıklama
141 FATURA CEVABI GELMEDI 142 FATURA CEVABI ALINDI ISLEM BEKLENIYOR
143 FATURA CEVABI ALINDI YANITI GONDERILDI ISLEMLER TAMAMLANDI 144 FATURA CEVABI GELDI. FATURA CEVABI ICIN ALINDI YANITI GONDERILEMEDI!
string Description
Cevap durumu açıklaması bu alanda dönülür.
string DetailDescription
Cevap durumu açıklamasının detayları bu alanda dönülür.
EInvoiceAnswerDetail Detail
Cevap bilgileri bu alanda dönülür. (Nesne detayları aşağıda anlatılmıştır)
EInvoiceAnswerDetail Nesne Detayları
enum InvoiceAnswer
Fatura cevabı bu alanda döner. Accepted = 'Kabul Edildi' , Rejected = 'Reddedildi'
string AnswerNote
Cevap notu bu alanda dönülür.
Datetime AnswerDate
Cevap tarihi bu alanda dönülür.
EInvoiceStatus InvoiceStatus
Fatura durumu bu alanda dönülür. (Nesne detayları aşağıda anlatılmıştır)
EInvoiceStatus Nesne Detayları
Parametre Açıklama
int Code
Fatura durum kodu bu alanda dönülür. Aşağıdaki durum kodlarına göre yazılımınızda özelleştirmeler yapabilirsiniz.
Durum Kodları Listesi
Durum Kodu Açıklama Durum Kodu Açıklama
101 FATURA KUYRUKTA BULUNAMADI 102 FATURA KUYRUKTA HATA ALDI
103 FATURA KUYRUKTA ISLENMEYI BEKLIYOR 105 FATURA KUYRUK ISLEMLERI TAMAMLANDI
106 FATURA KUYRUK DURUMU BILINMIYOR 121 FATURA, FATURA LISTESINDE ONAYLANMAYI BEKLIYOR
165 FATURA ONAYLANIP/GONDERILMEDEN IPTAL EDILDI 122 FATURA UZERINDE ISLEM YAPILIYOR
123 FATURA SISTEM TARAFINDAN GONDERILMEYI BEKLIYOR 124 FATURA ALICIYA GONDERILDI ISLEMLERI TAMAMLANDI
131 FATURA HATALI 132 FATURA DURUMU BILINMIYOR
string Description
Fatura durum açıklaması bu alanda dönülür.
string DetailDescription
Fatura durum açıklamasının detayları bu alanda dönülür.
EInvoiceEnvelopeInfo EnvelopeInfo
Zarf bilgileri bu alanda dönülür. (Nesne detayları aşağıda anlatılmıştır)
EInvoiceEnvelopeInfo Nesne Detayları
Parametre Açıklama
string EnvelopeNumber
Zarf numarası bu alanda dönülür.
string EnvelopeDate
Zarf tarihi bu alanda dönülür.
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
URL Parametreleri
Parametre Zorunluluk Açıklama
string accountAlias
Eğer gelen faturaları etiket (Alias) bazlı listelemek ve etiket bazlı içeriye almak istediğiniz durumda buraya alıcı etiket bilgisini girmelisiniz.
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
Faturanın ETTN değeri
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
150 FATURA ISLEMLERI TAMAMLANMADI! 170 FATURA DAHA ONCE ERP TRANSFER EDILDI OLARAK ISARETLENMIS
171 FATURA HATALI ERP YE TRANSFER EDILMIS OLAMAZ 160 FATURA HESABINIZDA BULUNAMADI
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
İstek Parametreleri
Parametre Zorunluluk Açıklama
SetAnswer request
İstek detayları aşağıda anlatılmıştır
SetInvoiceAnswer Nesne Detayı
Parametre Zorunluluk Açıklama
string InvoiceUuid
Cevap verilmek istenen faturanın ETTN değeri girilmelidir.
enum Answer
Accepted = 'Kabul'
Rejectted = 'Red'
string RejectNote
Reddedilmesi durumunda Red sebebi bu alana girilmesi zorunludur. Kabullerde boş bırakılabilir.
bool IsDirectSend
Verilen cevabın direkt gönderilip/gönderilmeyeceği bu alanla belirlenir.
true olduğu durumda fatura cevabı direkt alıcısına iletilir.
false olması durumunda cevabı portal üzerinden onaylayıp göndermek gerekir.
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
150 FATURA ISLEMLERI TAMAMLANMADI! 160 FATURA HESABINIZDA BULUNAMADI
172 FATURA DAHA ONCE CEVAPLANDI 173 FATURA HATALI CEVAP VERILEMEZ
174 FATURA TEMEL FATURADIR CEVAP VERILEMEZ
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
URL Parametleri
Parametre Zorunluluk Açıklama
string uuid
Faturanın ETTN değeri
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
160 FATURA HESABINIZDA BULUNAMADI
181 FATURA IHRACAT FATURASI OLMALIDIR
182 GTB REFERANS NUMARASI GELMEDI
Örnek İstek - [AJAX]
URL Parametleri
Parametre Zorunluluk Açıklama
string uuid
Faturanın ETTN değeri
Yanıt Parametreleri - KeyValue Listesi
List<KeyValue> Nesnesi Döner
Parametre Açıklama
string Key
İglili bilginin kodu bu alanda dönülür.
string Value
İglili bilginin değeri bu alanda dönülür.
Yanıt Olarak Dönebilecek Key [Anahtar] Listesi
Kod Açıklama
GTB_FIILI_IHRACAT_TARIHI İhracat faturasının kabul edilmesinden sonra fiili çıkış tarihi bilgisi GTB tarafından bu kodla dönülür.
GTB_GCB_TESCILNO İhracat faturasına ait Gümrük Çıkış Beyannamesinin tescil numarası bu kodla dönülür.
GTB_REFNO 23 Haneli GTB referans numarası bu kodla dönülür.
GTP_CEVAP_NOTU Faturaya verilen cevabın açıklaması bu kodla dönülür.
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
160 FATURA HESABINIZDA BULUNAMADI
181 FATURA IHRACAT FATURASI OLMALIDIR
183 GTB BILGILERI HENUZ GELMEDI
Örnek Yanıt - [Json]

E-İrsaliye Mükellefleri İle Alakalı Metodlar - DespatchCustomer

URL Parametreleri
Parametre Zorunluluk Açıklama
string registerNumber
Sorgulanacak firmanın VKN/TCKN bilgisi
Yanıt Parametreleri - EDespatchCustomerCheckResult
EDespatchCustomerCheckResult Nesnesi
Parametre Açıklama Değer
List<GlobalCustomer> CustomerList
Sorgulanan mükellef e-İrsaliye olması durumunda, mükellefin etiket listesi ve diğer bilgileri bu nesnede döner
bool ISEDespatchCustomer
E-Fatura mükellefi olup olmadığının bilgisi
true  : E-İrsaliye Mükellefi
false  : E-İrsaliye Mükellefi Değil
GlobalCustomer Nesnesi
Parametre Açıklama
string RegisterNumber
Sorgulanan firma/kişi VKN/TCKN bilgisi bu alanda döner
string Title
Firma/Kişinin GIB'de kayıtlı ünvan bilgisi bu alanda döner
string Alias
Firma/Kişinin GIB'de kayıtlı Etiket bilgisi bu alanda döner
string Type
Firma/Kişinin Özel/Kamu bilgisi bu alanda döner.
Datetime FirstCreationTime
Firma/Kişinin E-İrsaliye'ye ilk kayıt olduğu tarih bu alanda döner.
Datetime AliasCreationTime
İlgili etiketin güncellenme/kayıt edilme tarihi bu alanda döner.
Örnek Yanıt - [JSON]
Yanıt Parametreleri - GlobalCustomer Listesi
List<GlobalCustomer> Nesnesi Döner

E-İrsaliye İle Alakalı Metodlar - EDespatch

URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
İrsaliyenin ETTN değeri
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
160 IRSALIYE HESABINIZDA BULUNAMADI
175 IRSALIYE DISKTEN OKUNAMADI
189 E-IRSALIYE URUNU HESABINIZDA TANIMLI DEGIL!
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
 İrsaliyenin ETTN değeri
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
160 IRSALIYE HESABINIZDA BULUNAMADI
175 IRSALIYE DISKTEN OKUNAMADI
189 E-IRSALIYE URUNU HESABINIZDA TANIMLI DEGIL!
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
 İrsaliyenin ETTN değeri
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
160 IRSALIYE HESABINIZDA BULUNAMADI
175 IRSALIYE DISKTEN OKUNAMADI
189 E-IRSALIYE URUNU HESABINIZDA TANIMLI DEGIL!
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
İrsaliyenin ETTN değeri
Örnek Yanıt - [JSON]

Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
160 IRSALIYE HESABINIZDA BULUNAMADI
189 E-IRSALIYE URUNU HESABINIZDA TANIMLI DEGIL!
İstek Parametreleri
Parametre Zorunluluk Açıklama
DespatchAdviceSendRequest request
İstek detayları aşağıda anlatılmıştır
DespatchAdviceSendRequest Nesne Detayı
Parametre Zorunluluk Açıklama
NESTransferDocument transferDocument
Gönderilecek olan UBL irsaliyenin detay bilgileri bu alana eklenir.
NESTransferDocument Nesne Detayları
Parametre Açıklama
string UUID
İrsaliyenin UUID değeri.
string FileName
{İrsaliye UUID}.xml şeklinde olmalıdır.
string ZIPFileBase64

Gönderilecek XML formatındaki irsaliyenin zip halindeki string Base64 değeri bu alana eklenir.

bool IsDirectSend
İrsaliyenin direkt gönderilip/gönderilmeyeceği bu alanla belirlenir.
true olduğu durumda irsaliye direkt alıcısına iletilir.
false olması durumunda irsaliyeyi portal üzerinden onaylayıp göndermek gerekir.
string partyRegisterNumber
İrsaliye alıcısının vkn/tckn bilgisi.
string receiverAlias
İrsaliyeyı alıcısının etiket/alias bilgisi.
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
155 ALICI EIRSALIYE MUKELLEFI DEGILDIR! 178 DOSYA ZIP FORMATINDA OLMALIDIR
189 E-IRSALIYE URUNU HESABINIZDA TANIMLI DEGIL
Örnek Yanıt - [JSON]
İstek Parametreleri
Parametre Zorunluluk Açıklama
NESDespatchSendRequest request
İstek detayları aşağıda anlatılmıştır
NESDespatchSendRequest Nesne Detayı
Parametre Zorunluluk Açıklama
NESDespatch nesDespatch
NESDespatch nesnesinin detayları için tıklayınız.
bool isDirectSend
İrsaliyenin direkt gönderilip/gönderilmeyeceği bu alanla belirlenir.
true olduğu durumda irsaliye direkt alıcısına iletilir.
false olması durumunda irsaliyeyi portal üzerinden onaylayıp göndermek gerekir.
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
180 NESDESPATCH NESNESI XML'E CEVRILEMEDI! 178 DOSYA ZIP FORMATINDA OLMALIDIR
155 ALICI EIRSALIYE MUKELLEFI DEGILDIR! 189 E-IRSALIYE URUNU HESABINIZDA TANIMLI DEGIL
Örnek Yanıt - [JSON]
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
İrsaliyenin ETTN değeri
Yanıt Parametreleri - EDespatchStatusResult
EDespatchStatusResult Nesnesi
Parametre Açıklama
Datetime? DespatchDate
İrsaliye tarihi bu alanda döner
EDespatchStatus DespatchStatus
İrsaliye durumu bu alanda dönülür. (Nesne detayları aşağıda anlatılmıştır)
EDespatchStatus Nesne Detayları
Parametre Açıklama
int Code
İrsaliye durum kodu bu alanda dönülür. Aşağıdaki durum kodlarına göre yazılımınızda özelleştirmeler yapabilirsiniz.
Durum Kodları Listesi IRSALIYE ALICIYA GONDERILDI ISLEMLERI TAMAMLANDI
Durum Kodu Açıklama Durum Kodu Açıklama
101 IRSALIYE KUYRUKTA BULUNAMADI 102 IRSALIYE KUYRUKTA HATA ALDI
103 IRSALIYE KUYRUKTA ISLENMEYI BEKLIYOR 105 IRSALIYE KUYRUK ISLEMLERI TAMAMLANDI
106 IRSALIYE KUYRUK DURUMU BILINMIYOR 121 IRSALIYE, IRSALIYE LISTESINDE ONAYLANMAYI BEKLIYOR
165 IRSALIYEONAYLANIP/GONDERILMEDEN IPTAL EDILDI 122 IRSALIYEUZERINDE ISLEM YAPILIYOR
123 IRSALIYESISTEM TARAFINDAN GONDERILMEYI BEKLIYOR 124
131 IRSALIYEHATALI 132 IRSALIYEDURUMU BILINMIYOR
string Description
İrsaliye durum açıklaması bu alanda dönülür.
string DetailDescription
İrsaliye durum açıklamasının detayları bu alanda dönülür.
EDespatchEnvelopeInfo EnvelopeInfo
Zarf bilgileri bu alanda dönülür. (Nesne detayları aşağıda anlatılmıştır)
EDespatchEnvelopeInfo Nesne Detayları
Parametre Açıklama
string EnvelopeNumber
Zarf numarası bu alanda dönülür.
string EnvelopeDate
Zarf tarihi bu alanda dönülür.
URL Parametreleri
Parametre Zorunluluk Açıklama
string accountAlias
Eğer gelen irsaliyeleri etiket (Alias) bazlı listelemek ve etiket bazlı içeriye almak istediğiniz durumda buraya alıcı etiket bilgisini girmelisiniz.
Datetime beginDate
Gelen irsaliyeleri parametre olarak gönderilen tarihten itibaren almak için bu uc kullanılmalıdır.
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
İrsaliyenin ETTN değeri
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
150 IRSALIYE ISLEMLERI TAMAMLANMADI! 170 IRSALIYE DAHA ONCE ERP TRANSFER EDILDI OLARAK ISARETLENMIS
171 IRSALIYE HATALI ERP YE TRANSFER EDILMIS OLAMAZ 160 IRSALIYE HESABINIZDA BULUNAMADI
URL Parametleri
Parametre Zorunluluk Açıklama
string uuid
Gelen e-İrsaliyenin ETTN değeri
Yanıt Parametreleri - InvoiceStatus
DespatchLinesResponse Nesnesi
Parametre Açıklama
List<DespatchLine>  Lines
İrsaliyenin mal bilgileri bu alanda döner
DespatchLine Nesne Detayları
Parametre Açıklama
string Index
Sıra numarası bu alanda dönülür
string Name
Ürün Adı bu alanda dönülür
string DeliveredUnitType
Birim kodu bu alanda dönülür.
decimal DeliveredQuantity
Miktar bilgisi bu alanda dönülür
List<string>  Series
Sistemde tanımlı yanıt serileriniz bu alanda dönülür. Yanıt verirken bu serilerden herhangi birisini kullanırsanız sistem bu serilerden numara üretip yanıtınızı oluşturur. Aksi durumda müteselsil seri numarasını sizin takip etmeniz gerekecektir.
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Durum Kodu Açıklama Durum Kodu Açıklama
160 IRSALIYE HESABINIZDA BULUNAMADI 189 E-IRSALIYE URUNU HESABINIZDA TANIMLI DEGIL
Örnek Yanıt - [JSON]
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
Yanıt vermek istediğiniz gelen e-irsaliyeye ait ETTN bilgisi bu alanda gönderilecektir
İstek Parametreleri
Parametre Zorunluluk Açıklama
NESDespatchAnswer answer
NESDespatchAnswer nesnesinin detayları için tıklayınız.
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
160 IRSALIYE HESABINIZDA BULUNAMADI! 172 IRSALIYE DAHA ONCE CEVAPLANDI
180 NESDespatchAnswer NESNESI UBL'E CEVRILEMEDI! 189 E-IRSALIYE URUNU HESABINIZDA TANIMLI DEGIL!
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
URL Parametreleri
Parametre Zorunluluk Açıklama
Datetime beginDate
Gelen irsaliyele yanıtlarını parametre olarak gönderilen tarihten itibaren almak için bu uc kullanılmalıdır.
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
UnTransferredIncomingAnswer ucun aldığınız (Giden e-irsaliye) ETTN (UUID) değeri
enum fileType
HTML yada XML değerlerini alabilir..
  • XML seçeneğinde ReceiptAdvice xml dönülür.
  • HTML seçeneğinde ise yanıtın önizlenebilir HTML görüntüsü dönülür
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
189 E-IRSALIYE URUNU HESABINIZDA TANIMLI DEGIL! 160 IRSALIYE HESABINIZDA BULUNAMADI
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
UnTransferredIncomingAnswer ucundan aldığınız (Giden e-İrsaliyeye ait) ETTN değeri
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
150 IRSALIYE ISLEMLERI TAMAMLANMADI! 170 IRSALIYE YANITI DAHA ONCE ERP TRANSFER EDILDI OLARAK ISARETLENMIS
171 IRSALIYE CEVABI HATALI ERP YE TRANSFER EDILMIS OLAMAZ 160 IRSALIYE HESABINIZDA BULUNAMADI
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
Gelen e-İrsaliye UUID - (Cevap verdiğiniz e-irsaliyenin UUID değeri)
İstek Parametreleri
Parametre Zorunluluk Açıklama
ReceiptAdviceTransferDocument request
İstek detayları aşağıda anlatılmıştır
ReceiptAdviceTransferDocument Nesne Detayı
Parametre Açıklama
string UUID
İrsaliye yanıtı UUID değeri.
string FileName
{İrsaliye Yanıtı UUID}.xml şeklinde olmalıdır.
string ZIPFileBase64

Gönderilecek XML formatındaki irsaliye yanıtının zip halindeki string Base64 değeri bu alana eklenir.

Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
160 IRSALIYE HESABINIZDA BULUNAMADI 172 IRSALIYE DAHA ONCE CEVAPLANDI!
178 DOSYA ZIP FORMATINDA OLMALIDIR 180 SCHMATRON KONTROL SONUCU HATALI
189 E-IRSALIYE URUNU HESABINIZDA TANIMLI DEGIL 500 SISTEM HATASI
Örnek Yanıt - [JSON]
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
Gelen e-İrsaliye UUID - (Cevap verdiğiniz e-irsaliyenin UUID değeri)
enum fileType
HTML yada XML değerlerini alabilir..
  • XML seçeneğinde ReceiptAdvice xml dönülür.
  • HTML seçeneğinde ise yanıtın önizlenebilir HTML görüntüsü dönülür
Yanıt Parametreleri - OutgoingDespatchAnswerResult
OutgoingDespatchAnswerResult Nesnesi
Parametre Açıklama
byte[] Content
XML / HTML içerik bu alanda dönülür.
string UUID
Oluşan e-İrsaliye yanıtının UUID değeri bu alanda dönülür.
string ID
Oluşan e-İrsaliye yanıtının 16 Haneli irsaliye yanıt numarası bu alanda dönülür.
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama Hata Kodu Açıklama
175 IRSALIYE DISKTEN OKUNAMADI 160 IRSALIYE HESABINIZDA BULUNAMADI 189 E-IRSALIYE URUNU HESABINIZDA TANIMLI DEGIL!
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
Yanıt verdiğiniz gelen e-İrsaliyenin ETTN değeri
Yanıt Parametreleri - OutgoingAnswerStatusResult
OutgoingAnswerStatusResult Nesnesi
Parametre Açıklama
Datetime? IssueDate
İrsaliye Yanıt tarihi bu alanda döner
AnswerStatus AnswerStatus
İrsaliye yanıt durumu bu alanda dönülür. (Nesne detayları aşağıda anlatılmıştır)
AnswerStatus Nesne Detayları
Parametre Açıklama
int Code
İrsaliye yanıtı durum kodu bu alanda dönülür. Aşağıdaki durum kodlarına göre yazılımınızda özelleştirmeler yapabilirsiniz.
Durum Kodları Listesi
Durum Kodu Açıklama Durum Kodu Açıklama
120 IRSALIYEYE HENUZ YANIT VERILMEDI! 122 IRSALIYE YANITI UZERINDE ISLEM YAPILIYOR
123 IRSALIYE YANITI SISTEM TARAFINDAN GONDERILMEYI BEKLIYOR 124 IRSALIYE_YANITI_GONDERILDI_ISLEMLERI_TAMAMLANDI
131 IRSALIYE YANITI HATALI 132 IRSALIYE YANITININ DURUMU BILINMIYOR
string Description
İrsaliye yanıtı durum açıklaması bu alanda dönülür.
string DetailDescription
İrsaliye yanıtı durum açıklamasının detayları bu alanda dönülür.
AnswerEnvelopeInfo EnvelopeInfo
Zarf bilgileri bu alanda dönülür. (Nesne detayları aşağıda anlatılmıştır)
AnswerEnvelopeInfo Nesne Detayları
Parametre Açıklama
string EnvelopeNumber
Zarf numarası bu alanda dönülür.
Datetime EnvelopeDate
Zarf tarihi bu alanda dönülür.

E-Defter ile Alakalı Metodlar

İstek Parametreleri
Parametre Zorunluluk Açıklama
EBookSendRequest request
İstek detayları aşağıda anlatılmıştır
EBookSendRequest Nesne Detayı
Parametre Zorunluluk Açıklama
EBookSendRequest request
Gönderilecek olan E-Defter detay bilgileri bu alana eklenir.
EBookSendRequest Nesne Öğeleri
Parametre Açıklama
byte[] ZipContent
Gönderilecek dosyanın zip içeriği bu alanda gönderilmelidir.
int Period
Gönderilen defter dosyasının dönemi bu alanda gönderilmelidir.
int Year
Gönderilen defter dosyasının yılı bu alanda gönderilmelidir.
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
105 İlgili döneme ait dosya daha önce sisteme yüklendi.
103 İlgili döneme ait dosya kuyrukta işlenmeyi bekliyor.
500 Sistem Hatası
Örnek Yanıt - [JSON]

E-SMM, E-MM Genel Metodlar - Voucher

İstek Parametreleri
Parametre Zorunluluk Açıklama
CreditNoteSendRequest request
İstek detayları aşağıda anlatılmıştır
CreditNoteSendRequest Nesne Detayı
Parametre Zorunluluk Açıklama
NESTransferDocument transferDocument
Gönderilecek olan Credit Note müstahsil makbuzunun detay bilgileri bu alana eklenir.
NESTransferDocument Nesne Detayları
Parametre Açıklama
string UUID
Makbuzun UUID değeri.
string FileName
{Makbuz UUID}.xml şeklinde olmalıdır.
string ZIPFileBase64

Gönderilecek XML formatındaki makbuzun zip halindeki string Base64 değeri bu alana eklenir.

Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
178 DOSYA ZIP FORMATINDA OLMALIDIR 194 E-MM URUNU HESABINIZDA TANIMLI DEGIL!
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
İstek Parametreleri
Parametre Zorunluluk Açıklama
NESVoucher request
NESVoucher nesnesinin detayları için tıklayınız.
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
199 ILGILI SERVISI KULLANMA YETKINIZ YOK! 194 E-MM URUNU HESABINIZDA TANIMLI DEGIL!
180 NESVOUCHER NESNESI CREDIT NOTE UBL'E CEVRILEMEDI!
URL Parametleri
Parametre Zorunluluk Açıklama
string uuid
Makbuzun ETTN (UUID) değeri
Yanıt Parametreleri - VoucherStatus
VoucherStatus Nesnesi
Parametre Açıklama
int StatusCode
Makbuz durumunun kodu bu alanda döner
string StatusDescription
Makbuz durum açıklaması bu alanda döner
string StatusDetailDescription
Makbuz durum açıklamasının detayı bu alanda döner
bool IsCancel
Makbuzun iptal edilip edilmediği bu alanda dönülür. true = 'İptal Edildi' , false = 'İptal Edilmedi'
Yanıt Olarak Dönebilecek Durum Kodları Listesi
Durum Kodu Açıklama
251 MAKBUZ KUYRUKTA HATA ALDI
103 BELGE KUYRUKTA ISLENMEYI BEKLIYOR
252 MAKBUZ KUYRUKTA ISLENIYOR
253 MAKBUZ KUYRUK ISLEMLERI TAMAMLANDI
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
250 MAKBUZ KUYRUKTA BULUNAMADI 254 MAKBUZ KUYRUK DURUMU BILINMIYOR
199 ILGILI SERVISI KULLANMA YETKINIZ YOK!
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
URL Parametleri
Parametre Zorunluluk Açıklama
string uuid
Makbuzun ETTN (UUID) değeri
Yanıt Parametreleri - List <MailSendInfo>
MailSendInfo Nesnesi
Parametre Açıklama Değer
string ReceiverMail
Mailin gönderildiği adres bilgisi bu alanda döner.
bool IsRead
Gönderilen mailin okunup okunmadığı bilgisi bu alanda döner.
true Okundu | 
false Okunmadı
Datetime ReadDate
Mailin okunma tarihi.
bool IsSend
Mailin başarıyla gönderilip gönderilmediği bilgisi bu alanda döner.
true Gönderildi | 
false Gönderilemedi
Datetime SendDate
Mailin gönderilme tarihi.
bool IsStatusCheck
Gönderilen mailing durumunun sorgulanıp sorgulanmadığının bilgisi bu alanda döner.
true Sorgulandı | 
false Henüz Sonuçlanmadı
bool IsDownload
Mailin içerisindeki XML/PDF dosyasının indirilip indirilemediği bilgisi bu alanda döner.
true İndirildi | 
false İndirilmedi
bool IsView
Mailin içerisindeki makbuzun görüntülenip görüntülenmediği bilgisi bu alanda döner.
true Görüntülendi | 
false Görüntülenmedi
string SendErrorDescription
Mail gönderiminde hata olması durumunda hata detayı bu alnda döner.
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
161 MAKBUZ HESABINIZDA BULUNAMADI 199 ILGILI SERVISI KULLANMA YETKINIZ YOK!
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
URL Parametleri
Parametre Zorunluluk Açıklama
string uuid
Makbuzun ETTN (UUID) değeri
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
103 BELGE KUYRUKTA ISLENMEYI BEKLIYOR 250 MAKBUZ KUYRUKTA BULUNAMADI
251 MAKBUZ KUYRUKTA HATA ALDI 252 MAKBUZ KUYRUKTA ISLENIYOR
254 MAKBUZ KUYRUK DURUMU BILINMIYOR 255 MAKBUZ DAHA ONCE IPTAL EDILMIS
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
İstek Parametreleri
Parametre Zorunluluk Açıklama
SendMailRequestByUUID request
İstek detayları aşağıda anlatılmıştır
SendMailRequestByUUID Nesne Detayı
Parametre Zorunluluk Açıklama
string UUID
Mail gönderilmek istenen makbuzun ETTN değeri.
List<string>  ReceiverMailList Makbuzun mail olarak gönderilmesini istediğiniz mail adresi listesi girilir.
Yanıt Parametreleri - SendMailResult
List<SendMailResult> Nesnesi Döner
SendMailResult Nesne Detayları
Parametre Açıklama Değer
bool ResultStatus
Mail gönderim sonucu
true Başarılı | 
false Hatalı
string ReceiverMail
Alıcı mail adresi
string Description
Mail gönderim durum açıklaması. Hata olması durumunda bu alanda detayları döner.
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
Makbuzun ETTN (UUID) değeri
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
199 ILGILI SERVISI KULLANMA YETKINIZ YOK! 161 MAKBUZ HESABINIZDA BULUNAMADI
Örnek İstek - [AJAX]
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
Makbuzun ETTN (UUID) değeri
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
199 ILGILI SERVISI KULLANMA YETKINIZ YOK! 161 MAKBUZ HESABINIZDA BULUNAMADI
Örnek İstek - [AJAX]
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
Makbuzun ETTN (UUID) değeri

Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama Hata Kodu Açıklama
199 ILGILI SERVISI KULLANMA YETKINIZ YOK! 161 MAKBUZ HESABINIZDA BULUNAMADI
Örnek İstek - [AJAX]
Örnek Yanıt - [JSON]
URL Parametreleri
Parametre Zorunluluk Açıklama
string uuid
Makbuzun ETTN değeri
Yanıt Olarak [ErrorStatus] Dönebilecek Hata Listesi
Hata Kodu Açıklama
160 MAKBUZ HESABINIZDA BULUNAMADI
175 MAKBUZ DISKTEN OKUNAMADI
194 E-MM URUNU HESABINIZDA TANIMLI DEGIL!