Bu döküman, GMP entegrasyon protokolleri dahilindeki Yeni Nesil Hugin ÖKC'ler ile bilgisayar bağlantılı sistemler arasında iletişimi, Hugin arayüzleri ile sağlamak ve bu yapıların oluşturulmasına kılavuzluk etmek amacı ile hazırlanmıştır. Dökümanın ve dökümanda adı geçen ürünlerin tüm hakları HUGİN YAZILIM TEKNOLOJİLERİ A.Ş. firmasına aittir.

Entegrasyon yapılacak kütüphanlere buradan erişebilirsiniz. C++, C#, Java, Delphi entegrasyon kütüphanleri link altında mevcuttur. Kablolu entegrasyon LAN(TCP/IP) ve RS232 protokolleri üzerinden gerçekleşmektedir. Genel itibari ile akış aşağıdaki şekilde gerçekleşmektedir.

sequenceDiagram

UYGULAMA ->> KÜTÜPHANE: (1)Fiş başlat!
KÜTÜPHANE ->>YNÖKC: (2)Fiş Başlat!
YNÖKC->>KÜTÜPHANE: (3)Fiş Başlatıldı!
KÜTÜPHANE->>UYGULAMA: (4)Fiş Başlatıldı!

Tüm kütüphanelerde kullanılan arayüzler aynıdır. Methodların aldığı argümanlar ve dönüş değerleri aynı yapıdadır. Bu dönüş değerleri boolean ya da string yapıdadır.

Method dönüş değerleri string formatta, araya '|' karakteri konularak birleştirilip tek bir string olarak dönmektedir.

<String1>|<String2>|<String3>|................

Bu değerlerden, ilk iki string değeri Hata Kodu ve ÖKC Durum Kodu dur.

<ErrorCode>|<StatusValue>|<Parameter1>|<Parameter2>|................

Note: Hata kodu 0 (sıfır) ise işlem başarılıdır.

Kütüphanelerde yer alan methodları işlevlerine göre 5 ana başlık altında toplayabiliriz.

• Programlama Fonksiyonları
• Satış Fonksiyonları
• Rapor Fonksiyonları
• Yardımcı Fonksiyonlar
• Kütüphane Özelikleri

YNÖKC üzerinde satış işlemlerine başlayabilmek adına, öncesinde bazı zorunlu ya da mükellefe göre değişen ayarları ayarlamanız gerekir. Bunun için öncelikle programlama yetkisi bulunan kasiyer ile giriş yapılmalıdır. Aksi halde hata kodu 91, "Kasiyer Yetkisi Yetersiz" hatası alınacaktır. Ayarlara göre sağlamanız gereken durumlar olabilir. YNÖKC sizi bu durumlarda uyaracaktır. Örneğin; Üzerinde satış bulunan departman(kısım) bilgisini değiştirmeden önce sizi Z raporu almaya zorlayacaktır. Öncelikli programlanması gereken ayarları Logo bilgileri, KDV bilgileri, Departman(kısım) bilgileri, PLU bilgileri(eğer kısım satışı yapılmayacak ise), kredi bilgileri, döviz bilgileri, ana/alt kategori bilgileri, kasiyer bilgileri, grafik logo bilgileri, fiş sonu bilgileri şeklinde sıralayabiliriz.
Programlama sırasında sık karşılaşılabilecek hatalar aşağıdaki şekildedir.

YNÖKC üzerindeki logo satırlarını set eder. Logo alanı 6 satırdan oluşmaktadır.

NOT: 6. yani son satır sadece nümerik (0-9) karakterlerden oluşmalıdır. Vergi kimlik numarası gibi.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<Durumkodu>|<LogoSatırı>

YNÖKC üzerinde kayıtlı bulunan logo satırlarını getirir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<Durumkodu>|<LogoSatırı>

YNÖKC üzerinde KDV oranlarını set eder. maksimum 8 adet KDV değeri tanımlanabilir.

NOT: Kullanılmayan KDV indekslerini geçersiz olarak tanımlamak için vatRate değeri -1 olarak gönderilebilir. Ayrıca iki farklı indekse aynı KDV değeri tanımlanamaz. Bir değer sadece bir KDV indeksine tanımlanabilir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<KDVDeğeri>

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

YNÖKC üzerinde tanımlı KDV değerlerini getirir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<KDVDeğeri>

YNÖKC üzerindeki departman değerleri set edilir. Bazı kesimlerde "kısım" olarak da tanımlanır. YNÖKC'ler satışları direkt olarak KDV değerlerinden satmanıza izin vermez. KDV değerleri departmanlara bağlanır ya da tanımlanır diyebiliriz. Her KDV değeri bir departmana tanımlanmak zorunda değildir fakat her departmanın tanımlı bir KDV değeri olmalıdır. Ayrıca birden fazla departman aynı KDV değerine de tanımlanabilir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<DepartmanAdı>|<KDVGrupID>|<Fiyat>|<Tartılabilirlik>

Olası Hatalar:

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

Bir önceki method ile aynı özelliklere sahiptir. Sadece bir parametre fazla almaktadır. limit parametresi departman üzerinden yapılabilecek maksimum satış tutarını belirlemek için kullanılır. Örnek olarak, departmana ait ürün birim fiyatı 50, siz de departman limitini 500 olarak set ettiniz ise o üründen maksimum 10 adet satabilirsiniz.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<DepartmanAdı>|<KDVGrupID>|<Fiyat>|<Tartılabilirlik>|<Limit>

Olası Hatalar:

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

YNÖKC üzerinde tanımlı departman bilgilerin getirilmesini sağlar.

Parametreler:

Dönüş Değerleri :

<HataKodu>|<DurumKodu>|<DepartmanAdı>|<KDVGrupID>|<Fiyat>|<Tartılabilirlik>|<Limit>

Olası Hatalar:

YNÖKC üzerinde kredi bilgilerini kaydetmek için kullanılır. Kredili ödemeler genelde YNÖKC'lere bağlı olmayan EFT-POS cihazlarından alınan ödemelerden sonra ve hediye, ticket gibi ödemelerde kullanılır.

NOT: FT202 ve FP300 modellerinde maksmum 8 adet, Vx675 modelinde ise maksimum 4 adet kredi bilgisi tanımlanabilir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<KrediAdı>

Olası Hatalar:

YNÖKC üzerinde kayıtlı kredi bilgilerini getirmek için kullanılır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<KrediAdı>

YNÖKC üzerinde tanımlı döviz bilgilerini kaydetmek için kullanılır.

NOT: Maksimum 4 adet döviz bilgisi tanımlanabilir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<DövizAdı>|<DövizKuru>

Olası Hatalar:

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

YNÖKC üzerinde tanımlı döviz bilgilerini getirmek için kullanılır.

Parametreler:

Dönüş Değerleri :

<HataKodu>|<DurumKodu>|<DövizAdı>|<DövizKuru>

YNÖKC üzerinde kasiyer bilgilerini kaydetmek için kullanılır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<KasiyerAdı>

Errors:

YNÖKC üzerinde tanımlı kasiyer bilgisini getirir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<KasiyerAdı>

YNÖKC üzerine ürün bilgisi kaydetmek için kullanılır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<DepartmanAdı>|<DepartmanID>|<Fiyat>|<Tartılabilirlik>|<Barkod>|<AltKategori>

Olası Hatalar:

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

YNÖKC üzerinde ilgili numaraya tanımli ürün bilgisini getirmek için kullanılır.

Parametreler :

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<DepartmanAdı>|<DepartmanID>|<Fiyat>|<Tartılabilirlik>|<Barkod>|<AltKategoriID>

Olası Hatalar:

YNÖKC üzerine bitmap grafik logo yüklemek için kullanılır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

Olası Hatalar:

YNÖKC üzerinde bazı ayarların set edilme işlemleri bu method ile yapılır.

Parametreler:

