Technical Documentation - huginsdk/fpu GitHub Wiki

1. Introduction

This document has been prepared for ensure communication between Fiscal Printer and user side(PC) by CompactPrinter interface.

CompactPrinter is a cross platform dynamic link library. For C# version, minimum requirement is .NET Framework 4 on Windows 7.

Library functions are grouped in five sections:

• Programming Functions
• Sale Functions
• Report Functions
• Service Functions
• Utility Functions

These functions get specific parameters and return boolean or string values. Functions which return boolean value are operational functions like ger or set. There is a special structure for string functions. This structure is formed in-line and sequential strings are seperated by pipe character( '|' ).

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

First two strings are error code and status values. Other parameter strings vary depending on relevant function.

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

There are four DLLs in the package:

• Hugin.Common.dll
• Hugin.GMPCommon.dll
• Hugin.ExDevice.dll
• Hugin.POS.CompactPrinter.FPUdll

Hugin.Common.dll contains helper functions for other DLL's and project. Also it contains DeviceInfo class which is required for sending software vendor information (legal requirment) to Compact Printer as a parameter on matching state. Hugin.GMPCommon.dll and Hugin.ExDevice.dll libraries are used for low level operations. Hugin.POS.CompactPrinter.dll uses these DLLs. So you do not need to reference them. Our main function are located in Hugin.POS.CompactPrinter.dll.

You have to implement your connection(Serial Port or TCP/IP) and create a connection object to send Compact Printer initialization on your application side. After created your printer object from Compact Printer interface and set Fiscal ID (e.g FA12345678) to CompactPrinter.FiscalRegisterNo feature. And now you can call connect function for connection and matching operations. You can see more detailed source code parts on below.

/// <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);

You can see more details about Connect() function in function definitions section.

ICompactPrinter compactPrinter = new CompactPrinter();
// Set Fiscal No
compactPrinter.FiscalRegisterNo = "FA12345678";
// Send connection object and device info
compactPrinter.Connect(conn.ToObject(), serverInfo);

After succesfully establishing the connection, you can use all the public functions. Some example operation flows are shown below:

Sale item:

• Connect to printer
• Sign in cashier
• Start receipt
• Sell item(s)�
• Pay amount �
• Close receipt�

Send PLU data:

• Connect to printer
• Sign in cashier(program authorized)
• Save product with suitable function with needed arguments.

Change Logo Lines:

• Connect to printer
• Sign in with cashier 9
• Print Z Report
• Get current logo lines by given index number
• Change necessary item�
• Set logo lines on correct index
• Exit service mode

Creating TCP/IP or Serial Port connection to FPU on client side:

if (tabConn.SelectedTab == tabComPort)
{
this.Connection = new SerialConnection(cmbPorts.Text, int.Parse(txtBaudrate.Text));
}
else
{
int port = Convert.ToInt32(txtTcpPort.Text);
this.Connection = new TCPConnection(txtTCPIP.Text, port);
}

this.Connection.Open();

Serial Port Open():

public void Open()
{
sp = new SerialPort(portName, baudRate);
sp.WriteTimeout = 4600;
sp.ReadTimeout = 4600;
sp.ReadBufferSize = 40000;
sp.Encoding = MainForm.DefaultEncoding;
sp.Open();
}

TCP Open() :

public void Open()
{
// Close if there is any idle connection
this.Close();

IPEndPoint ipep = new IPEndPoint(IPAddress.Parse(this.ipAddress), this.port);
client = new Socket(AddressFamily.InterNetwork,
SocketType.Stream, ProtocolType.Tcp);
client.ReceiveTimeout = 4500;
client.Connect(ipep);
}

Sending connection object and device info, matching with device via Compact Printer:

MainForm.SetFiscalId(txtFiscalId.Text);

DeviceInfo serverInfo = new DeviceInfo();
serverInfo.Brand = "APOS"; //Max size 20
serverInfo.Model = "APOS NEW GEN" // //Max size 20
serverInfo.TerminalNo = txtFiscalId.Text.PadLeft(10, '0'); // Fiscal ID of the ECR. Length is 10
serverInfo.SerialNum  = CreateMD5(GetMBId()).Substring(0, 8); // Unique id of the External Device. Motherboard id or MAC address. Max length is 16
serverInfo.Version = new FileInfo(System.Reflection.Assembly.GetExecutingAssembly().Location).LastWriteTime.ToShortDateString(); // Software version. Max length is 20.

