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.
Add/Update/Cancel/GetPdf/GetSingle/GetList her zaman Entegratör API Endpoint Referansı sayfasında kalır, buraya taşınmaz.Listeleme & Arama
UI grid ekranı için sayfalanmış e-Arşiv Fatura listesi döner.
| Request | SearchUIRequestModel<EArchiveInvoiceListRequestModel> |
| Response | ResponseModel<SearchResponseModel<EArchiveInvoiceGridResponseModel>> |
Global arama ekranı için e-Arşiv Fatura listesi döner.
| Request | SearchUIRequestModel<GlobalSearchRequestModel> |
| Response | ResponseModel<SearchResponseModel<EArchiveInvoiceGridResponseModel>> |
e-Arşiv Fatura özet listesi döner.
| Request | SearchRequestModel<EArchiveGetRequestModel> |
| Response | ResponseModel<SearchResponseModel<EArchiveSummaryResponseModel>> |
Görüntüleme & Durum Raporu
e-Arşiv Fatura durum raporunu döner.
| Request | OutgoingEArchiveStatusReportRequestModel |
| Response | ResponseModel<OutgoingEArchiveStatusAllReportResponseModel> |
E-posta İşlemleri
Seçili e-Arşiv Fatura(lar) için e-posta gönderim kuyruğuna ekler.
| Request | MailSendRequestModel |
| Response | ResponseModel<bool> |
Bir faturanın e-posta kuyruğu durumunu sıfırlar (yeniden gönderim için).
| Request | id — int |
| Response | ResponseModel<bool> |
Toplu/global e-posta gönderim kuyruğuna ekler.
| Request | GlobalMailRequestModel |
| Response | ResponseModel<bool> |
Belge Numarası Prefixleri
Belirtilen yıl için kullanılabilir fatura numarası prefixlerini getirir.
| Request | NumberPrefixRequestModel |
| Response | ResponseModel<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.
VKN/TCKN'nin GİB e-Fatura mükellef listesinde kayıtlı olup olmadığını sorgular.
| Request | GibUserGetRequestModel |
| Response | ResponseModel<UserResponseModel> |
VKN/TCKN'nin GİB e-İrsaliye mükellef listesinde kayıtlı olup olmadığını sorgular.
| Request | GibUserGetRequestModel |
| Response | ResponseModel<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.
Portal ekranından itiraz bildirimini kayda geçirir.
| Request | DocumentObjectionRequestModel |
| Response | ResponseModel<bool> |
GİB Portal'da tamamlanan itiraz sürecini Successful durumuna taşır.
| Request | DocumentObjectionRequestModel |
| Response | ResponseModel<bool> |
GİB Portal'da tamamlanan iptal sürecini Successful durumuna taşır.
| Request | EArchiveCancelRequestModel |
| Response | ResponseModel<bool> |