API

Portal API Endpoint Referansı

Portalın listeleme, önizleme, Excel, e-posta, okunma ve mükellef sorgulama işlemleri.

Kapsam: Bu uçlar VBT Portal kullanıcı deneyimini destekler. Belge oluşturma/güncelleme/iptal/PDF/sorgulama uçları için Entegratör API Endpoint Referansı tek kaynaktır — burada tekrarlanmaz.

Excel ile Toplu Oluşturma

POST/api/Smm/AddOutgoingSmmByExcel

Portal’ın Excel şablonundan okunan e-SMM satırlarını toplu olarak işler.

Request	`ExcelFileRequestModel`; dosya içeriği
Response	`List<OutgoingSmmAddExcelResponseModel>`; her satır için dış referans, belge kimlikleri ve hata sonucu
Portal davranışı	Başarılı ve başarısız satırlar ayrı değerlendirilir; dosyanın tamamı tek sonuç sayılmaz.

Listeleme ve Arama

POST/api/Smm/GetESMMGridList

e-SMM grid görünümü için sayfalı ve sıralı belge listesini getirir.

Request	`SearchUIRequestModel<OutgoingSmmListRequestModel>`
Filtreler	ETTN, alıcı VKN/TCKN/adı, müşteri kayıtları, belge no, dış referans, tarih, belge/rapor/e-posta/iptal/okunma durumları
Response	`SearchResponseModel<OutgoingSmmGridResponseModel>`

POST/api/Smm/GetGlobalSearchESMMList

Portal global aramasında e-SMM kayıtlarını getirir.

Request	`SearchUIRequestModel<GlobalSearchRequestModel>`
Response	Sayfalı `OutgoingSmmGridResponseModel` listesi
Kullanım	Modüller arası tek arama kutusundan belgeye ulaşma

Görüntüleme ve Okunma Durumu

POST/api/DocumentPreview/DownloadOutgoingSmmPdf

Portal belge önizleme bileşeni için tekil PDF indirme yanıtı üretir.

Request	`DocumentPreviewRequestModel`
Response	`DocumentPreviewResponseModel`

POST/api/Smm/OutgoingSmmIsRead

Belgenin Portal’da okundu/okunmadı bilgisini günceller.

Request	`{ Ettn, IsRead }`
Response	`bool`

POST/api/Smm/GetOutgoingSmmLog

Belgenin Portal’da gösterilen işlem geçmişini sayfalı olarak getirir.

Request	`SearchRequestModel<SmmLogRequestModel>`
Response	`SearchResponseModel<SmmLogResponseModel>`
Görülebilen işlemler	Oluşturma, görüntüleme, PDF, e-posta, güncelleme ve iptal hareketleri

Belge Numarası Prefixleri

GET/api/Smm/GetOutgingSmmPrefixList?year={year}

Belirtilen yıl için kullanılabilir e-SMM numara prefixlerini getirir.

Parametre	`year` — belge numarası yılı
Response	`IList<NumberPrefixResponseModel>`
Portal kullanımı	Belge numara serisinin seçimi veya gösterimi

E-posta İşlemleri

POST/api/Smm/AddMailOutgoingSmmPage

Grid sayfasında seçilen belgeleri belirtilen alıcıya e-posta gönderimine alır.

Request	`MailSendRequestModel`
Response	`bool`

POST/api/Smm/AddMailGlobalOutgoingSmm

Global arama seçimindeki belgeleri e-posta gönderimine alır.

Request	`GlobalMailRequestModel`
Response	`bool`

GET/api/Smm/ResetOutgoingOutgoingSmmMailQueue?id={mailId}

Tek bir e-posta kaydını yeniden gönderime hazırlar.

POST/api/Smm/ResetOutgoingOutgoingSmmMailQueueList

UUID listesindeki e-posta kayıtlarını yeniden gönderime hazırlar.

Request	`string[]` UUID listesi
Response	`List<MailStateResponseModel>`; belge bazlı e-posta durumları

Ayrım: E-posta durumu alıcıya teslim sürecini; GİB rapor durumu ise yasal bildirim sürecini gösterir. Portal bu iki durumu ayrı izler.

Mükellef ve Vergi Yardımcıları

Aşağıdaki uçlar Portal formunda mükellef ve vergi bilgisini seçmeye yardımcı olur. Belge oluşturma entegrasyonunun zorunlu çağrı zinciri değildir.

Metot	Endpoint	Parametre	Portal amacı
GET	`/api/GibTaxPayer/GetTaxPayerProfile`	`identifierNumber`	Mükellef profilini getirir.
GET	`/api/GibTaxPayer/GetAllowedVATRates`	`identifierNumber`, opsiyonel `date`	İzin verilen KDV oranlarını listeler.
GET	`/api/GibTaxPayer/GetNACECodes`	`identifierNumber`	NACE kodlarını listeler.
GET	`/api/GibTaxPayer/GetActivities`	`identifierNumber`	Faaliyet kayıtlarını getirir.
GET	`/api/GibTaxPayer/GetAddresses`	`identifierNumber`	Kayıtlı adresleri getirir.
GET	`/api/GibTaxPayer/IsActiveOnDate`	`identifierNumber`, `date`	Belirli tarihte aktiflik kontrolü yapar.
GET	`/api/GibTaxPayer/GetTaxOfficeByCode`	`taxOfficeCode`	Kodla vergi dairesini getirir.
GET	`/api/GibTaxPayer/SearchTaxOfficesByName`	`taxOfficeName`, opsiyonel `take` (varsayılan 50)	Adla vergi dairesi arar.

Portal İşlem Matrisi

Bu tablo yalnızca ekran akışını özetler; her çağrının tam sözleşmesi için Entegratör API Endpoint Referansı sayfasına bakın.

Kullanıcı aksiyonu	Çağrı	Başarı göstergesi	Ekran sonrası
Önizle	`PreviewOutgoingSmm`	PDF byte dizisi ve hatasız sonuç	Taslak PDF açılır.
Kaydet	`AddOutgoingSmm`	`HasError = false`, numara ve UUID	Detay/liste yenilenir.
Güncelle	`UpdateOutgoingSmm`	Hatasız iş sonucu	Yeni PDF ve detay alınır.
PDF al	`GetOutgoingSmmPdf` veya `DownloadOutgoingSmmPdf`	Dosya içeriği	Görüntüleme/indirme başlatılır.
E-posta gönder	`AddMailOutgoingSmmPage` / `AddMailGlobalOutgoingSmm`	`Data = true`	E-posta durumu izlenir.
İptal	`CancelOutgoingSmm`	`Data = true`	Belge ve log durumu yenilenir.