// For TCP connection, Set parameters were listed below for only TCP connection.
serverInfo.IP = System.Net.IPAddress.Parse(GetIPAddress());
serverInfo.IPProtocol = IPProtocol.IPV4;
serverInfo.Port = Convert.ToInt32(txtTcpPort.Text);

if (conn.IsOpen)
{
try
{
printer = new CompactPrinter();
printer.FiscalRegisterNo = fiscalId;
if (!printer.Connect(conn.ToObject(), serverInfo))
{
throw new OperationCanceledException("Eşleme yapılamadı");
}
}
catch (Exception ex)
{
Log();
throw ex;
}
Log();
CPResponse.Bridge = this;
}

Signing in cashier:

// Cashier Id
int id = (int)nmrCashierNo.Value;

// Password
string password = txtPassword.Text;

try
{
ParseResponse(new CPResponse(bridge.Printer.SignInCashier(id, password)));
}
catch (System.Exception ex)
{
bridge.Log("Hata: " + ex.Message);
}

Starting document:

CPResponse response;

if (cbxInvoice.Checked) // Checking for doc is invoice or receipt
{
response = new CPResponse(bridge.Printer.PrintDocumentHeader(vkn, amount, docType));

}
else
{
response = new CPResponse(bridge.Printer.PrintDocumentHeader());
}

Selling an saved item:

CPResponse response = new CPResponse(bridge.Printer.PrintItem(pluNo, quantity, price, null, -1, -1));

Payment:

int index = -1;

//PAYMENT TYPE
int paymentType = cbxPaymentType.SelectedIndex;

//IF PAYMENT IS FOREIGN CURRENCY OR CREDIT
if (cbxPaymentType.Text == "Döviz" || cbxPaymentType.Text == "Kredi")
{
//Index
index = cbxSubPayments.SelectedIndex;
}

//PAYMENT AMOUNT
decimal amount = nmrPaymentAmount.Value;

// SEND COMMAND
CPResponse response = new CPResponse(bridge.Printer.PrintPayment(paymentType, index, amount));

Closing sale document:

CPResponse response = new CPResponse(bridge.Printer.CloseReceipt());

Note: If error code is 0, operation is successful

Customer has to set some settings to start selling. To change settings authorized cashier must be logging in. Authorized cashier id is 9. Other cashier only get settings but cannot set. Primary settings are listed below, 1- Logo 2- VAT 3- Department 4- PLU 5- Credit Info 6- Foreign Currency Info 7- Main/Sub Product Category 8- Cashier Info 9- Graphic Logo 10- End of Receipt Note

Other settings are important as well as listed above, but not oppose to selling.

Common error codes in Programming,

Sets logo on FPU

Parameters:

Return value:

<ErrCode>|<Status>|<LogoLine>

Note: 5th index of logo line has to be VKN(Customer tax registration No)

Errors :

Gets logo on FPU

Parameters:

Return value:

<ErrCode>|<Status>|<LogoLine>

Sets VAT rates.

Parameters:

Return value:

<ErrCode>|<Status>|<VATRate>

Errors :

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Gets VAT rates.

Parameters:

Return value:

<ErrCode>|<Status>|<VATRate>

Sets department. Department known as "Section" some platform. ECR doesn't allow to sales directly on VAT. Each VAT rates connect to Department. One to one or many to one releations can be. For example, Three department can related with same VAT rate. ECR also doesn't allow directly department sales if sales is making on PC. PC mode allow only PLU sales. PLU connects to department. Differeny PLUs can be connect same department.

Parameters:

Return value:

<ErrCode>|<Status>|<Name>|<VatId>|<Price>|<Weighable>

Errors:

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Has the same features as the upper function with a difference. Extra parameter "limit", sets maximum departmant sales amount for each sales row.