• Kağıt Kesici için; 0 değeri kapalı, 1 değeri açık
• EFT ile Ödeme için; 0 değeri kapalı, 1 değeri açık
• Fiş Limiti değeri için decimal(double) değer verilir. Ör: 900,00 veya 850,45 gibi
• Grafik Logo için; 0 değeri kapalı, 1 değeri açık
• Fiş barkodu için; 0 değeri kapalı, 1 değeri açık
• EFT yönetimi için; 0 ise YNÖKC tarafında yapılır, 1 ise EFT-POS tarafında yapılır.

Dönüş Değerleri :

<HataKodu>|<DurumKodu>|<ProgramlananDeğer>

Olası Hatalar:

YNÖKC üzerinde tanımlı ayarları getirir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<ProgramlananDeger>

YNÖKC üzerinde tanımlı fiş sonu notlarını verilen indeks değerine göre getirir.

NOT: Maksimum 6 satır fiş sonu notu tanımlanabilir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<SatırIcerigi>    

YNÖKC üzerinde fiş sonu notu tanımlamak için kullanılır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<SatırIcerigi>

YNÖKC üzerinde fiş belgesini başlatır

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<FişNo>

Olası Hatalar:

Bilgi fişlerini başlatmak için kullanılır.

Kullanıcılar aşağıdaki sebeplerden ötürü bilgi fişi kullanmaya ihtiyaç duyabilirler;

1. Eğer fiş toplamı fiş limitini aşarsa, belge tipi fatura, e-fatura ya da e-arşiv olmalıdır..Türkiye'deki güncel fiş limiti 1000,00 TL'dir.
2. Eğer müşteri fatura isterse ve müşteri e-fatura mükellefi ise kasiyer e-fatura düzenlemek zorundadır.
3. Müşteriler fatura yerine E-arşiv isteyebilirler.
4. Eğer müşteri yemek kartı ile ödeme yapmak isterse, yemek bilgi fişi başlatılmak zorundadır. Yemek fişinde sadece yemek grubu için belirlenen standart KDV değeri yer alır. Bu ödeme yemek restaurantlarında geçerlidir.
5. Otoparklar otopark bilgi fişi başlatmalıdır.
6. Eğer müşteri alışverişten önce ödeme yapmak isterse Avans bilgi fişi başlatılmalıdır.

Belge Tipleri:

1. Fatura: Uygulama yazılımı tarafından hazırlanır. YNÖKC üzerinden bilgi fişi basılır. Fatura yazıcısından fatura yazdırılır.
2. E-Fatura : Elektronik faturadır. Mükellef firmalar için düzenlenir.
3. E-Arşiv : Elektronik faturalardır. E-Fatura mükellefi olmayanlar için düzenlenir.
4. Yemek Fişi : Yemek kartı ile ödeme almak için düzenlenir.
5. Otopark Fişi : Otoparklar kullanır.
6. Avans Fişi : Müşteri avans ödemesi yapar

NOT: TCKN 11 krakterden VKN ise 10 karakterden oluşur. Uymayan durumlarda parametre hatası alınır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo> 

Olası Hatalar:

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

Fatura, e-fatura, e-arşiv belgelerini başlatmak için kullanılır.

Parametreler:

Belge Tipleri:

1. Fatura: Satış uygulaması hazırlar
2. E-Invoce : Elektronik fatura, e-fatura mükellefleri için düzenlenir
3. E-Archive : Elektronik arşiv, e-fatura mükellefi olmayanlar için düzenlenir.

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo> 

Olası Hatalar:

Avans bilgi fişi başlatır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo> 

Olası Hatalar:

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

Fatura tahsilat bilgi fişi yazdırır.

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo> 

Olası Hatalar:

Yemek bilgi fişini başlatır.

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo> 

Olası Hatalar:

Otopark bilgi fişi başlatır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo> 

Olası Hatalar:

Satış ürününü yazdırır.

NOT: "deptId", "amount", "name", "weighable" parametreleri eğer PLU satışı yapacaksanız gereksizdir. (Eğer PLU daha önceden kaydedilmiş ise). Bu parametreler için "-1" değeri gönderebilirsiniz. (name->null). Bu sayede kütüphane YNÖKC cihazına bu parametreleri göndermeyecektir. Ayrıca bu fonksiyon ile, YNÖKC programlanabilir modda ise (programlama yetkisine sahip kasiyer girişi mevcutsa) satış ile birlikte PLU kaydı da yapabilirsiniz.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<Aratoplam>

Olası Hatalar:

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

Ürün satışını yazdırır. Satışı departman üzerinden yapar. PLU kullanmaz. PLU satışına göre daha hızlı ve efektif bir çözüm sunar.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<Aratoplam>

Olası Hatalar:

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

Satışı yapılan son ürüne indirim/arttırım uygular, indirim/arttırım satırını yazdırır. Son işlem ürün satışı ya da aratoplam olmalıdır. Son işlem ürün satışı ise sadece o ürüne uygulanır, aratoplam ise belge toplamına uygulanır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<Aratoplam>

Olası Hatalar:

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

Son yapılan işlemi geri alır (satış, indirim, arttırım..)

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<Aratoplam>

Olası Hatalar:

Belge üzerinde PLU satışı yapılmış bir ürünü verilen miktar kadar iptal eder.

NOT: Ürün birden fazla kalemde yer alıyor ise, son kalemden iptal işlemine başlar.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<Aratoplam>

Olası Hatalar:

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

Yapılan departman satışını iptal eder.

Parametreler:

Dönüş Değeri:

<HataKodu>|<DurumKodu>|<Aratoplam>

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

YNÖKC üzerinde o an açık olan dökümanın aratoplamını yazdırmanızı ya da sadece değerini çekmenizi sağlar.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<Aratoplam>|<ÖdemeToplamı>

Olası Hatalar:

Ödeme bilgilerini yazdırır. Eğer parçalı ödeme yapıyorsanız, ödeme tutarları toplamı aratoplama eşit olana kadar bekler. Eşit olunca tüm ödemeleri birlikte yazdırır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<Aratoplam>|<ÖdenenTutar>

Olası Hatalar:

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

Kart bilgisini çekmek için kullanılır. EFT ödemesinden önce kullanılabilir.

Parametreler:

Dönüş Değeri:

<HataKodu>|DurumKodu>|<Hgnccid>|<Hgnccname>|<CardHolderName>|<CardNumber>|<DiscountEnable>

Olası Hatalar:

Bağlı olan EFT-POS cihazından ödeme almak için kullanılır. EFT-POS cihazı YNÖKC ile daha önceden eşlenmiş durumda olmalıdır. Ödeme toplamı aratoplama eşit olduğunda EFT ödemesi yazdırılır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|DurumKodu>|<Aratoplam>|<ProvisionID>|<Tutar>|<OnaylananTaksitSayısı>|<AcquirerId>|<BIN>|<IssuerId>|<AltİşlemTipi>|<BatchNo(GrupNo)>|<StanNo(SıraNo)>|<TotalPaidAmount>

ALT İŞLEM TİPLERİ:
{
SATIS = 1, "Sale"
YBELGE = 10, "New document"
TAKSITLI_SATIS = 04, "Installment sales"
VADE_FARKLI_SATIS = 16, "Maturity different sales "
E_IADE = 20, "return document"
KISMI_IADE = 22,"partial return document"
KONTOR_SATIS = 13, "credits sale"
PUAN_SORGU = 14, "point query"
KK_BORC_ODEME = 05, "credit card debt payment"
PREPAID_NAKIT_YUKLEME = 29, "pre-paid cash load"
PREPAID_KARTLI_YUKLEME = 30, "pre-paid loading with payment card"
CASHBACK = 12, "cash back"
}

Olası Hatalar:

EFT-POS tarafından alınmış ödemeyi POS üzerinden iptal eder. Bu method, fiş kapatıldıktan sonra ilgili bilgileri verilen EFT ödemesinin tüm tutarını iptal eder.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<Tutar>|<AcquierID>|<IssuerID>|<KartNumarası>

Olası Hatalar:

EFT-POS cihazı üzerinde iade işlemi başlatır. Bu method fiş kapandıktan sonra, miktarsal olarak EFT iade alınmasını sağlar.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<Tutar>|<AcquierID>|<IssuerID>|<KartNumarası>

