Referans
Teknik Referans
Enum değerleri, hata/mesaj kodları ve validasyon referansları.
Enumlar
e-SMM request ve response modelleri, teslim şekli, belge durumu ve para birimini sabit kod listeleriyle ayrıştırır. Aşağıdaki değerler API modeli ve servis akışları üzerinden doğrulanmıştır.
| Alan | Değer | Kullanım Bağlamı |
|---|---|---|
GonderimSekli | Kagit | Alıcıya kâğıt çıktı teslimi |
Elektronik | Elektronik teslim; e-posta işlevleri kullanılabilir | |
OutgoingSmmStatus | PdfCreated | Belge ve PDF çıktısı oluşturuldu |
Signed | Belge imzalı duruma ulaştı; GİB gönderimine hazır | |
DocumentCurrencyCode | TRY, USD, EUR vb. | ISO 4217 para birimi kodu |
OrderByType | ASC / DESC | Liste sıralama yönü |
EArchiveStatus | GibDocumentStatus (Valid, Cancelled vb.) | Belgenin e-Arşiv geçerlilik/iptal durumu; e-posta ve rapor durumundan bağımsızdır |
EArchiveMailStatus | EmailStatus | Alıcı e-postası gönderim durumu; GİB raporlama sonucunu göstermez |
EArchiveReportStatus | GibReportDocumentStatus (WaitingForReport vb.) | Normal GİB raporu sonucu; tekil PDF durumundan bağımsızdır |
EArchiveCancelReportStatus | GibReportDocumentStatus | GİB iptal raporu sonucu; normal rapor durumundan ayrı izlenir |
Hata ve Mesaj Kodları
Alan doğrulamaları SMM önekli kodlarla döner. Entegratör kodu ve mesajı birlikte kaydetmeli; kullanıcıya alan bağlamını koruyarak göstermelidir.
| Kod | Doğrulama alanı | İstemci davranışı |
|---|---|---|
SMM001 | Request gövdesi boş | İstek modeli oluşturulmadan tekrar gönderilmez. |
SMM002 | Düzenleme tarihi geçersiz | IssueDate düzeltilir. |
SMM003–SMM007 | Alıcı, VKN/TCKN, unvan veya ad-soyad | Kimlik tipine uygun taraf alanları tamamlanır. |
SMM008–SMM010 | Oran, kur, dış referans veya taraf bütünlüğü | Dönen mesajdaki alan/koşul düzeltilir; otomatik kör tekrar yapılmaz. |
SMM011–SMM018 | Alıcı kişi/kurum ve kimlik ayrıntıları | Kimlik uzunluğu, sayısallık ve kişi/kurum alanları kontrol edilir. |
SMM019–SMM022 | Alıcı adresi | Adres, ülke, ilçe/semt ve şehir alanları tamamlanır. |
UNHANDLED_EXCEPTION | Beklenmeyen işlem hatası | Dış referansla sonuç sorgulanır; korelasyon bilgisiyle destek kaydı açılır. |
İşlem Hata Kodları
Yukarıdaki alan doğrulama kodlarından ayrı olarak, işlem seviyesinde dönen SMM önekli ikinci bir kod ailesi vardır. Bu kodlar belge bulma, oluşturma, imzalama, iptal ve e-posta gibi operasyonel adımlarda döner.
| Kod | Anlamı |
|---|---|
SMM0001 | Belge bulunamadı. |
SMM0002 | Belge başarıyla oluşturuldu. |
SMM0003 | Belge başarıyla güncellendi. |
SMM0004 | Belge başarıyla iptal edildi. |
SMM0005 | Belge zaten iptal edilmiş. |
SMM0006 | PDF başarıyla oluşturuldu. |
SMM0007 | İmzalama hatası. |
SMM0008 | Belge zip/arşiv kaydı bulunamadı. |
SMM0009 | E-posta başarıyla gönderildi. |
SMM00010 | Belge durumu güncellenemedi. |
SMM00011 | Belge güncelleme hatası. |
SMM00012 | Belge görüntülendi (log kaydı). |
SMM00013 | Excel dosyası bulunamadı. |
SMM0001–SMM0009 ve SMM00010–SMM00013); entegratör karşılaştırmayı sayısal değer üzerinden değil, dönen tam kod dizesi üzerinden yapmalıdır.Validasyon Referansları
Validasyon yanıtlarında modüle özgü mesaj kodları dışında ortak yanıt zarfı alanları da görülür. Bu bölüm, response içindeki alanların nasıl ayrıştırılacağını teknik olarak sınırlar.
| Referans | Kapsam | Not |
|---|---|---|
RefreshToken | Standart yanıt zarfı | Boş değilse güvenli biçimde saklanır ve sonraki çağrıda kullanılır |
Data.HasError / Data.Errors[] | Oluşturma, güncelleme ve önizleme response modeli | İşlem sonucu ve hata detay listesi response gövdesinde birlikte değerlendirilir |
ErrorModel.ErrorCode | Response hata listesi | İşlem mesaj kodu bu alanda taşınır |
Data.SmmPdfFileBytes | PDF ve önizleme yanıtı | Base64 çözülüp application/pdf olarak kullanılır |
UNHANDLED_EXCEPTION | Servis hata yakalama bloğu | Beklenmeyen exception durumunda genel hata kodu olarak döner |
| Senaryo referansları | Kullanım senaryoları karar tabloları | Rehberdeki test matrisini işaretler; response mesaj kodu olarak kullanılmaz |
Kaynak Bölümler
Teknik referans, ana akıştaki karar noktalarının yerine geçmez; ilgili bölümdeki business bağlamıyla birlikte okunmalıdır. Aşağıdaki bağlantılar kodların ve enumların hangi akışta değerlendirileceğini gösterir.
| Konu | Kaynak | Ne Zaman Bakılır? |
|---|---|---|
| Alan ve endpoint ayrıntıları | Entegratör API Endpoint Referansı | Request modeli hazırlanırken |
| Portal işlemleri | Portal API Endpoint Referansı | Portal akışları incelenirken |
| Tam JSON örnekleri | Request Örnekleri | Senaryo uyarlanırken |
| İş alanı / GİB raporu eşlemesi | Request → Belge → GİB Raporu Mapping | Alanın GİB raporundaki karşılığı doğrulanırken |
| Mevzuat ve teknik çerçeve | GİB Referansı | Vergi/kesinti kuralları veya resmi kaynak gerektiğinde |