For Example: Product unit price is 50. If you set its department limit to 500, you can sale maximum 10 pieces for each sales row.

Parameters:

Return value:

<ErrCode>|<Status>|<Name>|<VatId>|<Price>|<Weighable>|<Limit>

Errors:

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Gets department info in given id

Parameters:

Return value:

<ErrCode>|<Status>|<Name>|<VatId>|<Price>|<Weighable>

Errors:

Sets credit info. This payment generally uses if you payment taken from EFT-POS which is not connected with ECR.

Parameters:

Return value:

<ErrCode>|<Status>

Errors:

Gets credit info in given id

Parameters:

Return value:

<ErrCode>|<Status>|<CreditName>

Sets currency info.

Parameters:

Return value:

<ErrCode>|<Status>|<CurrencyName>|<CurrencyExcRate>

Note: Only FP300 model ECR allows to payment by foreign currency.

Errors:

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Gets currency info in given id

Parameters:

Return value:

<ErrCode>|<Status>|<CurrencyName>|<CurrencyExcRate>

Note: Only FP300 model ECR allows to payment by foreign currency.

Sets main category. Main group info of products.

Parameters:

Return value:

<ErrCode>|<Status>|<MainCategoryName>

Errors:

Note: This property is not necessary for sales.

Gets main category info in given id. Main group info of products.

Parameters:

Return value:

<ErrCode>|<Status>|<MainCatId>|<MainCategoryName>

Note: This property is not necessary for sales.

Sets sub category. Sub group info of products. Each sub category related with one main category.

Parameters:

Return value:

<ErrCode>|<Status>|<SubCatName>|<MainCatId>

Errors:

Note: This property is not necessary for sales.

Gets sub category info in given id. Sub group info of products. Each sub category related with one main category.

Parameters:

Return value:

<ErrCode>|<Status>|<Id>|<Name>|<MainCategoryId>

Note: This property is not necessary for sales.

Saves cashier.

Parameters:

Return value:

<ErrCode>|<Status>|<CashierName>

Errors:

Gets cashierinfo in given id

Parameters:

Return value:

<ErrCode>|<Status>|<CashierName>

Saves product in ECR

Parameters:

Return value:

<ErrCode>|<Status>

Errors:

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Gets product in given plu number

Parameters:

Return value:

<ErrCode>|<Status>|<DepartmentName>|<DepartmentId>|<Price>|<Weighable>|<Barcode>|<SubCategoryId>

Errors:

Loads graphical logo

Parameters:

Return value:

<ErrCode>|<Status>

Errors:

Saves program option value

Parameters:

Return value:

<ErrCode>|<Status>|<ProgramOptionValue>

Errors:

Gets program option value

Parameters:

Return value:

<ErrCode>|<Status>|<ProgramOptionValue>

Gets notes which programmed to end of receipt on ECR.

Parameters:

Return value:

<ErrCode>|<Status>|<Line>    

Sets end of receipt note lines to ECR.

Parameters:

Return value:

<ErrCode>|<Status>|<Line>

Starts fiscal receipt.

Return value:

<ErrCode>|<Status>|<ReceiptNo>

Errors:

Starts info receipt.

Info receipts prints on ECR for the following reason,

Sales application can not get payment directly over EFT-POS. If Info receipt -prepared by sales application- has EFT payment, sales application starts the info receipt for taking EFT Payment over ECR.

Vendors need info receipts for following reasons,

1. If Receipt subtotal exceeds the receipt limit, receipt type must be Invoice, E-Invoice and E-Archive. Current receipt limit is 900,00TL in Turkey.
2. If customer wants to invoice for its company and its company subject to e-Invoice, cashier have to start e-Invoice.
3. Customers may want to e-Archive instead of Invoice.
4. If Customers want to pay by food payment card such as SODEXO, cashier has to start Food Receipt. This document doesnot includes VAT. Food payment cards pass only food restaurant.
5. Oto parks have to start park ticket.
6. If customer wants to pay goods price before shop it(to reserve it), cashier prepare Advenced payment document.

DocType:

