e-Arşiv Fatura

API

Portal API Endpoint Referansı

Portal UI'ın e-Arşiv Fatura grid, e-posta ve iptal/itiraz tamamlama akışlarında kullandığı endpoint sözleşmeleri.

Kapsam: Bu sayfadaki endpointler VBT Portal'ın kendi kullanımı içindir. Add/Update/Cancel/GetPdf/GetSingle/GetList her zaman Entegratör API Endpoint Referansı sayfasında kalır, buraya taşınmaz.

Listeleme & Arama

POST/api/Invoice/GetEArchiveInvoiceGridList

UI grid ekranı için sayfalanmış e-Arşiv Fatura listesi döner.

RequestSearchUIRequestModel<EArchiveInvoiceListRequestModel>
ResponseResponseModel<SearchResponseModel<EArchiveInvoiceGridResponseModel>>
POST/api/Invoice/GetGlobalSearchEArchiveInvoiceList

Global arama ekranı için e-Arşiv Fatura listesi döner.

RequestSearchUIRequestModel<GlobalSearchRequestModel>
ResponseResponseModel<SearchResponseModel<EArchiveInvoiceGridResponseModel>>
POST/api/Invoice/GetEArchiveList

e-Arşiv Fatura özet listesi döner.

RequestSearchRequestModel<EArchiveGetRequestModel>
ResponseResponseModel<SearchResponseModel<EArchiveSummaryResponseModel>>

Görüntüleme & Durum Raporu

POST/api/Invoice/GetEArchiveStatusReport

e-Arşiv Fatura durum raporunu döner.

RequestOutgoingEArchiveStatusReportRequestModel
ResponseResponseModel<OutgoingEArchiveStatusAllReportResponseModel>

E-posta İşlemleri

POST/api/Invoice/AddMailOutgoingEArchiveInvoicePage

Seçili e-Arşiv Fatura(lar) için e-posta gönderim kuyruğuna ekler.

RequestMailSendRequestModel
ResponseResponseModel<bool>
GET/api/Invoice/ResetEArchiveInvoiceMailQueue

Bir faturanın e-posta kuyruğu durumunu sıfırlar (yeniden gönderim için).

Requestid — int
ResponseResponseModel<bool>
POST/api/Invoice/AddMailGlobalOutgoingEArchive

Toplu/global e-posta gönderim kuyruğuna ekler.

RequestGlobalMailRequestModel
ResponseResponseModel<bool>

Belge Numarası Prefixleri

POST/api/NumberManagement/GetInvoiceNumberPrefixList

Belirtilen yıl için kullanılabilir fatura numarası prefixlerini getirir.

RequestNumberPrefixRequestModel
ResponseResponseModel<IList<NumberPrefixResponseModel>>

Mükellef Sorguları

Bu uçlar, Portal'ın alıcı uygunluk kontrolünü (Kullanım Senaryoları — Karar Ağacı) ekranda göstermek için kullandığı yardımcı endpointlerdir.

POST/api/GibUser/GetGibUser

VKN/TCKN'nin GİB e-Fatura mükellef listesinde kayıtlı olup olmadığını sorgular.

RequestGibUserGetRequestModel
ResponseResponseModel<UserResponseModel>
POST/api/GibUser/GetGibDespatchAdviceUser

VKN/TCKN'nin GİB e-İrsaliye mükellef listesinde kayıtlı olup olmadığını sorgular.

RequestGibUserGetRequestModel
ResponseResponseModel<UserResponseModel>

Portal İşlem Matrisi (İptal/İtiraz)

Portal, iptal ve itiraz sürecinin tamamlanma adımını kendi endpointleriyle yürütür; başlatma ise entegratör tarafında Entegratör API Endpoint Referansı — İptal ve İtiraz üzerinden de yapılabilir. Durum modeli için İptal ve İtiraz Durum Takibi sayfasına bakın.

POST/api/Invoice/ObjectOutgoingEArchiveInvoice

Portal ekranından itiraz bildirimini kayda geçirir.

RequestDocumentObjectionRequestModel
ResponseResponseModel<bool>
POST/api/Invoice/CompleteOutgoingEArchiveInvoiceObjectionProcess

GİB Portal'da tamamlanan itiraz sürecini Successful durumuna taşır.

RequestDocumentObjectionRequestModel
ResponseResponseModel<bool>
POST/api/Invoice/CompleteOutgoingEArchiveInvoiceCancellationProcess

GİB Portal'da tamamlanan iptal sürecini Successful durumuna taşır.

RequestEArchiveCancelRequestModel
ResponseResponseModel<bool>

Oluşturma Ekranında Özel Fatura Tipleri

Portal kullanıcıları GİB rapor nesnesi hazırlamaz. Profil, fatura tipi ve teknoloji destek ürün sınıfları backend parametrelerinden yüklenir; seçilen tipe ait alanlar standart fatura formunda doldurulur.

TipPortalda girilen bilgiKayıt öncesi kontrol
SARJDönem başlangıç/bitiş tarih-saatleri, alıcı plakası ve bir veya daha fazla ESURaporIDGeçerli dönem, tek plaka, GUID kimliği ve 2000–2099 tarihli rapor referansı
SARJANLIKDönem, plaka ve kalem ESU seri numarasıe-Arşiv Faturada tam bir kalem ve bu kalemde tam bir seri numarası
YTBTEVKIFAT/YTBTEVKIFATIADE6 haneli YTB numarası ve tarihi; iade tipinde kaynak belge referansıTek YTB referansı; iade tipinde DocumentTypeCode=IADE ve 16 karakterli belge numarası
TEKNOLOJIDESTEKTCKN'li alıcı ve her kalemde TELEFON/TABLET_PC seçimiProfil, alıcı kimliği ve bütün kalem sınıfları birlikte doğrulanır.

Temel parametre grupları eksikse Kaydet, Güncelle ve Önizle engellenir. Yalnız teknoloji destek ürün seçenekleri eksikse sadece TEKNOLOJIDESTEK işlemi engellenir. Parametreleri tekrar yükle işlemi mevcut belge ve kalemleri korur.