API Test

Müşteri kodu, kullanıcı adı ve şifre ile kimlik doğrulaması yapar. Her deneme loglanır; art arda hatalı denemelerde aşamalı bekletme (en fazla 30 sn) uygulanır.

Kullanıcının aktif girişlerini (cihaz/bearer kayıtlarını) en fazla 100 kayıt olacak şekilde listeler. Bearer değerleri maskeli gösterilir; her kaydın "logout" alanı, logoutFrom servisine parametre olarak gönderilebilecek md5(bearer) değeridir. Giriş gerektirir (bearer ya da basic auth).

Kullanıcının giriş (bearer) kayıtlarını siler: tüm cihazlardan, kullanılan cihazdan ya da listLogins servisinin verdiği logout (md5) değerine karşılık gelen cihazdan. Giriş gerektirir (bearer ya da basic auth).

Oturumun (bearer kaydının) çalışma firmasını seçer. Kullanıcı yalnızca yetkili olduğu firmaları seçebilir; seçim bearer kaydının secilen_firma alanına yazılır ve sonraki isteklerde geçerli olur. Giriş gerektirir (bearer ya da basic auth).

Giriş yapan kullanıcının bilgilerini ve yetkili olduğu etiketleri (WORKLABEL), firmaları (mükellefler) ve müşterileri listeler. Giriş gerektirir (bearer ya da basic auth).

Kullanıcının yetkili olduğu etiketlere (WORKLABEL) ait belgeleri listeler. Giriş gerektirir (bearer ya da basic auth). Belge tipi zorunludur; gelen_efatura, giden_efatura gibi özel servisler bu servisin belge tipi sabitlenmiş halleridir. Belge tarihi ya da gönderim tarihi aralıklarından en az biri zorunludur ve bir aralık en fazla 40 gün olabilir; 16 haneli belge_no ya da ettn ile tam eşleşme araması yapılıyorsa tarih aralığı istenmez.

Kullanıcının yetkili olduğu etiketlere gelen e-faturaları listeler. Giriş gerektirir (bearer ya da basic auth). Filtreler ve kurallar fatura_listesi servisiyle aynıdır: belge tarihi ya da gönderim tarihi aralıklarından en az biri zorunludur (aralık en fazla 40 gün), 16 haneli belge_no ya da ettn ile tam eşleşme aranıyorsa tarih aralığı istenmez.

Kullanıcının yetkili olduğu etiketlerden gönderilen e-faturaları listeler. Giriş gerektirir (bearer ya da basic auth). Filtreler ve kurallar fatura_listesi servisiyle aynıdır: belge tarihi ya da gönderim tarihi aralıklarından en az biri zorunludur (aralık en fazla 40 gün), 16 haneli belge_no ya da ettn ile tam eşleşme aranıyorsa tarih aralığı istenmez.

Kullanıcının yetkili olduğu etiketlere gelen e-irsaliyeleri listeler. Giriş gerektirir (bearer ya da basic auth). Filtreler ve kurallar fatura_listesi servisiyle aynıdır: belge tarihi ya da gönderim tarihi aralıklarından en az biri zorunludur (aralık en fazla 40 gün), 16 haneli belge_no ya da ettn ile tam eşleşme aranıyorsa tarih aralığı istenmez.

Kullanıcının yetkili olduğu etiketlerden gönderilen e-irsaliyeleri listeler. Giriş gerektirir (bearer ya da basic auth). Filtreler ve kurallar fatura_listesi servisiyle aynıdır: belge tarihi ya da gönderim tarihi aralıklarından en az biri zorunludur (aralık en fazla 40 gün), 16 haneli belge_no ya da ettn ile tam eşleşme aranıyorsa tarih aralığı istenmez.

Kullanıcının yetkili olduğu etiketlerden düzenlenen e-arşiv faturalarını listeler. E-müstahsil makbuzları bu listeye girmez, giden_mustahsil servisinden alınır. Giriş gerektirir (bearer ya da basic auth). Filtreler ve kurallar fatura_listesi servisiyle aynıdır: belge tarihi ya da gönderim tarihi aralıklarından en az biri zorunludur (aralık en fazla 40 gün), 16 haneli belge_no ya da ettn ile tam eşleşme aranıyorsa tarih aralığı istenmez.

Kullanıcının yetkili olduğu etiketlerden düzenlenen e-müstahsil makbuzlarını listeler. Giriş gerektirir (bearer ya da basic auth). Filtreler ve kurallar fatura_listesi servisiyle aynıdır: belge tarihi ya da gönderim tarihi aralıklarından en az biri zorunludur (aralık en fazla 40 gün), 16 haneli belge_no ya da ettn ile tam eşleşme aranıyorsa tarih aralığı istenmez.

Kullanıcının yetkili olduğu firmalara ait arşivlenmiş dosya kayıtlarını sayfalı listeler. Giriş gerektirir (bearer ya da basic auth). Her kaydın altındaki dosyaların adı, boyutu ve özeti de döner; dosya içeriği için arsivlenen_dosya_indir servisi kullanılır.

Arşivlenmiş tek bir dosyanın içeriğini base64 olarak döndürür. Giriş gerektirir (bearer ya da basic auth). Dosya, kullanıcının yetkili olduğu bir firmanın arşivinde ve verilen arşiv kaydına bağlı olmalıdır. 64 MB üzerindeki dosyalarda 413 döner; dosya boyutu arsivlenen_dosyalar servisinde önceden görülebilir.