1. Invoice : Sales application prepares also invoice document paper on slip printer.
2. E-Invoce : Electronic Invoice prepared for commercial company
3. E-Archive : Electronic Document for customer non-commercial.
4. Food Receipt : For get payment by food payment card.
5. Park Ticket : Uses otopark.
6. Advanced Payment : Customer pay goods price to reserve it.

NOTE: TCKN no must be 11 digits, VKN no must be 10 digits

Parameters:

Return value:

<ErrCode>|<Status>|<DocumentNo> 

Errors:

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Starts invoice, e-invoice, e-archive

Parameters:

DocType:

1. Invoice : Sales application prepares also invoice document paper on slip printer.
2. E-Invoce : Electronic Invoice prepared for commercial company
3. E-Archive : Electronic Document for customer non-commercial.

Return value:

<ErrCode>|<Status>|<DocumentNo> 

Errors:

Prints advance document

Parameters:

Return value:

<ErrCode>|<Status>|<DocumentNo> 

Errors:

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Prints collection document

Return value:

<ErrCode>|<Status>|<DocumentNo> 

Errors:

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Starts food document

Return value:

<ErrCode>|<Status>|<DocumentNo> 

Errors:

Prints car parking document

Parameters:

Return value:

<ErrCode>|<Status>|<DocumentNo> 

Errors:

Prints sale item

NOTE: "deptId", "amount", "name", "weighable" parameters are not neccessary while selling a PLU item(if item has already saved before). Send "-1" value instead of them(name->null). So compact printer does not send a value as deparment id. You can save an item while selling with this function at same time on programability mode. You can send their own value on parameters;

"name" -> string "deptId" -> int "amount" -> decimal "weighable" -> if weigable 1 or not 0

Parameters:

Return value:

<ErrCode>|<Status>|<SubTotal>

Errors:

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Prints sale item

Parameters:

Return value:

<ErrCode>|<Status>|<SubTotal>

Errors:

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Apply adjustment to last item and print adjusted value. Last item can be Sale item or Subtotal. If last item is sale item, apply adjusment only last sale item. If last item is subtotal, apply adjusment all sold items.

Parameters:

Return value:

<ErrCode>|<Status>|<SubTotal>

Errors:

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Corrects last operation on document(sale, adjustment)

Parameters:Return value:

<ErrCode>|<Status>|<SubTotal>

Errors:

Voids a sold item on document

Parameters:

Return value:

<ErrCode>|<Status>|<SubTotal>

Errors:

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Voids a sold item on document

Parameters:

Return value:

<ErrCode>|<Status>|<SubTotal>

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

It allows to void an sale by giving line number. For example, there are 3 items sold in the document, assume that this items belong to same department.

ITEM A     %1        *1.20
ITEM B     %1        *1.50
ITEM C     %1        *1.80

If "ITEM B" is required Void, then use this function by setting "lineNumber" parameter as "2". Because it is located in line 2. Each receipt operaiton represents a line. Another example, assume you voide item b and do 2 more sales as follows;

ITEM A     %1        *1.20
ITEM B     %1        *1.50
ITEM C     %1        *1.80
VOID
    ITEM B %1       *-1.50
ITEM D     %1        *1.90
ITEM E     %1        *2.10

If you want to void ITEM E, use this function by setting "lineNumber" parameter as "6".

Parameters:

<ErrCode>|<Status>|<SubTotal>

Restrictions:

• Only T300 model supports this functionality

Prints or gets subtotal of current document.

Parameters:

Return value:

<ErrCode>|<Status>|<SubTotal>|<PaymentAmount>

Errors:

Keeps payment until payment amount equals to subtotal. If payments total equals to subtotal, all payment printed together. Sales application can void payment if payments has not printed.

Parameters:

Return value:

<ErrCode>|<Status>|<SubTotal>|<PaidTotal>

Errors:

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

To get Credit card info before EFT payment, this function called.

Parameters:

Return value:

<ErrCode>|Status>|<Hgnccid>|<Hgnccname>|<CardHolderName>|<CardNumber>|<DiscountEnable>

Errors:

Takes payment from EFT-POS. To use this function, EFT-POS has to interated with ECR. EFT payment printed after payment total equals to subtotal.

