API

Listeleme ve Çıktı API Referansı

Listeleme, özet, önizleme, PDF ve ZIP çıktısı endpointleri.

Listeleme endpointleri operasyon ekranları ve ERP mutabakatı için özet veya satır verisi döndürür. Önizleme endpointleri ise aynı kaydın insan tarafından okunabilir görünümünü ya da indirilebilir dosyasını sağlar. Liste sonucu, GİB onaylı dosyanın arşivlendiğini tek başına kanıtlamaz.

Listeleme ve Özet

Metot	Endpoint	Kullanım
POST	`/api/LedgerList/GetEntityPage`	Tarih filtresi ve sayfalama ile dönemleri listeler.
POST	`/api/LedgerList/GetEntityDetailPage`	Seçilen kayıt için fiş ve muhasebe satırı ayrıntılarını listeler.
POST	`/api/LedgerSummary/GetEntityPage`	Özet kayıtları sayfalı döndürür.
POST	`/api/FirmLedger/GetEntityPage`	Firma bazlı defter dosyalarını listeler.

Liste İstekleri

GetEntityPage çağrısı PageQuery<LedgerListRequestModel> gövdesi alır. CurrentPageNumber ve PageSize değerleri çağrılar boyunca tutarlı kullanılmalı; toplam kayıt ve sayfa bilgisi response içindeki TotalRows ve TotalPages alanlarından izlenmelidir.

{
  "Filter": {
    "BeginDate": "2026-01-01T00:00:00",
    "EndDate": "2026-12-31T00:00:00"
  },
  "CurrentPageNumber": 0,
  "PageSize": 50,
  "SortExpression": "PeriodStart",
  "SortDirection": "desc"
}

Bir dönemin satırlarını almak için liste cevabındaki gerçek Uuid kullanılır:

{
  "Uuid": "22222222-2222-2222-2222-222222222222"
}

Toplu Arşiv İndirme

POST /api/FirmLedger/GetFirmsLedgersZip, seçilen firmaların tarih aralığındaki yevmiye, kebir, mükellef/GİB beratları ve defter raporlarını firma-yıl-ay klasörleri altında tek ZIP arşivinde döndürür.

{
  "BeginDate": "2026-01-01T00:00:00",
  "EndDate": "2026-12-31T00:00:00",
  "ListSecurityFirmUuid": [
    "11111111-1111-1111-1111-111111111111"
  ]
}

Response ServiceResponse<string> biçimindedir. Data alanı Base64 ZIP içeriğidir; byte dizisine çevrilip .zip uzantısıyla kaydedilir. Boş aralık veya yanlış firma UUID'si için boş arşivi başarı kanıtı kabul etmeyin; Messages[] ile indirilen ZIP içeriğini birlikte doğrulayın.

Önizleme ve Çıktılar

Tüm önizleme endpointleri uuid query parametresi alır ve ServiceResponse<string> döndürür. HTML endpointlerinin Data alanı işaretleme metnidir; PDF ve ZIP endpointlerinin Data alanı Base64 dosya içeriğidir.

Çıktı	HTML	PDF	ZIP
Yevmiye	`GetYevmiyeHtml`	`GetYevmiyePdf`	`GetYevmiyeZipDownload`
Kebir	`GetKebirHtml`	`GetKebirPdf`	`GetKebirZipDownload`
Mükellef beratları	`GetYevmiyeBeratHtml`, `GetKebirBeratHtml`	Karşılık gelen `*Pdf` uçları	Karşılık gelen `*ZipDownload` uçları
GİB onaylı beratlar	`GetGibYevmiyeBeratHtml`, `GetGibKebirBeratHtml`	Karşılık gelen `*Pdf` uçları	Karşılık gelen `*ZipDownload` uçları
Defter raporu	`GetDefterRaporHtml`	`GetDefterRaporPdf`	`GetDefterRaporZipDownload`

Çağrı biçimi GET /api/LedgerPreview/{işlem}?uuid={uuid} şeklindedir. Base64 değer istemcide byte dizisine çevrilerek ilgili PDF veya ZIP dosya uzantısıyla kaydedilir.

İhtiyaç	Tercih edilen çıktı	Kullanım notu
Onay öncesi gözle kontrol	HTML	`Data` doğrudan güvenli bir önizleme alanında gösterilir; dosya değildir.
Kullanıcıya okunabilir belge sunma	PDF	Base64 çözülerek `.pdf` kaydedilir; yasal XML/XBRL'nin yerine geçmez.
İmzalı veya GİB onaylı teknik dosyayı saklama	ZIP	Base64 çözülerek `.zip` kaydedilir; dosya türü değiştirilmez.

UUID seçimi: Özet kaydının Uuid değeri ile liste detayındaki belge/parça UUID'leri aynı amaçla kullanılmayabilir. Endpointin döndürdüğü kayıt türüne ait UUID'yi kullanın; bulunamayan çıktı için başka bir dönemin UUID'sini denemeyin.