Kullanıcının e-defter arşivinde gezebileceği firmaları (mükellefleri) listeler. Giriş gerektirir (bearer ya da basic auth). Bu listedeki kapsam diğer servislerden farklıdır: erişim OINT_USER.roleArchive yetkisi, kullanıcının müşterisine bağlı mükellefler ve OINT_USER.taxNrArchive VKN kısıtından türer — etiket (WORKLABEL) yetkisi aranmaz. Klasör ve dosya servisleri yalnızca buradaki firma referanslarını kabul eder.

Bir firmanın e-defter arşiv klasörlerini (dönemlerini) listeler; her klasör için dosya sayısı ve kontör toplamı döner. Klasör adı YYYYAA biçimindedir, dönem yıl/ay olarak da ayrıştırılır. Giriş gerektirir (bearer ya da basic auth). Firma, edefter_arsiv_firmalari listesinde olmalıdır; sorgu yalnızca doğrulanmış firmanın taxHolder_reference değeriyle çalışır.

Bir firmanın e-defter arşiv dosyalarını listeler (berat, kebir, defter raporu). Klasör, dosya adı ve GUID ile daraltılabilir. Giriş gerektirir (bearer ya da basic auth). Firma, edefter_arsiv_firmalari listesinde olmalıdır; her sorgu doğrulanmış firmanın taxHolder_reference değeriyle kısıtlanır, dolayısıyla GUID araması da başka bir firmanın dosyasına erişemez. Dosya içeriği bu servisle indirilemez.

Firma geneli ya da kullanıcı bazlı e-fatura ayarlarını döndürür (eski sistemdeki Ayarlar ekranının karşılığı). Önce yerel kayıt okunur; yoksa eski sistemdeki ayarlara, o da yoksa varsayılan değerlere düşülür (yanıttaki kaynak alanı: yerel / eski_sistem / varsayilan). Firma geneli okumada seri_efatura ve seri_earsiv boşsa mükellef kaydındaki seriler kullanılır. Giriş gerektirir (bearer ya da basic auth).

Firma geneli ya da kullanıcı bazlı e-fatura ayarlarını kaydeder (eski sistemdeki Ayarlar ekranının karşılığı). Yalnızca istekte gönderilen alanlar güncellenir; boş gönderilen alan temizlenir. Kayıt yerel veritabanına yazılır — eski sistemdeki ayarlar değişmez. Firma serileri (seri_efatura / seri_earsiv) de yerel ayarlarda tutulur; mükellef kaydındaki seriler salt okunur olduğundan güncellenmez. Giriş gerektirir (bearer ya da basic auth).

Firmanın XSLT tasarımlarını listeler: yeni sisteme yüklenen yerel tasarımlar (kaynak: yerel) ve eski sistemde kayıtlı tasarımlar (kaynak: eski, salt okunur) birlikte döner. Ayarlardaki xslt_* alanlarında yalnızca yerel tasarımlar seçilebilir; eski bir tasarım xslt_duzenle servisinin kopyala işlemiyle yerele alınabilir. id verilirse tek tasarım, base64 içeriğiyle döner. Giriş gerektirir (bearer ya da basic auth).

Firmanın yerel XSLT tasarımlarını yönetir: ekle, guncelle, sil ve eski sistemdeki bir tasarımı yerele almak için kopyala. Eski sistem kayıtları salt okunurdur, yalnızca yerel tasarımlar düzenlenebilir. Bir firmada en fazla 20 yerel tasarım tutulur; içerik en fazla 1 MB olabilir ve geçerli bir XSLT (xsl:stylesheet / xsl:transform) olmalıdır. Silinen tasarıma referans veren ayar alanları varsayılan tasarıma (0) çekilir. Giriş gerektirir (bearer ya da basic auth).

Firmanın bağlı olduğu müşteri hesabının güncel kontör durumunu döndürür (eski sistemdeki Finans → Kontör ekranının karşılığı). Kalan kontör OINT_ACCTOTAL toplamlarından (yüklenen - harcanan), kullanım kırılımı OINT_ACCMONTHLYUSAGE tablosundan hesaplanır; aylık kullanım ve kontörün tahmini kaç gün yeteceği de yanıttadır (son 12 ayın kırılımı yalnızca son_12_ay_goster=true verilirse döner). Sonuç müşteri bazında cache'te tutulur; cache_ttl parametresi (sn, varsayılan 300, en az 30, en fazla 86400) verinin kabul edilen en fazla yaşını belirler; veri bundan eskiyse yeniden hesaplanır (hesaplama zamanı yanıttaki hesaplama_zamani alanındadır). Okuma kontör sunucusundan yapılır (kontör tabloları canlı ana veritabanında tutulmaz). Giriş gerektirir (bearer ya da basic auth).

Servisin ayakta olduğunu ve kimlik doğrulamasının çalıştığını test eder. Giriş gerektirir (bearer ya da basic auth).

Sistem sağlık durumunu döndürür (ana sayfadaki verinin aynısı: Redis, veritabanları, replika gecikmeleri ve web servisleri). Sonuç 60 sn önbelleklidir. Giriş gerektirir (bearer ya da basic auth).