Parameters:

Return value:

<ErrCode>|Status>|<Subtotal>|<ProvisionID>|<Amount>|<AppliedInstallment>|<AcquirerId>|<BIN>|<IssuerId>|<SubOperationType>|<BatchNo>|<StanNo>|<TotalPaidAmount>

SUB-OPERATION TYPES:
{
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"
}

Errors:

Saves BIN list

Parameters:

Return value:

<ErrCode>|<Status>

Voids payment that done by EFT-POS. This function allows void all amount of payment which paid by credit card after receipt closed.

Parameters:

Return value:

<ErrCode>|<Status>|<Amount>|<AcquierID>|<IssuerID>|<CardNumber>

Errors:

Starts refund operation on EFT-POS. This function allows to partial refund of credit card payment after receipt is closed.

Parameters:

Return value:

<ErrCode>|<Status>|<Amount>|<AcquierID>|<IssuerID>|<CardNumber>

Errors:

Gets EFT slip copy. You can get with batch no & stan no or Z no & receipt no parameters. Acquier id area is neccesary both.

Parameters:

Return value:

<ErrCode>|<Status>

Errors:

Gets bank list on EFT-POS

string BankInfo = acquierID(4) + bankName

Return value:

<ErrCode>|<Status> |<BankInfo_1>|<BankInfo_2>|<BankInfo_3>|......|<BankInfo_N> 

Errors:

Gets sales info

Return value:

<ErrCode>|<Status> |<DocumentNo>|<ZNo>|<DocumentType>|<Date>|<Time>|<Subtotal>|
payments(<PaymentType>|<PaymentIndex>|<Amount>|<Note>)

DocumentType list: 0. z report

1. Receipt
2. Receipt voided
3. Info receipt, like x report, departments report
4. like financial report
5. like ej periodic report
6. Receipt voided after power down
7. non fiscal reports
8. not in use,
9. voided nonfiscal document,
10. Invoice document
11. e-archive or e-invoice
12. voided e-archive or e-invoice

Errors:

Voids payment if there is unpaid amount. Payments must be not printed.

Parameters:

Return value:

<ErrCode>|<Status>

Errors:

Closes receipt

Parameters:

Return value:

<ErrCode>|<Status>|<ReceiptNumber>

Errors:

Voids receipt

Return value:

<ErrCode>|<Status>|<ReceiptNumber>

Errors:

Prints barcode on receipt footer. Barcode format is code128. Only one barcode can print for each receipt. This function is supported only FP300 model.

Parameters:

Return value:

<ErrCode>|<Status>

Errors:

Prints remark lines. Supported states for print remark are SELLING and OPEN_SALE.

Parameters:

Return value:

<ErrCode>|<Status>

Errors:

Prints JSON Object string as a sale document. You have to sign in with Cashier 9 because products saved when selling.

HUGIN JSON PLU Sale Document Object:

	
	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>();
    }

NOTE : NoteLine1 and NoteLine2 areas on JSONItem and Adjustment, only used for PrintJSONDocumentDeptOnly and PrintSalesDocument funcs.

Parameters:

Sample 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}
}

Return value:

<ErrCode>|<Status>

Prints Hugin Json sales document. (You can find Hugin Json Sale Document Object under at PrintJSONDocument title) ECR must be in selling state. It means PrintDocumentHeader called before. The sample Json document placed under PrintJSONDocument title.

Note areas on JSONItem and Adjustment objects can be used for this function. Notes can be placed after sale item and item adjustments. Notes must be max 2 line: 2 x 48 characters for FP300 Printers 2 x 36 characters for FT202 Printers

Parameters:

Return value:

<ErrCode>|<Status>

Prints Hugin Json sales document. (Differents with PrintJSONDocumentDeptOnly, this function send sales document info in one packege to printer, so its more faster )

Parameters:

Return value:

<ErrCode>|<Status>|<ZId>|<ReceiptId>|<Date>|<Time>|<DocumentType>|
Payment info block repeats for each payment
<PaymentType>|<Index>|<PaidTotal>|<PaymentNote>

Prints current acount collection document header

Parameters:

Return value:

