Referans
Teknik Referans
Enum değerleri, hata/mesaj kodları ve validasyon referansları.
Enumlar
e-Adisyon request modeli, belge tipini ve durumunu sabit kod listeleriyle ayrıştırır. Aşağıdaki değerler entity ve enum tanımları üzerinden doğrulanmıştır.
| Alan | Değer | Kullanım Bağlamı |
|---|---|---|
OutgoingBillStatus | BillAndXmlCreated | Belge ve UBL XML oluşturuldu, imzalama bekliyor |
Signed | İmzalandı; GİB gönderimine ve iptale hazır | |
ProfileId | EARSIVBELGE | GİB e-Arşiv belge profili |
BillTypeCode | ADISYON | e-Adisyon belge tipi |
EArchiveStatus | 1: Valid, 2: Cancelled | Belgenin e-Arşiv geçerlilik/iptal durumu |
EArchiveMailStatus | int | E-posta teslim durumu; GİB raporlama durumundan bağımsız |
EArchiveReportStatus | int | Normal GİB raporu sonucu |
EArchiveCancelReportStatus | int | GİB iptal raporu sonucu |
Alıcı Kimlik Sözleşmesi
| Kimlik | Request | GİB raporu |
|---|---|---|
| VKN | 10 haneli VKN ve tüzel kişi unvanı | Yalnız tuzelKisi üretilir. |
| TCKN | 11 haneli TCKN ve gerçek kişi ad/soyad | Yalnız gercekKisi üretilir. |
İki kişi yapısı birlikte üretilemez ve ikisi de boş bırakılamaz. Portal kimlik tipine göre doğru alanları gösterir; doğrudan API entegratörü kimlik ve ad alanlarını birlikte gönderir.
Hata ve Mesaj Kodları
İşlem kodları BLL, ortak servis hataları COM önekiyle döner. GİB raporu alıcı sözleşmesine ait aşağıdaki üç kontrol ise ortak SCHEME kodunu kullanır; entegratör bu ayrımı ErrorMessage ile yapmalıdır.
| Kod | Gözlenebilir mesaj (birebir) |
|---|---|
SCHEME | "AccountingCustomerParty.Party için SchemeID niteliği değeri 'VKN' veya 'TCKN' olan bir tane ID elemanı bulunmalıdır." |
SCHEME | "GİB raporunda alıcı adı için PartyName kaynağından en az 2 karakterlik değer üretilmelidir." |
SCHEME | "GİB raporunda alıcı adı için Person.FirstName/Person.FamilyName kaynağından en az 2 karakterlik değer üretilmelidir." |
| Kod | Anlamı |
|---|---|
BLL0001 | Request modeli boş |
BLL0005 | ProfileId hatalı |
BLL0006 | BillTypeCode hatalı |
BLL0009 | Belge no sıra/format kontrolü başarısız |
BLL0010 | UBL XML dönüşüm hatası |
BLL0011 | Kayıt ekleme hatası |
BLL0012 | Belge oluşturuldu |
BLL0013 | Belge bulunamadı |
BLL0014 | Güncelleme parametre hatası |
BLL0015 | Güncelleme hatası |
BLL0016 | Belge güncellendi |
BLL0017 | Durum güncelleme hatası |
BLL0019 | PDF oluşturuldu |
BLL0020 | ExternalId zorunlu |
BLL0021 | UBL ayrıştırma hatası |
BLL0022 | UBL'den oluşturuldu |
BLL0023 | Arandı |
BLL0024 | İmzasız belge iptal edilemez |
BLL0025 | Belge zaten iptal edilmiş |
BLL0026 | Belge iptal edildi |
BLL0027 | UBL'den güncellendi |
BLL0028 | ExternalId zaten mevcut |
BLL0029 | Belge görüntülendi |
BLL0030 | Zip/arşiv kaydı bulunamadı |
BLL0031 | E-posta gönderildi |
BLL0033 | UBL XML zip üretimi |
BLL0034 | Zip güncelleme hatası |
BLL0035 | UUId zaten mevcut |
COM0008 | İmza firmasıyla ilgili ortak hata |
COM0014 | Firma bulunamadı |
COM0016 | Belge no sağlayıcısı çözümlenemedi |
COM0017 | UUId geçerli GUID değil |
Not: Numaralandırma seyrektir (BLL0002-0004, 0007-0008, 0018, 0032 kullanılmaz); entegratör karşılaştırmayı tam kod dizesi üzerinden yapmalıdır.
Validasyon Referansları
| Referans | Kapsam | Not |
|---|---|---|
ErrorModel.ErrorCode | Response hata listesi | İşlem mesaj kodu bu alanda taşınır |
HasError / Errors[] | Oluşturma/güncelleme/iptal response modeli | İşlem sonucu response gövdesinde birlikte değerlendirilir |
BillPdfFileBytes | PDF ve önizleme yanıtı | Base64 çözülüp application/pdf olarak kullanılır; kalıcı PDF endpoint'inde C# property adı FileBytes, tel adı BillPdfFileBytes'tır |
| Senaryo referansları | Kullanım senaryoları karar tabloları | Rehberdeki test matrisini işaretler; response mesaj kodu olarak kullanılmaz |
Kaynak Bölümler
| 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 |
| UBL XML eşlemesi | Request → UBL XML Mapping | JSON alanının XML çıktısı doğrulanırken |
| Mevzuat ve teknik çerçeve | GİB Referansı | Resmi kaynak gerektiğinde |