Olası Hatalar:

EFT slip kopyası almanızı sağlar. Slip Z no - Fiş no ikilisi ya da batch(grup) no - stan(sıra) no ikilisi kullanıalrak çağıralabilir. Acquier ID her iki çağırım için de zorunludur.

Not: Kullanılmayan ikili için 0 (sıfır) değeri gönderebilirsiniz.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

Olası Hatalar:

EFT-POS üzerinde kayıtlı banka listesini getirir. Banka listesinde yer alan banka bilgileri acquier ID ve banka ismi bilgisinden oluşur.

String BankInfo = Banka Acquier ID (4) + Banka İsmi

Dönüş Değerleri:

<HataKodu>|<DurumKodu> |<BankInfo_1>|<BankInfo_2>|<BankInfo_3>|......|<BankInfo_N> 

Olası Hatalar:

İçinde bulunan satış durumunun bilgilerini getirir.

Dönüş Değerleri:

<HataKodu>|<DurumKodu> |<BelgeNo>|<ZNo>|<BelgeTipi>|<Tarih>|<Zaman>|<Aratoplam>|Ödemeler(<ÖdemeTipi>|<Ödemeİndeksi>|<Tutar>|<Not>)|KDV Bloğu(<KdvOranı>|<Tutar>|<KDVTutarı>)

BELGE TİPLERİ: 0. Z Raporu

1. Fiş
2. İptal Fişi
3. Bilgi Raporu, X Raporu, Departman Satış raporu gibi..
4. Mali Rapor
5. EKÜ periyodik raporu
6. Elektrik kesinitisi sonrası iptal fişi
7. Mali olmayan belge
8. not in use,
9. İptal mali olmayan belge,
10. Fatura
11. E-Fatura, E-Arşiv
12. E-Fatura, E-Arşiv iptali

Olası Hatalar:

Ödeme iptal edilmesini sağlar. Dikkat edilmesi gereken nokta ödemelerin yazdırılmamış olması gerektiğidir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

Olası Hatalar:

Belgeyi kapatır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>

Olası Hatalar:

Başlatılmış olan belgeyi iptal eder.

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>

Olası Hatalar:

Ödemelerden sonra belgenin footer kısmında barkod yazdırır. Barkod formatı code128 olmalıdır. Bir belge dahilinde sadece bir kez barkod yazdırılabilir. Bu method sadece FP300 modellerinde desteklenir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

Olası Hatalar:

Not(yorum) satırı yazdırır. ÖKC, SELLING(satış) ya da OPEN_SALE (ödeme sonrası belge kapatılmadan önce) durumlarında olmalıdır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

Olası Hatalar:

JSON formatta hazırlanan Hugin Satış Belgesini yazdırır. PLU satışı yapar. Bu yüzden ürünler satılırken aynı zamanda kaydedilmesi için 9 kasiyer ile giriş yapılmış olmalıdır.

Parametreler:

	
	enum PaymentType
	{
		CASH,
		CREDIT,
		CHECK,
		F_CURRENCY
	}
	enum AdjustmentType : sbyte
	{
		FEE,
		PERCENT_FEE,
		DISCOUNT,
		PERCENT_DISCOUNT
	}
	
	class Adjustment
    {
        public AdjustmentType Type = AdjustmentType.Discount;
        public decimal Amount = 0m;
        public int percentage = 0;
        public string NoteLine1;
        public string NoteLine2;
    }
    class PaymentInfo
    {
        public PaymentType Type = 0;
        public int Index = 0;
        public decimal PaidTotal = 0.00m;
    }
    class JSONItem
    {
        public int Id;
        public decimal Quantity;
        public decimal Price;
        public string Name;
        public string Barcode;
        public int DeptId;
        public int Status;
        public Adjustment Adj = null;
        public string NoteLine1;
        public string NoteLine2;
    }
	class EndOfReceipt
	{
		public bool CloseReceiptFlag = true;
		public bool BarcodeFlag = false;
		public string Barcode;	
	} 
	
    class JSONDocument
    {
        public List<JSONItem> FiscalItems = new List<JSONItem>();
        public List<Adjustment> Adjustments = new List<Adjustment>();
        public List<PaymentInfo> Payments = new List<PaymentInfo>();
        public List<String> FooterNotes = new List<string>();
    }

NOT : JSONItem ve Adjustment içindeki NoteLine1 ve NoteLine2 alanları sadece PrintJSONDocumentDeptOnly vePrintSalesDocument methodlarında kullanılır.

Örnek JSON;

   {
	"FiscalItems":[{
	"Id":13,
	"Quantity":1.0,
	"Price":11.0,
	"Name":"LIPTON ÇAY",
	"DeptId":1,
	"Status":0,
	"Adj":null,
	"NoteLine1":"DEMLIK POŞET"
	},{
	"Id":7,
	"Quantity":25.0,
	"Price":0.70,
	"Name":"YUMURTA",
	"DeptId":3,
	"Status":0,
	"Adj":{"Type":3,"Amount":-0.88,"percentage":5},
	"NoteLine1":"DOĞAL KÖY YUMURTASI"
	},{
	"Id":9,
	"Quantity":2.0,
	"Price":1.2,
	"Name":"ÜLKER ÇİZİ",
	"DeptId":3,"Status":0,
	"Adj":null
	},{
	"Id":3,
	"Quantity":1.35,
	"Price":11.95,
	"Name":"BEYAZ PEYNİR",
	"DeptId":3,
	"Status":1,
	"Adj":null
	},{
	"Id":5,
	"Quantity":1.0,
	"Price":8.95,
	"Name":"YOĞURT",
	"DeptId":3,
	"Status":0,
	"Adj":{"Type":1,"Amount":0.45,"percentage":5,"NoteLine1":"SÜT HAFTASI ÖZEL İNDİRİMİ"}
	},{
	"Id":2,
	"Quantity":2.5,
	"Price":4.49,
	"Name":"BULGUR",
	"DeptId":2,
	"Status":1,
	"Adj":null
	}],
"Adjustments":[{
	"Type":3,
	"Amount":-10.02,
	"percentage":15,
	"NoteLine1":"ÖZEL MÜŞTERİ İNDİRİMİ"
	}],
"Payments":[{
	"Type":0,
	"Index":0,
	"PaidTotal":20.0,
	"SequenceNo":0
	},{
	"Type":1,
	"Index":0,
	"PaidTotal":36.76,
	"SequenceNo":1
	}],
"FooterNotes":[
	"ÜRÜN İNDİRİMİ  :    *0,43",
	"ARATOP İNDİRİMİ:   *10,02",
	"TOPLAM İNDİRİM :   *10,45",
	"   **** İYİ GÜNLER ****",
	" www.hugin.com.tr",
	" 0212 212 2121",
	" MERSİS NO: 121244112344123124"
	],
"EndOfReceiptInfo":{"CloseReceiptFlag":false,"BarcodeFlag":false,"Barcode":null}
}

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

Hugin JSON satış belgesini yazdırır. JSON içerik de yer alan ürünler PLU değil departman bilgileri ile satılırlar. Bu yüzden yukarıda yer alan JSON PLU satışına istinaden daha efektif ve hızlı sonuç verir.

JSONItem ve Adjustment sınıflarında yer alan NoteLine1 ve NoteLine2 alanları bu methodda kullanılabilir. FP300 modeli için maksimum 48, FT202 ve Vx675 modelleri için 36 karakter olabilir.

NOT: Bu method çağırılmadan önce belgenin başlatılmış olması gereklidir. ÖKC satış(SELLING) durumunda olmalıdır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

Hugin JSON satış belgesini departman satışı ile yazdırır. PrintJSONDocumentDeptOnly methodundan farkı tek paket olarak ÖKC ye gönderim yapar bu yüzden daha hızlıdır.