<ErrCode>|<Status>|<DocumentNo>

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Prints barcode with choosen type to end of receipt. (For Vx675 model)

BARCODE TYPES: 1- EAN 2- QRN 3- C039 4- C128

Parameters:

Return value:

<ErrCode>|<Status>

Prints E-Archieve or E-Invoice document on FP300.

Parameters:

Return value:

<ErrCode>|<Status>

Prints EFT payment content on FP300 ECR. This function used only when EFT-POS device managed by Sales Application, that means EFT-POS connected to PC directly. Function allows to print Customer copy, Merchant copy and Error slips.

Parameters:

Return value:

<ErrCode>|<Status>

Errors:

Starts invoice from internal printer.

Parameters:

Return value:

<ErrCode>|<Status>|<DocumentNo>|<ZNo>|<VatRate>|<VatAmount>

Starts Return Document.

Parameters:

Return value:

<ErrCode>|<Status>|<DocumentNo>|<ZNo>|<VatRate>|<VatAmount>

Starts Self Employment Invoice

Parameters:

Return value:

<ErrCode>|<Status>|<DocumentNo>|<ZNo>|<VatRate>|<VatAmount>

Gets subtotals using stoppage amount.

Parameters:

Return value:

<ErrCode>|<Status>|<DocumentNo>|<ZNo>|<VatRate>|<VatAmount>

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Parameters:

Return value:

<ErrCode>|<Status>

Errors:

Sales application can trigger ECR for take report. Functions for report listed at this subject. Sales application may reveive report content without print lines. In such a case, some function takes copy paramter, it means print report on paper or get only report content or either print and get content.

copy parameter takes these values,

Common Error codes in report functions are,

Prints X report. X report includes all Z report contents but X report is not fiscal report. X report provides to see Z report contents without reset payments

Parameters:

Return value:

<ErrCode>|<Status>|<DocNo>|<ZNo>

Prints X report between given plu range. PLU range must be smaller than 1000 PLU.

Parameters:

Return value:

<ErrCode>|<Status>|<DocNo>|<ZNo>

Errors:

Prints system info report.

Parameters:

Prints receipt summary report. This report includes totals of sales grouped by receipt.

Parameters:

Errors:

Prints Z report. Z report is a typical end-of-day report containing all balances of sold items per category and the total amount that should be in the drawer. It resets day totals

Return value:

<ErrCode>|<Status>|<DocNo>|<ZNo>

Errors:

Prints periodic report. Report contains payment informations between two dates.

Parameters:

Return value:

<ErrCode>|<Status>|<DocNo>|<ZNo>

Errors:

Prints periodic report. Periodic report contains one or more Z report informations.

Parameters:

Return value:

<ErrCode>|<Status>|<DocNo>|<ZNo>

Errors:

Prints periodic reports daily. This report can take only fiscal mode.

Parameters:

Return value:

<ErrCode>|<Status>|<DocNo>|<ZNo>

Prints periodic reports between two dates. This report can take only fiscal mode.

Parameters:

Return value:

<ErrCode>|<Status>|<DocNo>|<ZNo>

Prints periodic reports between two z numbers. This report can take only fiscal mode.

Parameters:

Return value:

<ErrCode>|<Status>|<DocNo>|<ZNo>

Prints report that general information about the use of EJ. EJ No, Frist Z no, Last Z no, First Receipt no, Last Receipt No, Total EJ Line, Used EJ Line

Return value:

<ErrCode>|<Status>|<EJNo>|<FirstZNo>|<FirstReceiptNo>|<LastZNo>|<LastReceiptNo>|<TotalEJLine>|<UsedEJLine>

Prints end day report on EFT-POS

Return value:

<ErrCode>|<Status>

Z Prints the report. The Z report is some kind of end-of-day report. Includes the department and total amount information of the products sold. The day resets the total values.

Parameters:

Return value:

<ErrCode>|<Status>|<DocumentNo>|<ZNo>

Errors:

Parameters:

Return value:

<ErrCode>|<Status>|<EJNo>|<FirstZNo>|<FirstReceiptNo>|<LastZNo>|<LastReceiptNo>|<TotalEJLine>|<UsedEJLine>

Used to retrieve the contents of the last printed report.

Return value:

 <ErrCode>|<Status>|<DocumentNo>|<ZNo>|<ReportContent>

Used to receive an EJcopy of other documents (invoice, return document and self-employment invoice) between two dates.

Parameters:

Return value:

 <ErrCode>|<Status>|<DocumentNo>|<ZNo>

It is used to receive an EJcopy of other documents (invoice, return document, self-employment invoice).

Parameters:

Return value:

 <ErrCode>|<Status>|<DocumentNo>|<ZNo>

Gives information about printer status. Sales application can learn ECR state or blocking error reason with this function. This function can only use getting status, cannot do any fiscal operation.

Return value:

<ErrCode>|<Status>|<Date>|<Time>|NULL|NULL|NULL|NULL|NULL

Signs in cashier

Parameters:

Return value:

<ErrCode>|<Status>|NULL|NULL|<CashierName>|NULL|NULL|NULL<AuthorizationLvl>

Default Cashier:

Errors:

To check cashier's password and gets unsuccessful login attempt. Unsuccessful login attempt count is five per a day. If cashier exceed this count, cashier is blocked for 24 hours.

Parameters:

Return value:

<ErrCode>|<Status>|NULL|NULL|<KasiyerID>|NULL|NULL| <IncorrectLoginCount>| <AuthorizationLvl>|

Errors:

Makes inflow cash to cash register

Parameters:

Return value:

<ErrCode>|<Status>|NULL|NULL|NULL|<Amount>|NULL|NULL|NULL|

Errors:

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Makes outflow cash from cash register

Parameters:

Return value:

<ErrCode>|<Status>|NULL|NULL|NULL|<Amount>|NULL|NULL|NULL|

Errors:

It has the same properties as the previous method, the only difference is the parameter which has int value instead of the decimal.

Start matching with ECR

Connected connection object must belong to;

System.IO.Ports.SerialPort

or

System.Net.Sockets.Socket classes.

DeviceInfo class is accessible on Hugin.Common DLL class library.

Parameters:

Return value:

true if matching done successfully

Gets drawer info from ECR

Return value:

 <ErrCode>|<Status>|<TotalDocumentCount>|<TotalAmount>|<FiscalReceiptCount>| <FiscalReceiptTotalAmount>|<VoidedDocumentCount>|<VoidedAmount>|<DiscountTotalAmount>|<CashInId>|<CashInCount>|<CashInAmount>|<CashOutId>|<CashOutCount>|<CashOutAmount>|<PaymentType>|<Index>|<Amount>

Repeaitive Payments Block:

<PaymentType>|<Index>|<Amount>

Gets information about last printed document.

Parameters:

Return value:

 <ErrCode>|<Status>|<DocumentId>|<ZNo>|<EJNo>|<DocumentType>| <DocumentDate>| <DocumentTime>

Try to cancel printing report. Some reports support this function.

Return value:

<ErrCode>|<Status>

Opens drawer.

Return value:

<ErrCode>|<Status>

Starts non-fiscal receipt. Used for free text reports or documents.

Return value:

<ErrCode>|<Status>

Errors:

Writes comment lines to non-fiscal receipt

Parameters:

Return value:

<ErrCode>|<Status>

Closes non-fiscal receipt

Return value:

<ErrCode>|<Status>

Gets last log info on ECR

Return value:

<Command>|<SequenceNo>|<FPUState>|<ErrorCode>|<ErrorMessage>

Gets connected ECR version info.

Retrun value:

<VersionInfo>

Returns current static CompactPrinter instance. If printer instance is null, creates new instance.

You have to set printer fiscal serial info before calling Connect method. Get and Set accesors already exists in this property.

Returns true if external device model is Vx675.

You can set or get library logging directory with this property.

NOTE : In Java Library, this property equals to "SetDebugFolder(string path)"

Provides you to set the log level. There are 6 log levels.

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

NOTE: In Java Library, it equals to "SetDebugLevel(int level)"

Gets current library assembly version info.

Gets supported buffer size info by library serial port or TCP/IP connection.