NOT: Veriler tek paket halinde gönderildiği için, satış içeriği tamamlanmış halde olmalıdır. Yani ödeme bilgileri ile birlikte tamamlanmış bir belge olmalıdır. Uygulama tarafında oluşturulan JSON belgeniz yukarıda bahsedilen gibi tamamlanmış ise bu method ile gönderiniz, farklı bir durumda ise PrintJSONDocumentDeptOnly methodunu çağırınız.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<ZNo>|<FişNo>|<Tarih>|<Saat>|<BelgeTipi>|
Ödeme bloğu (Her ödeme için tekrarlar)
<ÖdemeTipi>|<İndeks>|<Tutar>|<Not>

Cari hesap tahsilat fişini başlatır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

Fiş sonunda seçilen barkod tipine göre barkod değerini yazdırır.

NOT: Bu method sadece Vx675 model ÖKC'lerde kullanılabilir.

BARKOD TİPLERİ: 1- EAN 2- QRN 3- C039 4- C128

Parametreler:

Dönüş Değerleri

<HataKodu>|<DurumKodu>

E-Arşiv ve E-Fatura belgelerini FP300 modeli ÖKC üzerinde yazdırır. Diğer modeller desteklememektedir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

EFT-POS yönetimi satış uygulaması tarafından yapıldığı durumlarda(EFT-POS ÖKC'ye bağlı olmadığı durumda), alınan EFT ödeme içeriğini fiş içerisinde yazdırmak için bu komut kullanılır. Müşteri kopyası, İşyeri Nüshası ve Hata slipleri basılır. Bu işlem sadece FP300 modeli ÖKC üzerinde yazdırır. Diğer modeller desteklememektedir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

Olası Hatalar:

Dahili yazıcıda fatura başlatır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>|<ZNo>|<KDVOranı>|<KDVTutarı>

İade belgesi (Gider Pusulası) başlatmak için kullanılır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>|<ZNo>|<KDVOranı>|<KDVTutarı>

Serbest Meslek Makbuzu başlatmak için kullanılır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>|<ZNo>|<KDVOranı>|<KDVTutarı>

YNÖKC üzerindeki dökümanın aratoplam değerini stopaj miktarı kullanarak çekmenizi sağlar.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>|<ZNo>|<KDVOranı>|<KDVTutarı>

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

Olası Hatalar:

Uygulama, ÖKC'yi rapor yazdırmak için tetikleyebilir. İlgili methodlar rapoarları kağıda yazdırabildiği gibi, yazdırmadan da içerik olarak alabilirler. copy parametresi bu amaç için kullanılır.

copy parametresi aşağıdaki değerleri alır;

Rapor fonksiyonlarında alınabilecek genel hatalar;

X raporunu yazdırır. X raporu, Z raporu ile aynı içeriği içerir fakat mali değildir. X raporu, hiç bir mali değeri sıfırlamadan, Z rapor içeriğini görmek için kullanılır.

Parametreler:

Return value:

<HataKodu>|<DurumKodu>|<BelgeNo>|<ZNo>

Verilen PLU değerleri arasında X raporu yazdırır.

NOT: Verilen PLU aralığı 1000'den küçük olmalıdır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<DocNo>|<ZNo>

Olası Hatalar:

Sistem bilgi raporunu yazdırır. Bu rapor içinde, ÖKC sicil bilgisi, yazılım versiyon bilgileri, network bilgileri, KDV bilgileri, Departman bilgileri ve program ayarları yer alır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<DocNo>|<Raporİçeriği>

Fiş özetleri raporunu yazdırır. Bu rapor fişler şeklinde gruplanmış olarak toplam satış bilgilerini içerir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<DocNo>|<Raporİçeriği>

Olası Hatalar:

Z Raporunu yazdırır. Z raporu bir çeşit gün sonu raporudur. Satılan ürünlerin departman ve toplam tutar bilgilerini içerir. Gün toplam değerlerini sıfırlar.

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>|<ZNo>

Olası Hatalar:

İki tarih arasında periyodik raporu yazdırır. Bu iki tarih arasındaki ödeme bilgilerini içerir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>|<ZNo>

Olası Hatalar:

Tek Z ya da birden fazla Z içeriğinin yer aldığı periyodik raporu yazdırır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>|<ZNo>

Olası Hatalar:

Günlük periyodik rapor yazdırır. Bu rapor sadece mali modda alınabilir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>|<ZNo>

İki tarih arası periyodik raporu yazdırır. Bu rapor sadece mali modda alınabilir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>|<ZNo>

İki Z arası periyodik rapor yazdırır. Bu rapor sadece mali modda alınabilir.

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>|<ZNo>

Genel EKÜ kullanımı ile ilgili bilgileri içeren rapor yazdırır. EKÜ no, ilk Z no, son Z no, ilk fiş no, son fiş no, toplam EKÜ satırı, kullanılan EKÜ satırı gibi..

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<EKÜNo>|<İlkZno>|<İlkBelgeNo>|<SonZno>|<SonBelgeNo>|<ToplamEKÜSatırı>|<KullanılanEKÜSatırı>

EFT-POS cihazı üzerinde gün sonu raporunu yazdırır.

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

Z Raporunu yazdırır. Z raporu bir çeşit gün sonu raporudur. Satılan ürünlerin departman ve toplam tutar bilgilerini içerir. Gün toplam değerlerini sıfırlar.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>|<ZNo>

Olası Hatalar:

Parametreler :

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<EKÜNo>|<İlkZno>|<İlkBelgeNo>|<SonZno>|<SonBelgeNo>|<ToplamEKÜSatırı>|<KullanılanEKÜSatırı>

Son yazıdırılan raporun içeriğini getirmek için kullanılır.

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>|<Zno>|<Raporİçeriği>

İki tarih arasında diğer belgelerin (fatura,gider pusulası, serbest meslek makbuzu) ekü kopyasını almak için kullanılır.

Parametreler :

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>|<ZNo>

Diğer belgelerin (fatura,gider pusulası, serbest meslek makbuzu) ekü kopyasını almak için kullanılır.

Parametreler :

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<BelgeNo>|<ZNo>

ÖKC yöetiminde sıklıkla kullanılan, satış, programlama ve rapor harici fonksiyonlardır.

O anki ÖKC durumu hakkında bilgi verir. Satış uygulaması bu method ile ÖKC durumunu ya da ÖKC'yi bloklayan hata sebebini öğrenebilir. Hiçbir mali işlevi yoktur, sadece durum bilgisi öğrenilir.

NOT: Her ne kadar mali bir işlevi olmasa da, gerek olmayan durumlar dışında sürekli kasa durumunu sorgulatmak, satış uygulaması tarafında da işlem akışının yavaşlamasına sebep olacaktır.

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|<Tarih>|<Zaman>|NULL|NULL|NULL|NULL|NULL

ÖKC üzerinde kayıtlı olan bilgiler ile kasiyer girişini sağlar.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|NULL|NULL|<KasiyerAdı>|NULL|NULL|NULL|<YetkiSeviyesi>

Default Kasiyer Bilgilerir:

Olası Hatalar:

Kasiyer şifresini kontrol etmek amacı ile kullanılır. Maksimum hatalı giriş sayısı günlük 5 kezdir. Bu sayının aşılması durumunda kasiyer 24 saat boyunca kilitlenir.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|NULL|NULL|<KasiyerID>|NULL|NULL| <HatalıGirişSayısı>|<YetkiSeviyesi>|

Olası Hatalar:

ÖKC' ye nakit girdi yapar.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|NULL|NULL|NULL|<Tutar>|NULL|NULL|NULL|

Olası Hatalar:

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

ÖKC nakit çıktı yapar.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>|NULL|NULL|NULL|<Tutar>|NULL|NULL|NULL|

Olası Hatalar:

Bir önceki metod ile aynı özelliklere sahiptir, tek farkı decimal olan parametre yerine int değer alan parametre yer almaktadır.

ÖKC ile eşleşmeyi başlatır. Connected durumda olan connection nesnesi System.IO.Ports.SerialPort ya da System.Net.Sockets.Socket sınıflarından birine ait olmalıdır. DeviceInfo sınıfına Hugin.Common kütüphanesi üzerinden ulaşılabilinir.

Parametreler:

Dönüş Değerleri: true (eğer işlem başarılı ise) false(eğer işlem başarısız ise)

ÖKC çekmece bilgilerini çeker.

Dönüş Değerleri:

 <HataKodu>|<DurumKodu>|<ToplamBelgeSayısı>|<ToplamTutar>|<MaliFişSayısı>| <MaliFişTutarları>|<İptalBelgeSayısı>|<İptalTutarı>|<ToplamİndirimTutarı>|<NakitGirişID>|<NakitGirişSayısı>|<NakitGirişMiktarı>|<NakitÇıkışID>|<NakitÇıkışSayısı>|<NakitÇıkışMiktarı>|<ÖdemeTipi>|<Index>|<Tutar>

Tekrarlanabilir Ödemeler Bloğu:

<ÖdemeTipi>|<Index>|<Tutar>

ÖKC üzerinde yazılan son belge ile ilgili bilgileri getirir.

Parametreler:

Dönüş Değerleri:

 <HataKodu>|<DurumKodu>|<BelgeNo>|<ZNo>|<EKÜNo>|<BelgeTipi>| <BelgeTarihi>| <BelgeZamanı>

Interruptable raporların durdurulmasını sağlar.(Rapor alınırken)

Buna ek olarak hata sonrası kasiyer onayı gibi bir görevi de vardır. Örneğin 24 saat geçmesi itibariyle ÖKC nin 24 Saat Z raporu uyarısı vermesinden sonra Z raporunu aldırmak için bu komut gönderilir.

ÖKC üzerinde kağıt rulo bitmesi sonrası yeni rulo takıldıktan sonra da ÖKC işleme devam etmek için sizden bu komutu bekler.

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

Çekmece açma komutu. ÖKC üzerinde entegre çekmece var ise bu komut ile açılır.

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

ÖKC üzerinde mali değeri olmayan fiş başlatır. Free-text raporlar ve belgeler için kullanılabilinir.

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

Olası Hatalar:

Mali olmayan fişe, satır yazdırır.

Parametreler:

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

Mali olmayan fişi kapatır.

Dönüş Değerleri:

<HataKodu>|<DurumKodu>

Kütüphane üzerinden son log bilgisini getirir.

Dönüş Değerleri:

<Komut>|<İşlemSıraNo>|<ÖKCDurum>|<HataKodu>|<HataMesajı>

ÖKC versiyon bilgisini getirir.

Dönüş Değerleri:

	<VersiyonBilgisi>

ÖKC tarafından verilen son cevabı görüntüler.

Dönüş Değerleri:

	<HataKodu>|<DurumKodu>|Tarih|Zaman|NULL|NULL|NULL|NULL|NULL|

Gün içersinde yapılan işlemlerin belge bazında kdv dağılımı toplalarını ve ödeme toplamlarını almak için kullanılır.

Dönüş Değerleri: İşlem Başarılı ise Json formatında bilgiler gelir. Başarılı değilse hata kodu gelir.

{
"summaries": [
	{
		"DocumentType": 13,
		"ValidCount": 3,
		"CancelledCount": 1,
		"ValidAmount": 117.0,
		"CancelledAmount": 64.0,
		"VatTotal": 0.16,
		"VatGroupSales": [
			{
				"VatRate": 0,
				"VatAmount": 0.0,
				"SaleAmount": 101.0
			},
			{
				"VatRate": 1,
				"VatAmount": 0.16,
				"SaleAmount": 16.0
			}
		],
		"Cash": 117.0,
		"Credit": 0.0,
		"Other": 0.0
	},
	{
		"DocumentType": 1,
		"ValidCount": 1,
		"CancelledCount": 0,
		"ValidAmount": 30.0,
		"CancelledAmount": 0.0,
		"VatTotal": 0.56,
		"VatGroupSales": [
			{
				"VatRate": 1,
				"VatAmount": 0.26,
				"SaleAmount": 26.0
			},
			{
				"VatRate": 8,
				"VatAmount": 0.3,
				"SaleAmount": 4.0
			}
		],
		"Cash": 30.0,
		"Credit": 0.0,
		"Other": 0.0
	},
	{
		"DocumentType": 2,
		"ValidCount": 1,
		"CancelledCount": 2,
		"ValidAmount": 40.0,
		"CancelledAmount": 165.0,
		"VatTotal": 6.1,
		"VatGroupSales": [
			{
				"VatRate": 18,
				"VatAmount": 6.1,
				"SaleAmount": 40.0
			}
		],
		"Cash": 40.0,
		"Credit": 0.0,
		"Other": 0.0
	},
	{
		"DocumentType": 3,
		"ValidCount": 1,
		"CancelledCount": 3,
		"ValidAmount": 45.0,
		"CancelledAmount": 45.0,
		"VatTotal": 0.45,
		"VatGroupSales": [
			{
				"VatRate": 1,
				"VatAmount": 0.45,
				"SaleAmount": 45.0
			}
		],
		"Cash": 45.0,
		"Credit": 0.0,
		"Other": 0.0
	},
	{
		"DocumentType": 4,
		"ValidCount": 1,
		"CancelledCount": 1,
		"ValidAmount": 50.0,
		"CancelledAmount": 15.0,
		"VatTotal": 0.0,
		"VatGroupSales": [
			{
				"VatRate": 0,
				"VatAmount": 0.0,
				"SaleAmount": 50.0
			}
		],
		"Cash": 50.0,
		"Credit": 0.0,
		"Other": 0.0
	}
],
"CummulativeTotal": 43173.53,
"CummulativeVat": 3631.13
}

Hatalı Cevap Formatı:

<Komut>|<İşlemSıraNo>|<ÖKCDurum>|<HataKodu>|<HataMesajı>

O anki static CompactPrinter instance değerini döner. Eğer bu özelik null ise, yeni instance oluşturulmalıdır.

Bu özelik ÖKC sicil numarasının kütüphaneye set edilmesi amacı ile kullanılır. Eşeleme sırasında Connect methodu çağrılmadan önce ÖKC sicil numarası bu method ile set edilmelidir. Ayrıca get ulaşımı da bulunduğu için set edilen sicil numarası öğrenilebilinir.

Eğer eşleme yapılan cihazın modeli Vx675 ise bu özellik true döner, diğer modellerde false döner. Yanlızca get ulaşımı bulunmaktadır.

Bu özellik ile kütüphane loglama dizinini belirleyebilir, set edebilirsiniz.

NOT: Java kütüphanesinde bu özeliğe karşılık gelen özelik -> "SetDebugFolder(string path)"

Loglama levelini belirlemenizde kullanılır. 6 log leveli bulunmaktadır.

	public enum LogLevel
    {
        FATAL = 1, 
        ERROR = 2,
        WARN = 3,
        INFO = 4,
        DEBUG = 5,
        HIDE_BUG = 6
    }

NOT: Java kütüphanesinde bu özeliğe karşılık gelen özelik -> "SetDebugLevel(int level)"

Kütüphane versiyon bilgisini getirir.

Seri port ve TCP/IP haberleşmeleri için kütüphane tarafından desteklenen buffer boyutu bilgisini getirir.

ÖDEME TİPLERİ:

İNDİRİM/ARTTIRIM TİPLERİ:

JSONDocument

JSONItem

Adjustment

PaymentInfo

EndOfReceipt

NOT: JSONItem ve Adjustment veri tiplerinde yer alan NoteLine1 ve NoteLine2 alanları sadece PrintJSONDocumentDeptOnly ve PrintSalesDocument methodlarında kullanılır.

HUGIN JSON PLU Satış Belgesi Nesnesi (C#):

	
	enum PaymentType
	{
		CASH,
		CREDIT,
		CHECK,
		F_CURRENCY
	}
	enum AdjustmentType
	{
		FEE,
		PERCENT_FEE,
		DISCOUNT,
		PERCENT_DISCOUNT
	}
	
	class Adjustment
    {
        public AdjustmentType Type = AdjustmentType.Discount;
        public decimal Amount = 0m;
        public int percentage = 0;
        public string NoteLine1;
        public string NoteLine2;
    }
    class PaymentInfo
    {
        public PaymentType Type = 0;
        public int Index = 0;
        public decimal PaidTotal = 0.00m;
        public bool viaByEFT = false;
    }
    class JSONItem
    {
        public int Id;
        public decimal Quantity;
        public decimal Price;
        public string Name;
        public string Barcode;
        public int DeptId;
        public int Status;
        public Adjustment Adj = null;
        public string NoteLine1;
        public string NoteLine2;
    }
	class EndOfReceipt
	{
		public bool CloseReceiptFlag = true;
		public bool BarcodeFlag = false;
		public string Barcode;	
	} 
	
    class JSONDocument
    {
        public List<JSONItem> FiscalItems = new List<JSONItem>();
        public List<Adjustment> Adjustments = new List<Adjustment>();
        public List<PaymentInfo> Payments = new List<PaymentInfo>();
        public List<String> FooterNotes = new List<string>();
        public EndOfReceipt EndOfReceiptInfo = new EndOfReceipt();
    }

JSON ÖRNEK:

   {
	"FiscalItems":[{
	"Id":13,
	"Quantity":1.0,
	"Price":11.0,
	"Name":"LIPTON ÇAY",
	"DeptId":1,
	"Status":0,
	"Adj":null,
	"NoteLine1":"DEMLIK POŞET"
	},{
	"Id":7,
	"Quantity":25.0,
	"Price":0.70,
	"Name":"YUMURTA",
	"DeptId":3,
	"Status":0,
	"Adj":{"Type":3,"Amount":-0.88,"percentage":5},
	"NoteLine1":"DOĞAL KÖY YUMURTASI"
	},{
	"Id":9,
	"Quantity":2.0,
	"Price":1.2,
	"Name":"ÜLKER ÇİZİ",
	"DeptId":3,"Status":0,
	"Adj":null
	},{
	"Id":3,
	"Quantity":1.35,
	"Price":11.95,
	"Name":"BEYAZ PEYNİR",
	"DeptId":3,
	"Status":1,
	"Adj":null
	},{
	"Id":5,
	"Quantity":1.0,
	"Price":8.95,
	"Name":"YOĞURT",
	"DeptId":3,
	"Status":0,
	"Adj":{"Type":1,"Amount":0.45,"percentage":5,"NoteLine1":"SÜT HAFTASI ÖZEL İNDİRİMİ"}
	},{
	"Id":2,
	"Quantity":2.5,
	"Price":4.49,
	"Name":"BULGUR",
	"DeptId":2,
	"Status":1,
	"Adj":null
	}],
"Adjustments":[{
	"Type":3,
	"Amount":-10.02,
	"percentage":15,
	"NoteLine1":"ÖZEL MÜŞTERİ İNDİRİMİ"
	}],
"Payments":[{
	"Type":0,
	"Index":0,
	"PaidTotal":20.0,
	"SequenceNo":0
	},{
	"Type":1,
	"Index":0,
	"PaidTotal":36.76,
	"SequenceNo":1
	}],
"FooterNotes":[
	"ÜRÜN İNDİRİMİ  :    *0,43",
	"ARATOP İNDİRİMİ:   *10,02",
	"TOPLAM İNDİRİM :   *10,45",
	"   **** İYİ GÜNLER ****",
	" www.hugin.com.tr",
	" 0212 212 2121",
	" MERSİS NO: 121244112344123124"
	],
"EndOfReceiptInfo":{"CloseReceiptFlag":false,"BarcodeFlag":false,"Barcode":null}
}

ÖKC ile kütüphane üzerinden bağlantı kurmak için temel olarak

/// <summary>
       /// Starts matching with ECR
       /// </summary>
       /// <param name="commObj">connection object(SerialPort or TCP/IP)</param>
       /// <param name="serverInfo">device info object</param>
       /// <returns>true if operations are done successfully</returns>
        bool Connect(Object commObj, DeviceInfo serverInfo);

methodu kullanılacaktır. Göründüğ üzere methodun iki parametresi bulunmaktadır. Öncelikli olarak commObj olarak belirtilen connection nesnesi oluşturulmalıdır. Seriport ve TCP bağlantıları desteklendiği için bu nesne;

System.IO.Ports.SerialPort

ya da

System.Net.Sockets.Socket

sınıflarından türemiş olmalıdır. Öncelikle bu bağlantılar oluşturulmalıdır.

			if (tabConn.SelectedTab == tabComPort)
                    {
                        // Seri port bağlantısı oluşturulur
                        this.Connection = new SerialConnection(cmbPorts.Text, int.Parse(txtBaudrate.Text));
                    }
                    else
                    {
                        // TCP/IP bağlantı oluşturulur
                        int port = Convert.ToInt32(txtTcpPort.Text);
                        this.Connection = new TCPConnection(txtTCPIP.Text, port);
                    }

                    this.Log(FormMessage.CONNECTING + "... ("+FormMessage.PLEASE_WAIT+")");
                    this.Connection.Open();

                    errPrefix = FormMessage.MATCHING_ERROR + ": ";

                    // ÖKC ile eşleme adımı
                    MatchExDevice();

Örnek uygulama projesinde yer alan yukarıdaki kod bloğunda da bu işlem yapılmıştır. Öncelikle Seriport ve TCP bağlantıları kurulmuş daha sonra eşleme adımına geçilmiştir.

NOT: Java kütüphanesinde TCPConnect ve SerialConnect methodları mevcuttur. Bu methodlar üzerinden gerekli bağlantılar sağlanabilir. Devamında akış aynıdır.

Bağlantılar kurulduktan sonra Hugin.Common kütüphanesinde yer alan DeviceInfo sınıfının alanları doldurulmalıdır. Bu Connect methodunun ikinci parametresidir.

Bu alanlar eşleşme sağlayacak olan bilgisayar bağlantılı sistemin, IP adres bilgisi, port, IP protokolü, marka, model, sicil numarası, versiyon ve anakart serisi gibi alanlardır.

	// DeviceInfo sınıfı gerekli bilgiler ile doldurulur
            DeviceInfo serverInfo = new DeviceInfo();
            serverInfo.IP = System.Net.IPAddress.Parse(GetIPAddress());
            serverInfo.IPProtocol = IPProtocol.IPV4;

            serverInfo.Brand = "HUGIN";

            if (!String.IsNullOrEmpty(System.Configuration.ConfigurationManager.AppSettings["Brand"]))
            {
                serverInfo.Brand = System.Configuration.ConfigurationManager.AppSettings["Brand"];
            }
            
            serverInfo.Model = "HUGIN COMPACT";
            serverInfo.Port = Convert.ToInt32(txtTcpPort.Text);
            serverInfo.TerminalNo = txtFiscalId.Text.PadLeft(8, '0');
            serverInfo.Version = new FileInfo(System.Reflection.Assembly.GetExecutingAssembly().Location).LastWriteTime.ToShortDateString();
            try
            {
                // Motherboard serisi alınır
                serverInfo.SerialNum = CreateMD5(GetMBId()).Substring(0, 8);
            }
            catch
            {
                // Seri alınırken sıkıntı yaşanırsa default bir değer verilebilir
                serverInfo.SerialNum = "ABCD1234";
            }

Örnek uygulamada yer alan yukarıda kod blokunda örnek giriş gösterilmektedir. Anakart serisi tekillik sağlama amaçlıdır. İllaki anakart serisi olacak diye bir koşul yoktur.

Artık gerekli parametreler hazırdır ve Connect methodunu çağırabiliriz.

		if (isMatchedBefore)
                {
                    // Eğer önceden eşleme yapıldıysa sadece connection objesinin kütüphaneye set edlmesi yeterli olacaktır.
                    printer.SetCommObject(conn.ToObject());
                    return;
                }
                try
                {
                    printer = new CompactPrinter();

                    // Eşleme öncesi ÖKC sicil numarası kütüphane üzerinde ilgili alana set edilir.
                    printer.FiscalRegisterNo = fiscalId;

                    try
                    {
                        // Loglama yapılacak dizin ve log seviyesi istenirse set edilir. Opsiyonel seçeneklerdir. 
                        //Set edilmemesi durumunda default değerler kullanılır.
                        if (!String.IsNullOrEmpty(System.Configuration.ConfigurationManager.AppSettings["LogDirectory"]))
                        {
                            printer.LogDirectory = System.Configuration.ConfigurationManager.AppSettings["LogDirectory"];
                        }

                        printer.LogerLevel = int.Parse(System.Configuration.ConfigurationManager.AppSettings["LogLevel"]);
                    }
                    catch { }

                    // Eşleme başlatılır. Başarılı ise true, başarısız ise false döner.
                    if (!printer.Connect(conn.ToObject(), serverInfo))
                    {
                        throw new OperationCanceledException(FormMessage.UNABLE_TO_MATCH);
                    }

                    // ÖKC üzerinde desteklenen bağlantı kapasitesi kontrol edilir, oluşturulan connection ile farklı ise düzenleme yapılır.
                    // Check supported printer size and set if it is different
                    if (printer.PrinterBufferSize != conn.BufferSize)
                    {
                        conn.BufferSize = printer.PrinterBufferSize;
                    }
                    printer.SetCommObject(conn.ToObject());
                    isMatchedBefore = true;
                }
                catch (Exception ex)
                {
                    throw ex;
                }

Eğer daha önceden ÖKC ile eşleme sağlanmış ise, kurulan yeni bağlantının SetCommObject ile bağlantı nesnesinin set edilmesi yeterli olacaktır. Tekrar eşleme yapmaya ya da Connect methodu kullanmaya gerek yoktur.

Diğer durumda ise, öncelikel CompactPrinter instance edilir ve ilk iş olarak ÖKC sicil numarası FiscalRegisterNo alanına set edilir.

Opsiyonel olarak, log dosyalarının oluşturulacağı dizin ve log seviyesi set edilebilir. Bu alanlara ait gerekli bilgiler KÜTÜPHANE FONKSİYONLARI bölümünde mevcuttur. Herhangi bir işlem yapılmaması durumunda default dizin ve log seviyesi kullanılacaktır. Default log dizini uygulamanın çalıştığı dizin, default log seviyesi de INFO seviyesi yani 4. seviyedir.

Ardından hazır olan parametrelerimiz ile birlikte Connect methodu çağırılır. true dönerse eşleşme başarılıdır. false dönmesi halinde başarısız olmuştur.

NOT: İlk eşleme sırasında Connect methodu çağırılmadan önce, ÖKC servis konumunda ve harici cihaz eşleme başlatılmış olmalıdır. Servis menüsünden bir kere başarılı eşleme yapıldıktan sonra ikincisine gerek yoktur.

Başarılı eşlemeden sonra, CompactPrinter'ın PrinterBufferSize özeliğinden desteklenen bağlantı buffer boyutu alınarak kurulan bağlanıtının buffer boyutu ile karşılaştırma yapılır. Eğer aynı değil ise, mevcut bağlantının buffer boyutu printer buffer boyutu ile set edilir. Ardından SetCommObject ile güncellenen mevcut bağlantı tekrar printer bağlantısı olarak set edilir. İşleme ait örnek uygulamada yer alan kod bloğu aşağıdadır.

   		// ÖKC üzerinde desteklenen bağlantı kapasitesi kontrol edilir, oluşturulan connection ile farklı ise düzenleme yapılır.
                   // Check supported printer size and set if it is different
                   if (printer.PrinterBufferSize != conn.BufferSize)
                   {
                       conn.BufferSize = printer.PrinterBufferSize;
                   }
                   printer.SetCommObject(conn.ToObject());

Buraya kadar herhangi bir hata alınmamış ise bilgisayar bağlantılı harici sistem ÖKC ile başarılı bir şekilde eşleşmiştir.

ÖKC ile bağlantı kurulması sonucu ÖKC "KASİYER GİRİŞİ" durumunda olacaktır. Sizden kasiyer girişi yapılması beklenmektedir. SignInCashier methodu ile kasiyer girişi yapılır. ÖKC üzerinde yer alan default kasiyer bilgilerini ilgili birimlerimizden temin edebilirsiniz.

Kasiyer girişi sonrası ÖKC, IDLE yani bekleme durumuna geçecektir. Yazdıracağımız belge tipine göre uygun belge başlığı yazdırma methodu çağırılmalıdır. Bazı belgelerin kalem ürün yazdırma opsiyonu yoktur ve bu belge başlığı yazdırma methodunda gerekli tüm parametrelere sahiptir. Fatura tahsilatı, Avans gibi..

Fiş başlatılacak ise;

/// <summary>
        /// Starts fiscal receipt
        /// </summary>
        /// <returns>
        /// "ErrorCode"|"Status"|"ReceiptNo"
        /// </returns>
        string PrintDocumentHeader();

fatura, e-fatura ve e-arşiv bilgi fişleri başlatılacak ise ;

/// <summary>
        /// Starts  invoice, e-invoice, e-archive
        /// </summary>
        /// <param name="docType">doc type id</param>
        /// <param name="tckn_vkn">TCKN or VKN</param>
        /// <param name="docSerial">document serial number</param>
        /// <param name="docDateTime">documnet issue date and time</param>
        /// <returns>"ErrorCode"|"Status"|"DocumentNo"</returns>
        string PrintDocumentHeader(int docType, string tckn_vkn, string docSerial, DateTime docDateTime);

Avans belgesi bilgi fişi için;

/// <summary>
        /// Prints advance document
        /// </summary>
        /// <param name="tckn">customer TCKN</param>
        /// <param name="name">customer name</param>
        /// <param name="amount">advance amount</param>
        /// <returns>"ErrorCode"|"Status"|"DocumentNo"</returns>
        string PrintAdvanceDocumentHeader(string tckn, string name, decimal amount);

Fatura tahsilat bilgi fişi için;

/// <summary>
        /// Prints collection document
        /// </summary>
        /// <param name="invoiceNo">collection invoice number</param>
        /// <param name="amount">collection amount</param>
        /// <param name="subscriberNo">subscriber number</param>
        /// <param name="institutionName">instution name</param>
        /// <param name="comissionAmount">comission amount</param>
        /// <returns></returns>
        string PrintCollectionDocumentHeader(string invoiceSerial, DateTime invoiceDate, decimal amount, string subscriberNo, string institutionName, decimal comissionAmount);

Cari hesap tahsilat bilgi fişi için;

/// <summary>
        /// Prints Current Account Collection Document
        /// </summary>
        /// <param name="tcknVkn">TCKN/VKN</param>
        /// <param name="customerName">Customer name</param>
        /// <param name="docSerial">document serial</param>
        /// <param name="amount">document amount</param>
        /// <returns>"ErrorCode"|"Status"|"DocumentNo"</returns>
        string PrintCurrentAccountCollectionDocumentHeader(string tcknVkn, string customerName, string docSerial, DateTime docDate, decimal amount);

Yemek fişi için;

/// <summary>
        /// Starts food document
        /// </summary>
        /// <returns></returns>
        string PrintFoodDocumentHeader();

Otopark bilgi fişi için;

/// <summary>
        /// Prints otopark document
        /// </summary>
        /// <param name="plate">vehicle plate num</param>
        /// <param name="entrenceDate">entrence date-time</param>
        /// "ErrorCode"|"Status"|"InvoiceNo"
        string PrintParkDocument(string plate, DateTime entrenceDate);

methodları kullanılır. Methodlar ve aldıkları parametreler ile ilgili daha detaylı açıklamalar KÜTÜPHANE FONKSİYONLARI kısmında yer almaktadır.

ÖKC üzerinde iki çeşit satış yapılabilmektedir. PLU ya da departman(kısım) satışı. Belge başlatıldıktan sorna satışlar kalem kalem yazdırılabilir ya da JSON formatta uygun methodlar ile toplu halde ÖKC ye gönderilebilir. En hızlı belge gönderimi ve basımı, tutarlılık ve daha az problem için JSON formatta departman satışı yapılmasını önermekteyiz.

/// <summary>
        /// Prints sale item 
        /// </summary>
        /// <param name="PLUNo">PLU number of item</param>
        /// <param name="quantity">item quantity</param>
        /// <param name="amount">item amount</param>
        /// <param name="name">item name</param>
        /// <param name="barcode">item barcode</param>
        /// <param name="deptId">department id of item</param>
        /// <returns>
        /// "ERrorCode"|"Status"|"SubTotal"
        /// </returns>
        string PrintItem(int PLUNo, decimal quantity, decimal amount, string name, string barcode, int deptId, int weighable);

/// <summary>
        /// Prints sale item 
        /// </summary>
        /// <param name="deptId">department id </param>
        /// <param name="quantity">item quantity</param>
        /// <param name="amount">item amount</param>
        /// <param name="name">item name</param>
        /// <param name="weighable">item is weighable or not</param>
        /// <returns>
        /// "ErrorCode"|"Status"|"SubTotal"
        /// </returns>
        string PrintDepartment(int deptId, decimal quantity, decimal amount, string name, int weighable);

/// <summary>
        /// prints JSON DOC
        /// </summary>
        /// <param name="jsonStr"></param>
        /// <returns></returns>
        string PrintJSONDocument(string jsonStr);

/// <summary>
        /// Prints sales document which json format. ECR must be in selling state 
        /// it means StartDocument called before. 
        /// </summary>
        /// <param name="jsonStr"></param>
        /// <returns></returns>
        string PrintJSONDocumentDeptOnly(string jsonStr);

ya da

/// <summary>
        /// Send sale document to print 
        /// </summary>
        /// <param name="jsonStr">Sales document info in JSON format</param>
        /// <returns>returns printer response</returns>
        string PrintSalesDocument(string jsonStr);

Bu iki method aynı işi yapıyor gibi görünse de farklılıkları mevcuttur. PrintJSONDocumentDeptOnly ile sadece satışlar ya da sadece ödemeler gönderilebilir. Fakat PrintSalesDocument ile sadece tamamlanmış belgeler yani ödemesi ile birlikte kapatılmış belgeler gönderilebilir.

Hız bakımından departman satışları PLU satışlarına göre daha hızlıdır. PrintJSONDocumentDeptOnly methoduna göre de PrintSalesDocument methodu daha hızlıdır.

Belge kapatma;

/// <summary>
        /// Closes receipt
        /// </summary>
        /// <param name="slipCopy">prints slip copy </param>
        /// <returns>
        /// "ErrorCode"|"Status"|"ReceiptNumber"
        /// </returns>
        string CloseReceipt(bool slipCopy);

için yukarıdaki method kullanılabileceği gibi, JSON satışlarda ilgili JSON alanı ile de yapılabilir. Detaylar için JSON satış belgesi kısmını inceleyebilirsiniz.

İndirim ve arttırımlar genel olarak ürüne yapılan ya da belge toplamına yapılan şekilde ikiye ayırlabilir. Kendi içlerinde de; yüzdesel indirim, yüzdesel arttırım, tutarsal indirim, tutarsal arttırım olarak dörde ayırabiliriz.

/// <summary>
        /// Prints adjustment
        /// </summary>
        /// <param name="adjustmentType">
        /// enum number having the following meanings
        /// {
        ///     0 : Fee
        ///     1 : Percent Fee
        ///     2 : Discount
        ///     3 : Percent Discount
        /// }
        /// </param>
        /// <param name="amount">amount of adjustment</param>
        /// <param name="percentage">percentage value if adjustment type is fee or discount</param>
        /// <returns>
        /// "ErrorCode"|"Status"|"SubTotal"
        /// </returns>
        string PrintAdjustment(int adjustmentType, decimal amount, int percentage);

İndirim/arttırım işlemleri için PrintAdjustment methodu kullanılır. Ürün satışından sonra çağırılırsa en son satılan ürüne uygulanır. Aratoplam alınır ve ondan sonra çağırılırsa belge toplamına uygulanır. Belge aratoplamı PrintSubtotal methodu ile alınır.

JSON satışlarında ise ilgili alanlar doldurulmalıdır. Adjustment sınıfı kullanılır. JSONItem dahilinde yer alırsa ilgili ürüne uygular, JSONDocument dahilindeki ise belge toplamına uygulanır.

	class Adjustment
    {
        public AdjustmentType Type = AdjustmentType.Discount;
        public decimal Amount = 0m;
        public int Percentage = 0;
        public string NoteLine1;
        public string NoteLine2;
    }

PLU satışı,

/// <summary>
        /// Voids a sold item on document
        /// </summary>
        /// <param name="PLUNo">PLU number of item</param>
        /// <param name="quantity">item quantity</param>
        /// <returns>
        /// "ErrorCode"|"Status"|"SubTotal"
        /// </returns>
        string Void(int PLUNo, decimal quantity);

departman satışı ise,

/// <summary>
        /// Voids a sold item on document
        /// </summary>
        /// <param name="deptId">Department id to be void</param>
        /// <param name="deptName">Department name to be void</param>
        /// <param name="quantity">item quantity</param>
        /// <returns>
        /// "ErrorCode"|"Status"|"SubTotal"
        /// </returns>
        string VoidDepartment(int deptId, string deptName, decimal quantity);

methodları kullanılarak iptal edilebilir.

Belge iptalinde ise

/// <summary>
        /// Voids receipt
        /// </summary>
        /// <returns>
        /// "ErrorCode"|"Status"|"ReceiptNumber"
        /// </returns>
        string VoidReceipt();

kullanılır. Bu methodlarda ÖKC durumuna dikkat edilmelidir. Bu işlemlerin gerçekleşebileceği uygun durumlarda olmalıdır, aksi takdirde hata alınır.

ÖKC, IDLE konumda iken yani üzerinde bir işlem yok iken kağıt bitmesi ya da rulo değiştirilmesi durumunda herhangi bir işlem yapmaya gerek yoktur. İşlem sırasında kağıt bitmesi durumunda ÖKC ilgili hata kodunu fırlatır. Hata alındıktan sonra kasiyer yeni rulo takar. Bu adımdan sorna ÖKC "7" hata kodu ile SİLME GEREKLİ mesajı yollayacaktır. Rulo takıldıktan sonra CheckPrinterStatus komutu ile ÖKC durumunu kontrol etmekte fayda vardır. İlgili hata kodu alındıktan sonra

/// <summary>
        /// this function called if ECR returns error codes below
        /// 7	ERR_CLEAR_REQUIRED
        /// 35	ERR_NEW_EJ
        /// 134	ERR_BLK_Z_REQUIRED
        /// </summary>
        /// <returns>
        /// "ErrorCode"|"Status"
        /// </returns>
        string ClearError();

komutu ile SİLME işlemi gerçekleştirilir. Bu işlemin ardından ÖKC ile kaldığınız yerden çalışmaya devam edebilirsiniz. Ayrıca JSON belge satışı sırasında kağıt bitimi gerçekleşirse ve basılmayan ürünler mevcut ise bu komut ardına basılmayan kısımlar da basılarak belge kapatılır.

ÖKC üzerinde 24 saat dahilinde Z raporu alınmaması durumunda fırlatılır. Bu durumda dikkat edilmesi gereken nokta; bu hata alındıktan sonra PrintZReport methodu ile Z raporunu yazdıramazsınız. Z raporunun yazdırılabilmesi için ClearError komutu kullanılmalıdır. Devamında işlemlerinize devam edebilirsiniz.

/// <summary>
        /// this function called if ECR returns error codes below
        /// 7	ERR_CLEAR_REQUIRED
        /// 35	ERR_NEW_EJ
        /// 134	ERR_BLK_Z_REQUIRED
        /// </summary>
        /// <returns>
        /// "ErrorCode"|"Status"
        /// </returns>
        string ClearError();