EpsonFp2 Active X / OCX Control Development Guide

 

 

 

 

 

 

 


 

EPSON ITALIA S.p.A.

EpsonFp2 Active X OCX Control for Epson Fiscal Printers

 

Control Name: EpsonFP2.EpsonFPControl

  Notes

(1) All rights reserved.

(2) Reproduction of any part of this documentation by any means is prohibited, in whatever form, without explicit written permission from Epson.

(3) The contents of this documentation are subject to change without notice.

(4) Comments and notification of any mistakes in this documentation are gratefully accepted.

(5) This software cannot be used with other equipment that the specified.

(6) EPSON will not be responsible for any consequences resulting from the use of any information in this documentation.

Trademarks

(1) EPSON® and ESC/POS® are registered trademarks of SEIKO EPSON CORPORATION.

(2) Other product and company names used herein are for identification purposes only and may be trademarks or registered trademarks of their respective companies.

(3) Other trademarks and trade names are those of their respective owners.

Copyright © 2023 SEIKO EPSON CORPORATION
Copyright © 2023 Epson Italia S.p.A.

Epson Italia S.p.A.
Via Margherita Viganò De Vizzi, n. 93/95
20092 Cinisello Balsamo (MI)
Italy


Revision History

 

Driver Version

Doc Rev

Sections

Comments

Date

Author

6.1.0

1

All Document completely rewritten. 1st Dec 2021 Philip Barnett
6.1.0

1.1

Various LastMFsw property description updated to include status.
Bad links corrected.
EpsonFpSuite Release Notes updated to 3.2.0.
4th Feb 2022 Philip Barnett
6.1.0

1.2

Contents EpsonFpSuite Release Notes updated to 3.2.1. 8th Feb 2022 Philip Barnett
6.2.0

1.3

All

readEmissionModeAndEReceiptTransmissionStatus:
    LastNumberOfOldEReceiptFiles incorrectly named property replaced by LastNumberOfSentEReceiptFiles.
Added DGFE_ONLY_ELECTRONIC_PAYMENT entry to enumTipologiaScontrinoDGFE enumerator.
Added opReadTotaleFinanziarioRepartoResi and opReadTotaleFinanziarioRepartoAnnulli methods. Updated associated arguments and properties plus added new indexes 86 and 87 to Daily/Historical Totalisers Table.
Added sendElectronicPayOfflineTransDetails method and enum_EPS_TRANS_CODE_TYPE enumerator.
Bad and missing links corrected.
EpsonFpSuite Release Notes updated to 3.3.0.

21st Sep 2022 Philip Barnett
7.0.0

2.0

All enum_EPS_EREC_CUSTOMER_ID_TYPE:
    Added new ANONYMOUS_LOCAL_UUID entry (value 5)
enum_EPS_URL_TYPE:
    Added the following values:
        URL_E_RECEIPT_SERVER_OBFUSCATED = 9
        URL_TAX_AUTHORITY_EVENTS = 10
        URL_TAX_AUTHORITY_ACTIVATIONS = 11
        URL_TAX_AUTHORITY_REGISTRATIONS = 12
        URL_TAX_AUTHORITY_DAILY_TAKINGS = 13
        URL_TAX_AUTHORITY_LOTTERY = 14
enum_EPS_URL_AUTH_TYPE:
    Added new AUTH_E_RECEIPT_SERVER_OBFUSCATED entry (value 59)
Updated readLotteryQueueAndTransmissionStatus with new RequestType "01" value.
Extended LastRequestType function.
Added progWebServerConfigurationExt2 based on progWebServerConfigurationExt but with new corsOrigin argument.
Added the following new methods:
       progInstantLotteryActivationDate and readInstantLotteryActivationDate
       progLotteryParticipationCriteria and readLotteryParticipationCriteria
Added the following new properties:
       contentReadingMultiMode (opReadDGFEByNumbers and Get_PrintEJDataByNumbers). Allows multiple frame reading mode which speeds up content reading from MPD (DGFE).
       LastCorsOriginSupported and LastCorsOrigin (readWebServerConfiguration method)
       LastNumRemainingCodes (readLotteryQueueAndTransmissionStatus)
       LastInstantLotteryVersion (readLotteryQueueAndTransmissionStatus)
       LastLastCodesRequestResult (readLotteryQueueAndTransmissionStatus)
       LastLastCodesRequestSubError (readLotteryQueueAndTransmissionStatus)
       LastLotteryThresholdAmount (readLotteryParticipationCriteria)
       LastCashPaymentLotteryRule (readLotteryParticipationCriteria)
       LastChequePaymentLotteryRule (readLotteryParticipationCriteria)
       LastElectronicPaymentLotteryRule (readLotteryParticipationCriteria)
       LastTicketPaymentLotteryRule (readLotteryParticipationCriteria)
       LastNotPaidPaymentLotteryRule (readLotteryParticipationCriteria)
       LastPayDiscountLotteryRule (readLotteryParticipationCriteria)
       LastPersonalTaxCodeLotteryRule (readLotteryParticipationCriteria)
       LastBusinessTaxCodeLotteryRule (readLotteryParticipationCriteria)
Expanded EpsonFp2 Configuration Tool section.
EpsonFpSuite Release Notes updated to 4.0.0.
9th Jun 2023 Philip Barnett
7.2.0

2.1

Various readLotteryQueueAndTransmissionStatus updated to include date properties when RequestType = "01".
contentReadingMultiMode extended to include QueryContentByNumbers.
EpsonFpSuite Release Notes updated to 4.2.0.
4th Jul 2023 Philip Barnett
7.3.0

2.2

Various Added URL_TAX_AUTHORITY_INST_LOTT_CODES entry to enum_EPS_URL_TYPE.
Removed progLotteryParticipationCriteria and readLotteryParticipationCriteria method and property information. Removed associated specific arguments.
Added OP_ERR_EXTENDEDLOTTERYLICENSENOTFOUND error.
Added new ExtendedLotteryLicense and ExtendedLicenseLottery properties.
EpsonFpSuite Release Notes updated to 4.3.0.
26th Jul 2023 Philip Barnett

 


Contents

 


Overview

 

This document describes the EpsonFp2 control architecture, properties and methods developed for Epson fiscal printers.

EpsonFp2 can be used in all environments capable of managing COM (Microsoft Corporation Component Object Model) standard interfaces. This is true right up to the present day with the Windows 10 operating system.

 


Related Documents

 


Control Architecture

 

The control operates in a synchronous way in that the application program (that makes use of it) must wait until the control closes the communication with the printer (receives a reply or times-out) before continuing.

The value or values returned from the fiscal printer to a command can be ascertained by reading properties that have the "Last" prefix. These properties are cleared prior to the subsequent method call.

Historically, methods relating to the fiscal printer used the "op" prefix. However, alias names that adhere to the UPOS standard can also be used to perform the same function. The "op" prefix is also omitted in some other methods. Generally, each method relates to a particular Epson fiscal protocol command that is transmitted to the fiscal printer.

Method input arguments (parameters) are defined with the following types:

·         String: Used for all descriptions and alphanumeric values. See Appendix C in Communication Protocol document for printer character set.

·         Integer: Used for all values up to 32767.

·         Long: Used for all values up to 2147483647.

·         Single (Short): Used for all decimal values but not used in foreign exchange rates.

·         Double: Used in foreign exchange rates. EpsonFp2 manages international operating system settings to enable it to distinguish between the differing decimal separators.

·         Currency: Used for all money related values and other large amounts. EpsonFp2 takes into account international operating system settings to enable it to distinguish between the differing decimal separators.

·         Date as Variant: Used for the date. Specific units (day, year etc.) are expressed as integers.

Regarding Currency, EpsonFp2 automatically formats the native command field sent to the printer. Historically, this was done using the EuroSettings property. However, this is now set to euro by default as the Lire setting is no longer valid.

EpsonFp2 manages communication retries (two). If an error occurs, the specific error code is returned. Retry handling can be personalised (see retryMode further down in this section).

 

 


EpsonFp2 Configuration Tool

 

The EpsonFpSuite installer includes the EpsonFp2Config tool. This tool can be used to program certain library functions. It can also optionally be used to set the communication parameters and in doing so will override any properties such as COMM_Modality and RemotePrinterIPAddress set by a retail application. This option should only be used if EpsonFp2 manages a single fiscal printer. Parameters set in this tool are saved in a file called EpsonFp2Config.xml which usually resides in the following directory:

Upon launching the tool, the operator is always asked to choose between Italian and English. The answer only relates to the configuration tool and does not affect the behaviour of the library itself. The language can later be switched whilst the tool is open (via the appropriate radio buttons) without the need to re-launch it. The "Communication Setup" checkbox allows the developer to choose from two modes as follows:

 

Epson strongly recommends activating the Trace Log function. Two trace log files are created:

Optionally, these files can be automatically deleted periodically when deemed old. In this case, two criteria can be personalised:

 

Files are deleted firstly by date and then by count. The routine is launched differently for Log and Trace files as follows:

From version 6.0.0, onwards, a custom attribute called retryMode can be optionally inserted in the communication tab. This can only be done modifying the EpsonFp2Config.xml file by hand using a text editor. Three retry modes can be set:

This parameter should only be changed if an issue is thought to be related to mode 2. Please use modes 0 and 1 with caution. Retry mode 2 is set when the attribute is not present.

From version 6.2.0 onwards, a custom attribute called TCPSockRXBuffInitialEmptyingMode can be optionally inserted in the communication tab. This can only be done modifying the EpsonFp2Config.xml file by hand using a text editor. Two TCP buffer emptying modes can be set:

By setting Standard mode, the TCP connection time can be reduced. Please use this mode with caution. Secure mode is set when the attribute is not present.

 


 Commercial Document Sample

 

The following sample is also in the Communication Protocol document.

 

LOGO: (max 256KB) printable as a header or footer. In this example it relates to the HEADER GRAFICO setting (opProgConf where ConfIdx = 9). ConfValue would be from 1 to 9 as zero deactivates printing.

 

RETAIL HEADER: Printed automatically (max 16 lines) whenever a commercial document is opened via:

  - opApriScontrinoFiscale or opAddRowDesc where RowType = 4

  - Any sale, refund, storno, modifier method (e.g. opRepartoLight)

  - Certain discount or surcharge methods (opValMinusLight)

Also whenever a management document is opened via opIniSNoFisc.

 

ADDITIONAL HEADER ROWS: Preloaded using opAddRowDesc method where RowType = 1. Must be called before doc opening, first transaction or any free text in doc body.

 

FIXED LINES: Automatically generated by the printer.

 

SALE: opRepartoLight. In this case the specified DepartmentCode has been previously programmed with the ESENTE nature (VAT 0%).

 
SALE: opRepartoLight with Quantity different from 1. Specified DepartmentCode has been previously programmed with 22% VAT.

 

REFUND: opRepartoResoLight method misused when returning a product. Converted to storno automatically in a sale document by the fiscal firmware.

 
VOID: opCorr method used to cancel last transaction.
 
STORNO: opRepartoStornoLight method used to cancel a previous sale.

 

DISCOUNT: opValMinusLight method. Based on either the last sale, the subtotal or a specific department according to AdjustmentKind.

 
BODY LINES: opAddRowDesc where RowType = 4.
 

SUBTOTAL: opStampaVisSubtotale used to print, display and read the subtotal

 

DOCUMENT TOTAL AND VAT: Automatically generated by the printer.

 

PAYMENT TOTALS AND CHANGE: Fixed lines based on opPaymentLight payments. Change calculated automatically by the printer. Sufficient payment closes the doc (if JAVAPOS-UPOS mode is deactivated - See opProgFlag where FlagIdx = 29 and FlagValue = 0). Importo pagato always printed and others only if non-zero. This is also true of change.

 

NATURE DESCRIPTION: Automatically generated by the printer.

 

DATE AND TIME AND DOCUMENT NUMBER: Automatically generated by the printer.

 

PERSONAL TAX CODE: opCodFiscale for chemist "parlanti" docs. Space also reserved for opCodLotteria national lottery code and opPartitaIVA business tax code but only one of the three codes can be present in a single doc.

 
PRINTER RT SERIAL NUMBER: Automatically generated by the printer.
 
PAYMENT BREAKDOWN: Optional. When using opProgFlag where FlagIdx = 57 and FlagValue = 1, a line is printed for each opPaymentLight call.

 

ITEM COUNT: Optional. Printed automatically when using opProgFlag where FlagIdx = 8 and FlagValue = 1.
 
TRAILER LINES: opAddRowDesc where RowType = 2.
 

TILL NUMBER: Optional. Printed automatically when using opProgConf where ConfIdx = 15 and ConfValue >0.

 

OPERATOR NUM AND NAME: Would be present in the following case: When using opProgFlag twice where FlagIdx = 4 and FlagIdx = 7 and both had FlagValue = 1.

 

PROMO LINES: opAddRowDesc where RowType = 3.

 

BARCODE OR QR CODE: opPrintBarCodeExtended or opPrintQRCode (single barcode or QR code only and sent before payment).

 

LOGO: (max 256KB) printable as a header or footer. In this example it relates to the FOOTER GRAFICO setting (opProgConf where ConfIdx = 10). ConfValue would be from 1 to 9 as zero deactivates printing.

 

COUPON: Printed either from a file residing in the www/graphic directory or via reserved methods.

 


Methods

 

Methods are grouped into System Methods, Connection Methods and Fiscal Protocol Methods chapters. Fiscal Protocol Methods are presented in native fiscal command numerical order. Any aliases are mentioned in the primary method rather than duplicating the entire method description. If the method has arguments, they are described. Optional arguments can be identified with the Optional keyword. Arguments are also described in the Method Arguments chapter (with the exception of obsolete and displaced ones). Shortcuts allow direct navigation to the specific argument. Nearly all methods can generate the standard return values such as OP_OK, OP_ERR_ACKTIMEOUT, OP_ERR_PORTCLOSE, EERR etc so these are not repeated for each method. Only method specific return values are mentioned, such as OP_ERR_EXTENDEDRTLICENSENOTFOUND. Likewise with properties, OCXBusy is nearly always set to True whilst a method call is in progress and LastTimeoutACK and LastTimeoutOP are set to either the method specific default values or the optional preset personalised TimeoutACK and TimeoutOP values.

 


System Methods

 

Connection Methods

 

If EpsonFp2Config is NOT used for communication settings, the principle connection method is specified by the COMM_Modality property. There are three settings:

If EpsonFp2Config is used for communication settings, TCPConnTimeOut is the only communication property that can be modified by the software application.

 

 


Fiscal Protocol Methods

 

Methods are ordered numerically by native fiscal command. Includes obsolete and displaced commands. Arguments in obsolete or displaced methods are not described unless the same name is used with a current method.

 

 

 

 

 

Fiscal commands 1006, 1007 and 1008 have no associated methods. 1006 and 1007 are obsolete and 1008 has been displaced by opRepartoLight alias PrintRecItem.

 

 

 

Fiscal commands 1012, 1013 and 1014 have no associated methods. 1012 and 1013 are obsolete and 1014 has been displaced by opRepartoResoLight alias PrintRecRefund.

 

 

 

 

 

 

 

 

 

 

 

Fiscal command 1029 has no associated method. It is however obsolete.

 

 

 

 

 

 

 

 

1037 native fiscal command has no associated method.

 

 

 

 

 

 

 

 

 

1049 native fiscal command does not exist.

 

 

 

 

 

 

 

 

1059 native fiscal command does not exist

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

    1105 to 1107 native fiscal commands do not exist.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

2008 native fiscal command has no associated method.

 

 

 

 

 

2013 native fiscal command does not exist.

 

 

2016 to 2019 native fiscal commands do not exist.

 

 

2021 to 2049 native fiscal commands do not exist.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

2054 to 2059 native fiscal commands have no associated methods.

 

 

 

 

3003 native fiscal command has no associated method.

 

 

 

3008 native fiscal command has no associated method.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

3106 to 3215 native fiscal commands do not exist.

 

 

 

 

 

 

 

 

 

4004 native fiscal command has no associated method.

 

 

 

 

 

 

 

4011 native fiscal command has no associated method.

 

 

 

 

 

 

4017 and 4018 native fiscal commands have no associated methods.

 

 

 

4021 native fiscal command does not exist

 

 

4023 and 4024 native fiscal commands do not exist.

 

 

 

 

 

 

 

4030 native fiscal command does not exist.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

4035 native fiscal command does not exist.

 

 

 

       4041 native fiscal command is subject to NDA.

4042 to 4052 native fiscal commands do not exist.

 

4054 native fiscal command does not exist.

 

 

4056 and 4057 native fiscal commands do not exist.

4058 native fiscal command is reserved.

 

 

4061 to 4069 native fiscal commands do not exist.

 

 

 

 

 

 

4204 native fiscal command has no associated method.

 

 

 

 

 

 

4211 native fiscal command has no associated method.

 

 

 

 

 

 

4217 and 4218 native fiscal commands have no associated method.

 

 

4220 to 4224 native fiscal commands do not exist.

 

 

 

 

 

4230 native fiscal command does not exist.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

4235 native fiscal command does not exist.

 

 

4242 to 4252 native fiscal commands do not exist.

 

 

 

4256 and 4257 native fiscal commands do not exist.

4258 native fiscal command is reserved.

4259 native fiscal command does not exist.

 

 

 

 

4272 native fiscal command does not exist.

 

4296 to 4299 native fiscal commands do not exist.

 

 

9001 native fiscal command does not exist.

9002 native fiscal command is subject to NDA.

 

 

9005 and 9006 native fiscal commands do not exist.

9007 native fiscal command is progCAAECertificateURL.

9008 native fiscal command is downloadCAAECertificate.

9009 native fiscal command has no associated method.

9010 and 9011 native fiscal commands are subject to NDA.

 

 

 

9017 and 9018 native fiscal commands do not exist.

 

 

 

9206 native fiscal command does not exist.

9207 native fiscal command is readCAAECertificateURL.

9208 native fiscal command does not exist.

9209 native fiscal command has no associated method.

9210 native fiscal command is subject to NDA.

9211 native fiscal command does not exist.

 

 

9214 native fiscal command is subject to NDA.

9215 and 9216 native fiscal commands do not exist.

 

 

 


Special Methods

 

RT Methods

The following are special RT methods.

 

 

 

 

 

 

 

 

 

 

 

 


Box Office Tickets Methods

 

Used with the box office tickets function. Known as biglietto spettacolo or titolo d'accesso in Italy. It has nothing to do with ticket (voucher) payments. All the following box office methods are subject to NDA. ExtendedLicenseTicketing  ExtendedTicketingLicense must be set otherwise OP_ERR_EXTENDEDTICKETINGLICENSENOTFOUND is returned. Further information available on request.

 

 


Other Special Methods

 

 

 

 

 

 

 

 

 

 


Epson Reserved Methods

 

 

 

 


Fiscal Protocol Method Groupings

 

The following groupings can be used to understand which methods to utilise. The four digit reference is the fiscal protocol native command. Obsolete or displaced methods are not included.

 

Commercial Document Emission (Documento Commerciale)

 

Commercial Document Sale, Void (Storno), Modifier and Adjustment (Discount and Surcharge) Operations

 

Payments and Cash Management

 

Foreign Currency Payments and Cash Management

For information only as multiple currencies are usually handled by retail applications nowadays.

 

Subtotal

 

Management Document Emission (Documento Gestionale)

 

Invoice Emission (Fatture)

Free invoices are no longer supported in fiscal firmware.

 

Additional Text (Fiscal/Non-fiscal/Display) and Barcode / QR Code Printing

 

Electronic Journal (DGFE / MPD) and Fiscal Memory (MF / MPR)

 

X Reports 

 

Z Reports

 

Edit and Set

 

Read

 

Ethernet and Email

 

Others

 


Obsolete System Methods

 


Obsolete Connection Methods

 

Because fiscal protocol methods are listed in fiscal command numerical order, obsolete Italian fiscal protocol, obsolete International fiscal protocol and displaced methods are included in the main list.

 


Method Arguments

 

Obsolete method arguments are not listed. Displaced methods are not mentioned. Arguments are listed in alphabetical order.

 

activationDeactivationMode (EFT-POS activation and mode)

 

AdditionalHeaderLocation (Invoice additional header location)

 

AdjustmentAmount (Discount, surcharge or modifier amount)

 

AdjustmentKind (Discount, surcharge or modifier type)

 

Amount (transaction amount)

 

ATECO_Code (Six digit ATECO code)

 

ATECOIndex (Department ATECO handling)

 

AutoZReportMode (Enable or disable automatic Z report plus set the mode)

 

backgroundProgramEnabled (Enable or disable background program)

 

backgroundProgramScriptName (Filename)

 

Barcode or BarcodePLU (Barcode string)

 

BarcodeType

 

BeepCycles (Number of desired printer buzzer beep cycles)

 

BeepFrequency (Printer buzzer desired frequency)

 

BeepLength (Printer buzzer desired pulse length)

 

BusinessTaxCode (Customer business VAT number)

 

BusinessTaxId (Customer business VAT number)

 

CAAECertificateURL

 

CatNumber (Product group number - Merceologico)

 

CodiceFiscale (Customer personal Fiscal code) (aliases PersonalTaxCode and PersonalTaxId)

 

CodiceLotteria (Customer National Lottery code) (aliases LotteryCode and LotteryId)

 

CodOprSegr (Operator password)

 

codPLU / CodePLU (PLU number)

 

communicationInterface (POS terminal connection interface)

 

ConfIdx (Parameter number)

 

ConfValue (Value to be assigned to the selected parameter)

 

connectivityTestRequested (one of three connectivity tests)

 

CounterType (Management of printer maintenance counters)

 

corsOrigin

 

CurrencyAmount (Foreign Currency Amount)

 

CurrencyChangeRate (Foreign Currency exchange rate)

 

CurrencyCode (Foreign Currency Code)

 

CursorPosition (Cursor position for display)

 

CustomerIDType

 

CustomerID

 

DataType (QR code data type)

 

dateDD (Day of the month)

 

dateMM (Month)

 

dateYY (Year)

 

dateYYYY (Year)

 

DDEnd (End day)

 

DDNOptions (For future use)

 

DDNPrefix (Barcode reader prefix)

 

DDNProgramName (Filename)

 

DDNSuffix (Barcode reader suffix)

 

DDStart (Start day or day)

 

DepartmentCode (Department number)

 

DepartmentMode

 

departmentOffsetMode

 

Description

 

Description20

 

Description32

 

destAddressSelection

 

DescValuta

 

Direction

 

DisplayType

 

DocumentEmissionTypes

 

DocumentEmissionValidity

 

DocumentKind (for future use)

 

DocumentType

 

EjContentFile (Path and filename)

 

emailAddress (Recipient)

 

emailParameter (e-mail parameter number)

 

emailParameterValue

 

EnableDisable

 

EndFiscalDocumentNumber

 

EndNumber

 

EndZReportNumber

 

ErrorCode

 

ErrorLevel

 

ErrorCorrection

 

ExportDataSource

 

ExportDestination

 

ExportMode

 

FileFormat (Export file format)

 

Filename

 

FirstRead (First or next row flag)

 

FiscalDocumentNumber

 

FlagIdx (Flag number)

 

FlagValue

 

FolderType (Rejected file type to archive)

 

FPMateUpdateEnabled

 

FullFilePath (Complete full path filename)

 

GoodsTypologyCollection (Product group)

 

graphicFileMode

 

handleSocket

 

HeaderRowIndex (Retail header line number)

 

Height (Barcode height)

 

HorizontalPosition (QR code horizontal position)

 

HRI

 

HRIF

 

Importo

 

ImportoAssegno

 

Index (Multiple uses)

 

IndexPayment (Payment sub-type or number of tickets (vouchers)

 

InputString

 

intelligentCategory (Intelligent parameter category)

 

intelligentIndex (Intelligent parameter index)

 

intelligentParameterValue

 

invoiceNumber

 

invoiceNumberExtension (Optional invoice number prefix or suffix)

 

invoiceNumberExtensionPosition (Enable or disable invoice number prefix or suffix)

 

IpVersion

 

lanParameter (LAN / Wi-Fi parameter number)

 

lanParameterValue (Depends on lanParameter)

 

logoIndex

 

LotteryCode (Customer National Lottery code)

 

LotteryId (Customer National Lottery code)

 

MeasureUnit (for invoices)

 

MMEnd (End month)

 

MMStart (Start month or month)

 

ModifierType

 

NaturaDesc

 

NaturaPrintSymbol

 

NaturaTXSymbol

 

NCartaCC

 

NContante (Cash index number)

 

NotPaidCounterType

 

NotUsed

 

NPluKey

 

NTipoTicket

 

number

 

numberOfCopies (EFT-POS print-out copies)

 

Numero

 

NumNatura (Nature number)

 

OperationType

 

OperatorCode (Operator ID number)

 

OutputType (Export output media)

 

paperCutMode

 

ParameterValue (Local access)

 

PartitaIVA (Customer business VAT number) (aliases BusinessTaxCode and BusinessTaxId)

 

Password

 

Percentage

 

Period (Time interval in financial data reading requests)

 

personalisedOffsetMultiple

 

PersonalTaxCode (Customer personal Fiscal code)

 

PersonalTaxId (Customer personal Fiscal code)

 

PHPEnabled (Enable or disable PHP)

 

PHPScriptName

 

PHPScriptType

 

Position

 

POS_IPaddress (POS TCP/IP address)

 

POS_TCPPortNumber (POS TCP port)

 

POS_TerminalID (POS terminal numeric ID)

 

Price

 

Price1, Price2 and Price3
 

 

PriceLimit

 

PrintDevice

 

PrintHeader

 

PrintMode

 

PrintoutGroup

 

PrintX01FinancialReport

 

PS2Function

 

PS2Key

 

QRCodeData

 

QRCodeType

 

Quantity (Quantity or tare)

 

receiptJSONEnabled

 

ReceiptType (Kind of document to be collected from the EJ)

 

RegisterID

 

requestType

 

RequiredOperator (Operator Id number)

 

ResetCounter

 

RowFont

 

RowIndex

 

RowText (Text to print)

 

RowType

 

RTFiscalSerialNumber11

 

SalesType (Goods or services)

 

sambaEnabled (Enable or disable Samba)

 

SingleItem

 

Size

Spare

 

spareString

 

StartFiscalDocumentNumber

 

StartNumber (First commercial document or invoice number)

 

StartZReportNumber

 

TaxCounterType

 

TaxExemptionDescription

 

Text

 

TextAlignment

 

TicketEnd

 

TicketNumber

 

TicketStart

 

TillId (RT Server only)

 

timeHH (Hour)

 

timeMM (Minute)

 

TimeOut

 

timeSS (Second)

 

TipoCarta (Paper source)

 

TotalNumberOfLines

 

TotalNumberOfHeaderLines

 

TrailerLineDescription

 

TrailerLineNumber

 

TransCode

 

TransCodeType

 

TypeBarcode

 

TypePayment

 

TypePrint (opStampaVisSubtotale and PrintRecSubtotal)

 

URL

 

Username

 

ValoreTicket

 

VatCode (VAT or nature group number or Ventilazione mode)

 

VatPercentage

 

VatPercentageX (Nine discreet arguments where X ranges from 1 to 9)

 

Ventilazione (Enable or disable Ventilazione fiscal regime)

 

VentilazionVATColumnPrintMode (Only PRINT VI currently supported)

 

webApplicationEnabled

 

WebAppMemType

 

webServerPassword

 

webServerSSLMode

 

webServerUserID

 

webSocketMode

 

Width (Width of the barcode)

 

YYEnd (End year)

 

YYStart (Start year)

 

YYYYEnd (End year)

 

YYYYStart (Start year)

 

ZRepEnd

 

ZReportNumber

 

ZRepStart

 


Method Return Values

 

Return values are set to one of the enumEPS_OP_RETVALUE enumerator values.

Positive Return Value

Name

Value

Description

OP_OK 0 Method completed successfully

 

Erroneous Return Values

Name

Value

GetLastErrorDescription
Text

Description

EERR -1 Depends on printer error

(see Printer Errors Table)

The error was generated by the fiscal printer. The communication between the PC and the fiscal printer ran normally but the printer reply frame indicated a fiscal printer error or warning condition. The table below illustrates the different types of errors and warnings. The LastEERR property can be checked to determine which specific printer error or warning code has been received.

OP_ERR_NOCOLL 1 Registratore non collegato Fiscal printer is not connected to the computer. No responses have been received at all. This could be due to a serial RS-232 port settings mismatch or incorrect TCP/IP address/port for example. Check settings and connectivity with EpsonFp2Config utility. Check the fiscal printer communication settings using the attached keyboard according to the "Epson Serie FP Manuale Operatore" document.

OP_ERR_PORTCLOSE

2 Porta non aperta Communication port cannot be OPENED. Check that no other software applications are connected to the same port (EpsonFpWizard for example). If using TCP/IP, check IP address and port.

This error when generated after a call with the opProgLogoGrafico method behaves differently. The return value is set to EERR and LastEERR property is instead set to this value.

OP_ERR_TIMEOUT 3 Timeout in attesa risposta The timeout for receiving the complete reply from the printer has expired (ACK (if flag SET14/27 = 1) + STX ... ETX)
OP_ERR_CHKS 4 Checksum errato A frame with an incorrect checksum was received. If using the RS-232 serial port, try reducing the BAUD rate.
OP_ERR_EUROLOCK 5 Modalità Euro/Lire non impostata Obsolete. The EuroSettings property is set to EPS_EUROSETTINGS_UNKNOWN
OP_ERR_FILENOTFOUND 6 File not found In this case, the return value is set to EERR and LastEERR property is set to this value.
Graphic file was not found. Only used with opProgLogoGrafico method.
OP_ERR_ACKTIMEOUT 7 Timeout in attesa di ACK The printer did not reply within the timeout period.
OP_ERR_STXTIMEOUT 8 Timeout in attesa di STX The printer only received an ACK (only relevant if flag SET 14/27 = 1). The reply is incomplete.
OP_ERR_OCXBUSY 9 OCX busy A method call has been executed before the previous one has been completed. The reply from the printer has not yet arrived. The method call can be reattempted after a timeout. Please bear in mind that the original transmission may have arrived at the printer so in the case of a sale for example, a retransmission could incorrectly print the sale twice. Therefore, it is advised in situations such as in the middle of a commercial document, to use mechanisms such as checking the subtotal before deciding whether or not to retry.
OP_ERR_EXTENDEDGRAPHICLICENSENOTFOUND 10 Extended graphic licence not found

ExtendedGraphicLicense or ExtendedLicenseGraphic property not set or set incorrectly.

OP_ERR_EXTENDEDTICKETINGLICENSENOTFOUND 11 Extended ticketing licence not found

ExtendedTicketingLicense or ExtendedLicenseTicketing property not set or set incorrectly.

OP_ERR_CREATESOCKETFAILED 12 Create socket failed TCP/IP connection failed whilst EpsonFp2 was attempting to create a socket. This can occur is no network interface is present on the computer.
OP_ERR_TCPCONNFAILED 13 Registratore non collegato Attempt to open a TCP-IP connection failed.
OP_ERR_RECEIVE_TIMEOUT 14 Receive timeout Obsolete. Not used.
OP_ERR_RECEIVE_NODATA 15 No data Obsolete. Not used.
OP_ERR_EXTENDEDPROGRAMMINGLICENSENOTFOUND 16 Extended programming licence not found Reserved for Epson. ExtendedProgrammingLicense or ExtendedProgrammingLicense property not set or set incorrectly.
OP_ERR_USBCONNFAILED 17 Registratore non collegato An attempt to open a USB connection failed.
OP_ERR_MULTI_COMMAND_SEQUENCE_FAILURE 18 Multi command sequence failure One or more intelligent parameters programming generated an error.
OP_ERR_EXTENDEDRTLICENSENOTFOUND 19 Extended RT licence not found ExtendedRTLicense or ExtendedLicenseRT property not set or set incorrectly.
OP_ERR_DEPRECATED_METHOD 20 Deprecated method no longer valid Obsolete method called.
OP_ERR_INVALID_ARGUMENT_VALUE 21 At least one argument value passed to method is erroneous Input argument value invalid or out of range.
OP_ERR_EJ_QUERY 22 EJ / DGFE / MPD Query Error Windows file error (check permissions). Used with:
OP_ERR_EXTENDEDFWREGLICENSENOTFOUND 23 Extended firmware license not found ExtendedFWRegLicense or ExtendedLicenseFWReg property not set or set incorrectly.
OP_ERR_EXTENDEDLOTTERYLICENSENOTFOUND 24 Extended lottery license not found ExtendedLotteryLicense or ExtendedLicenseLottery property not set or set incorrectly.

 

If the return value is -1 (EERR), the error was generated by the printer. In this case, the LastEERR property is set to one of the enumEPS_INT_ERR enumerator values indicated in the table below. One exception is OP_ERR_FILENOTFOUND which is not generated by the printer. In the other above cases, LastEERR has no significance and remains at the default -2 value.


Printer Errors

Name

Value

GetLastErrorDescription
Text

Description

EERR_CARTA_GIORNALE 1 CARTA GIORNALE Obsolete. Journal paper low.
EERR_CARTA_SCONTRINO 2 Rotolo Carta in Esaurimento. Paper low.
EERR_OFFLINE 3 Errore 3 - Stampante Offline (Senza Carta o Coperchio Aperto). Printer offline. Paper out or paper cover open.
EERR_ERR_04 4 ERRORE 04 Not used.
EERR_ERR_05 5 ERRORE 05 Not used.
EERR_ERR_06 6 ERRORE 06 Not used.
OP_ERR_FILENOTFOUND 6 File not found Graphic file was not found. Only used with opProgLogoGrafico method. Not generated by the printer.
EERR_SLIP_KO 7 Errore 7 - Slip Guasta. Slip printer not connected or not working.
EERR_TASTO_ERRATO 8 Errore 8 - Tasto Errato. Incorrect key pressed.
EERR_DATA_INFERIORE 9 Errore 9 - Data Inferiore. The date sent is earlier than an expected value. It is not permitted to set a date prior to the date of the last daily closure.
EERR_DATA_ERRATA 10 Errore 10 - Data Errata. At least one date field is out of range.
EERR_SEQUENZA_ERRATA 11 Errore 11 - Sequenza Errata. Command sequence not allowed. (e.g. an attempt to void an already closed commercial document)
EERR_DATI_INESISTENTI 12 Errore 12 - Dati Inesistenti. Attempt to read or write inexistent data.
EERR_VALORE_ERRATO 13 Errore 13 - Valore Errato. Generic error message. For example, a field value is not permitted.
EERR_PROG_MATRICOLA 14 Errore 14 - Programmazione Matricola Fiscale. The printer has not been configured with the serial number yet. Please contact Epson.
EERR_GIA_ESISTENTE 15 Errore 15 - Dati già Esistenti. Attempt to perform an operation that has already been performed.
EERR_NON_PREVISTO 16 Errore 16 - Non Previsto. Generic error message. A index parameter is not allowed. E.g. Tax id = 85 when the maximum number permissible is 59.
EERR_IMPOSSIBILE_ORA 17 Errore 17 - Impossibile Ora. Generic error message. The operation is not allowed now. E.g. Attempt to program the date and time without having first performed a fiscal closure.
EERR_NON_POSSIBILE 18 Errore 18 - Non Possibile. Generic error message. The operation is not allowed or not possible. E.g. Attempt to refund with an incompatible payment method.
EERR_SCRITTA_INVALIDA 19 Errore 19 - Scritta Invalida. Obsolete. The frame contains the character sequence "TOTALE" or other prohibited text. See Communication Protocol "Prohibited Words in Commercial Documents and Invoices" chapter for details.
EERR_SUPERA_VALORE 20 Errore 20 - Supera Valore. The number of digits of the last input variable (e.g. barcode) is greater than the maximum allowed.
EERR_SUPERA_LIMITE 21 Errore 21 - Supera Limite. The value sent for a variable is out of the permitted range.
EERR_NON_PROGRAMMATO 22 Errore 22 - Non Programmato. The command requires that some parameters must be previously configured.
EERR_CHIUDI_SCONTRINO 23 Errore 23 - Chiudere Scontrino (Fare Pagamento). The maximum number of rows allowed for a commercial document has been reached. It must be closed with a payment or payments.
EERR_CHIUDI_PAGAMENTO 24 Errore 24 - Chiudere il Pagamento. The maximum number of rows allowed for a commercial document and the maximum number of partial payments have been reached. It must be closed with a single payment.
EERR_MANCA_OPERATORE 25 Errore 25 - Manca l'Operatore. No operator has been selected while the printer has been configured to use operators.
EERR_CASSA_INFERIORE 26 Errore 26 - Cassa Inferiore. The amount (cash, cheque, ...) is not enough for the required operation.
EERR_OLTRE_PROGRAMMAZ 27 Errore 27 - Oltre Programmazione Limite Prezzo Reparto. The price (quantity X unit price) is greater than the maximum permitted (programmed) for the department.
EERR_PC_NON_COLLEGATO 28 Errore 28 - Problema connessione PC o Server o Esito Negativo Scontrino Sicuro. Communication or SMTP error.
EERR_MANCA_MODULO 29 Errore 29 - Manca Modulo (SLIP). Slip printer is without paper.
EERR_CHECKSUM_ERRATO 30 Errore 30 - Checksum Errato (Partita IVA, Codice Fiscale o Codice Lotteria). Partita IVA (business tax code), codice fiscale (personal tax code) or lottery code checksum error.
EERR_DATI_INESISTENTI_PC 31 Errore 31 - Dati Inesistenti PC. Obsolete. PC didn't return the required data as it doesn't exist.
EERR_ERR_32 32 ERRORE 32 Not used.
EERR_ERR_33 33 ERRORE 33 Not used.
EERR_MANCA_ATTIVAZIONE 34 Errore 34 - Manca Attivazione. Missing activation. For example, attempt to open an invoice when invoice printing has been deactivated.
EERR_SLIP_CONNESSIONE 35 Errore 35 - Errore connessione SLIP. Slip printer not connected or not working.
EERR_ERR_36 36 ERRORE 36 Not used.
EERR_SLIP_RIMUOVERE_MODULO 37 Errore 37 - Rimuovere modulo dalla SLIP. Indicates form removal. More of an instruction than an error.
EERR_EFT_POS_IN_ERRORE 38 Errore 38 - Errore connessione con EFT-POS o timeout. EFT-POS error.
EERR_DOC_GIA_ANNULLATO 39 Errore 39 - Documento già Annullato. Commercial document already voided.
EERR_DOC_GIA_RESO 40 Errore 40 - Documento già Reso. Commercial document already refunded.
EERR_DOC_RIF_DOC_ANNULLO 41 Errore 41 - Il Documento di riferimento non può essere un Documento di Annullo. Reference document cannot be a void document. It must be a commercial sale document.
EERR_DOC_RIF_DOC_RESO 42 Errore 42 - Il Documento di riferimento non può essere un Documento di Reso. Reference document cannot be a refund document. It must be a commercial sale document.

 


Properties

 

Most properties are read only and are first set to default values just before sending the frame to the printer. Default values mentioned below are property defaults rather than the relative printer parameter default. Properties are usually set only after having received a positive response from the printer. Properties do not usually persist from one method call to the next. Current properties are coloured green whereas obsolete ones are coloured fuchsia.

 


System Properties

 

callingProcessName

 

contentReadingMultiMode

 

Major

 

Minor

 

OCXBusy

 

Revision

 


Connection Properties

 

COMM_Modality

 

COMPort

 

FramePrefix

 

INVALID_SOCKET

 

LastTimeoutACK

 

LastTimeoutOP

 

RemotePrinterIPAddress

 

RemotePrinterIPPortNumber

 

Settings

 

TCPConnTimeOut

 

TimeoutACK

 

TimeoutOP

 

USBAddress

 


Fiscal Protocol Properties

 

LastAA

 

LastAccessControlIndex

 

LastAccessControlParameterValue


LastActivationDeactivationMode

 

LastAliquota

 

LastAliquotaX (Nine discreet properties where X ranges from 1 to 9 - Deferred VAT percentages)

 

LastAmountFromScale

 

LastATECOCode

 

LastATECOIndex

 

LastAutoZReportMode

 

LastBackgroundProgramEnabled

 

LastBackgroundProgramScriptName

 

LastBarcodePLU

 

LastCodOprSegr

 

LastCodPLU

 

LastCommunicationInterface

 

LastConf

 

LastCorsOrigin

 

LastCorsOriginSupported

 

LastCPUsw

 

LastCustomerID

 

LastCustomerIDType

LastDate

 

LastDatePeriodicalCheck

 

LastDatoLetto

 

LastDDNOptions

 

LastDDNPrefix

 

LastDDNProgramName

 

LastDDNSuffix

 

LastDepartmentMode

 

LastDepartmentOffsetMode

 

LastDescCartaCC

 

LastDescCategory

 

LastDescContante

 

LastDescEsenzione

 

LastDescLotteryMessageLine

 

LastDescOpr

 

LastDescPLU

 

LastDescReparto

 

LastDescrMessage

 

LastDescrSuffPrefNumFatture

 

LastDescrSuffPrefNumFatturePos

 

LastDescrRigaIntestazione


LastDescTicket

 

LastDescValuta

 

LastDGFE

 

LastDGFENum

 

LastDGFESize

 

LastDGFEState

 

LastDGFEUtil

 

LastDiskPartitionBytesFree

 

LastDiskPartitionBytesFree2

 

LastDiskPartitionBytesUsed

 

LastDiskPartitionBytesUsed2

 

LastDiskPartitionINodesFree

 

LastDiskPartitionINodesFree2

 

LastDiskPartitionINodesUsed

 

LastDiskPartitionINodesUsed2

 

LastDocumentEmissionTypes

 

LastDocumentEmissionValidity

 

LastDocumentRefundVoidStatus

 

LastEERR

 

LastEFTPOSOutcome

 

LastEmailParameter

 

LastEmailParameterValue

 

LastFiscalDocumentNumber

 

LastFlag

 

LastFPMateUpdateEnabled

 

LastGG

 

LastGranTotale

 

LastGranTotaleDocDiAnnullo

 

LastGranTotaleDocDiReso

 

LastGranTotaleNoteDiCredito

 

LastGraphicFileMode

 

LastGraphicParametersAll

 

LastGruppoStampa

 

LastHH

 

LastImp

 

LastImponibileLetto

 

LastImportoContanteDesc

 

LastImportoValuta

 

LastIndex

 

LastInstantLotteryVersion

 

LastIntelligentCategory

 

LastIntelligentIndex

 

LastIntelligentParameterValue

 

LastInvoiceEndNumber

 

LastInvoiceStartNumber

 

LastIpVersion

 

LastIsPaymentLightGlobal

 

LastItem

 

LastLanParameter

 

LastLanParameterValue


 

LastLastCodesRequestResult

 

LastLastCodesRequestSubError

 

LastLatestZReportDate


 

LastLatestZReportDay

 

LastLatestZReportHour

 

LastLatestZReportMin

 

LastLatestZReportMonth

 

LastLatestZReportNumber

 

LastLatestZReportYear

 

LastLimite

 

LastLogoIndex

 

LastMaintenanceCounterReset

 

LastMaintenanceCounterType

 

LastMaintenanceCounterValue

 

LastMatrFisc

 

LastMatrFiscExtended

 

LastMFsw

 

LastMin

 

LastMM

 

LastModel

 

LastNaturaDesc

 

LastNaturaPrintSymbol

 

LastNaturaTXSymbol

 

LastNCartaCC

 

LastNCategory

 

LastNContanteDesc

 

LastNKey

 

LastNotUsed

String of variable length. Usually for future use.

 

LastNR

 

LastNReparto

 

LastNRepPLU

LastNRigheBiancheFatt

 

LastNRigheFatt

 

LastNS

 

LastNTassa

 

LastNTassaRep

 

LastNTipoTicket

 

LastNum

 

LastNumAzzeramenti

 

LastNumberOfAcceptedLotteryDocuments

 

LastNumberOfCopies

 

LastNumberOfCurrentEReceiptFiles

 

LastNumberOfCurrentLotteryDocuments

 

LastNumberOfCurrentLotteryFiles

 

LastNumberOfOldEReceiptFiles (version < 6.2.0)

 

LastNumberOfOldLotteryFiles

 

LastNumberOfQueuedLotteryDocuments

 

LastNumberOfRejectedEReceiptFiles

 

LastNumberOfRejectedLotteryDocuments

 

LastNumberOfRejectedLotteryFiles

 

LastNumberOfSentEReceiptFiles (from version 6.2.0)

 

LastNumConf

 

LastNumeroOperatore

 

LastNumFatt

 

LastNumFlag

 

LastNumNatura

 

LastNumRemainingCodes

 

LastNumRiga

 

LastNumSF

 

LastNumSNF

 

LastNValuta

 

LastOEM

 

LastOP

 

LastOPCode

 

LastOPCodeData

 

LastParametroDaLeggere

 

LastPerOpr

 

LastPersonalisedOffsetMultiple

 

LastPHPEnabled

 

LastPHPScriptName

 

LastPHPScriptType

 

LastPOS_ActionCode

 

LastPOS_FailureDescription

 

LastPOS_HostDailyTotal

 

LastPOS_IPaddress

 

LastPOS_MessageCode

 

LastPOS_ReplyString

 

LastPOS_TCPPortNumber

 

LastPOS_TerminalDailyTotal

 

LastPOS_TerminalID

 

LastPOS_TransactionResult

 

LastPrezzo1

 

LastPrezzo2

 

LastPrezzo3

LastPrice1PLU

 

LastPrice2PLU

 

LastPrice3PLU

 

LastPrintDevice

 

LastPrintMode

 

LastPrintX01FinancialReport

 

LastPS2Fun

 

LastPS2Key

 

LastReceiptJSONEnabled

 

LastRequestType

 

LastRest

 

LastResult

 

LastResultCode


LastRim


 

LastRTDateCAAECertificateExpiration

 

LastRTDateDeviceCertificateExpiration

 

LastRTDayOpened

 

LastRTDeviceType

 

LastRTFirmwareBuildNumber

 

LastRTFirmwareUpdateResult

 

LastRTMainState

 

LastRTMatrFisc

 

LastRTNonWorkingPeriod

 

LastRTNumberOfArchivedRejectedFiles

 

LastRTNumberOfCurrentFiles

 

LastRTNumberOfOldFiles

 

LastRTNumberOfRejectedFiles

 

LastRTOutOfServiceCondition

 

LastRTRecoverCertificateCondition

 

LastRTSDFileSystemVersionNumber

 

LastRTSubState

 

LastRTTrainingDemoSimulationMode

 

LastSalesType

 

LastSambaEnabled

 

LastSec

 

LastSpare

 

LastStampaIntestazione

 

LastState

 

LastSubRim

 

LastSuperGruppoMerceologico

 

LastTaxAuthorityErrorCode

 

LastTaxAuthorityReplyID

 

LastTillId (RT Server only)

 

LastTimeout

 

LastTipoRichiestaSubTotal

 

LastTipoRiga

 

LastTipoStampa

 

LastTotAC

 

LastTotaleConteggiLetti

 

LastTotaleImportiLetti

 

LastTotalePezziLetti

 

LastTotalePezziRepartoLetti


LastTotAmountPLU

 

LastTotFisc

 

LastTotItemPLU

 

LastTotNFisc


LastTrailerLineDescription

LastTrailerLineNumber

 

LastUMFattura

 

LastUUIDOrPassphrase

 

LastValoreTicket

 

LastValoreValuta

 

LastVentilazione

 

LastVentilazioneMode

 

LastVentVatColumnPrintMode

 

LastWebApplicationEnabled

 

LastWebAppMemType

 

LastWebServerPassword

 

LastWebServerSSLMode

 

LastWebServerUserID

 

LastWebSocketMode

 

LastWeightFromScale


LastZReportNumber

 

LastZReportPrinterDate

 

LastZReportSearchResultCode

 

LastZReportTaxAuthorityOperationID

 

LastZReportTaxAuthorityReplyDate

 

OEMStringConversion

 


Special Properties

 

RT Properties

 

ExtendedLicenseRT

 

ExtendedRTLicense

 

LastAuthorisedTechCF

 

LastCAAECertificateURL

 

LastDeviceCertificateURL

 

LastFirmwareURL

 

LastFirmwareURLFileType

 

LastInterventionDescription

 

LastInterventionOperationFlag

 

LastLabTaxCode

 

LastNumIndexInterventionFunction

 

LastNumSequenceRecord

 

LastRetailerTaxCode

 

LastTaxAuthorityServiceCode

 

LastURL

 

LastURLPassword

 

LastURLUsername

 


Box Office Tickets Properties

 

ExtendedLicenseTicketing

 

ExtendedTicketingLicense

 


Other Special Properties

 

ExtendedFWRegLicense

 

ExtendedGraphicLicense

 

ExtendedLicenseFWReg

 

ExtendedLicenseGraphic

 

ExtendedLicenseLottery

 

ExtendedLotteryLicense

 

LastBusinessTaxCodeLotteryRule

 

LastCashPaymentLotteryRule

 

LastChequePaymentLotteryRule

 

LastCurrentFirmwareBuildNumber

 

LastCurrentFirmwareVersion

 

LastElectronicPaymentLotteryRule

 

LastFirmwareRegistrationKey

 

LastFirmwareRegistrationStatus

 

LastLotteryThresholdAmount

 

LastNotPaidPaymentLotteryRule

 

LastPayDiscountLotteryRule

 

LastPersonalTaxCodeLotteryRule

 

LastRxCommandInDirectIoMode

 

LastRxDataInDirectIoMode

 

LastRxFrameInDirectIoMode

 

LastSDFirmwareFilename

 

LastSDFirmwareSize

 

LastSubIndex

 

LastTicketPaymentLotteryRule

 

 


Epson Reserved Properties

 

ExtendedLicenseProgramming

 

ExtendedProgrammingLicense

 

LastForcedPaperWidth58

 


Displaced Fiscal Protocol Properties

 

LastAutoZReportEnabled

 

LastCC

 

LastCodProd

 

LastNettoPrecedente

 

LastNumTick

 

LastPerc

 

LastPercReparto

 

LastPre

 

LastQta

 

LastRep

 

LastSubT

 

LastSubTotFisc

 

LastSubTotNFisc

 

LastTipoPre

 

LastUSBPenDriveEnabled (displaced by LastWebAppMemType)

 

LastWebServerSSLEnabled (displaced by LastWebServerSSLMode)

 

LastWebSocketEnabled (displaced by LastWebSocketMode)

 


Obsolete System Properties

 

Obsolete properties are coloured fuchsia.

 

EuroSettings

 

LastRxDataInClientServerMode

 

OPERATING_Mode

 


Obsolete Connection Properties 

 

PortNumber

 

Retry

 

UsbPrinterId

 


Obsolete Fiscal Protocol Properties

 

LastAPPROVAL

 

LastAREAID

 

LastBarcodePromo

 

LastCodKeyPromo

 

LastCodPLUPromo

 

LastConfigAndStatus

 

LastConfigurationCode

 

LastCountryDependentField

 

LastCustomizationCode

 

LastDescPromo

 

LastDocType

 

LastEjFontCodePage

 

LastEJRowNumber

 

LastFiscalDocDefaultPrintFiscalDoc

 

LastFiscalDocNumber

 

LastFiscalDocNumberOfHeaderLines

 

LastFiscalDocNumberOfLines

 

LastFiscalDocPrintHeader

 

LastFiscalEngineVersion

 

LastFMData

 

LastForeignCurrencyChangeRate

 

LastForeignCurrencyCode

 

LastForeignCurrencyDescription

 

LastFSN

 

LastGrandTotalCode

 

LastKernelVersion

 

LastMemoryDump (Reserved property)

 

LastMemoryDumpBytesToRead (Reserved property)

 

LastMemoryDumpHexInitAddressToRead (Reserved property)

 

LastMemoryDumpType (Reserved property)

 

LastNCategoryPLU

 

LastNRepPromo

 

LastNumPromo

 

LastOperationType

 

LastParameter

 

LastPrFontCodePage

 

LastPricePromo

 

LastPrinterCountry

 

LastPrinterModel

 

LastPrinterVersion

 

LastReceiptImageParameter

 

LastReceiptImageParameterValue

 

LastReportData

 

LastRowFont

 

LastScoSicuroParameter

 

LastScoSicuroParameterValue

 

LastTicketNumber

 

LastTimeStamp

 

LastTotalAmountRead

 

LastTotalDiscountDep

 

LastTotalDiscountSubtotal

 

LastTotalDocumentClassI

 

LastTotalDocumentClassIII

 

LastTotalGrossAmount

 

LastTotalItemRead

 

LastTotalVatAmount

 

LastTotImp1

 

LastTotImp2

 

LastTotOp1

 

LastTotOp2

 

LastTypePromo

 


Enumerators

Current Enumerators are coloured green.

Enumerator Name, Methods, Properties and Native Commands

Constant Value Names

Value

Comments

enum_EPS_ARCHIVE_FOLDER

Associated method: archiveRejectedFilesByType

Associated property: None

Native command: 9016

ARCHIVE_Z_REPORTS 0  
ARCHIVE_LOTTERY_FILES 1  
ARCHIVE_E_RECEIPT_FILES 2  
enum_EPS_CONNECTIVITY_TEST_REQUESTED

Associated method: opTestNetworkConnectivity

Associated properties: None

Native command: 4020

DEFAULT_GATEWAY 1 Default gateway ping test
DNS_SERVER 2 Primary DNS server ping test
AGENZIA_ENTRATE_SERVER 3 Test tax authority connection
enum_EPS_DEPT_MODE

Associated methods: opProgRepartoEsteso, SetDepartmentExt, opReadReparto and GetDepartment

Associated property: LastDepartmentMode

Native commands: 4002 and 4202

DEP_NORMAL 0 Normal
DEP_NO_DISCOUNT_SURCHARGE 1 Discounts and surcharges ignored / inhibited
enum_EPS_DOC_EMISSION_TYPES

Associated methods: readEmissionModeAndEReceiptTransmissionStatus, SetDocumentEmissionMode and GetDocumentEmissionMode

Associated property: LastDocumentEmissionTypes

Native commands: 1131, 1133 and 1333

PAPER_ONLY 0 Solo carta in Italian
DIGITAL_ONLY 1 Solo digitale in Italian
PAPER_AND_DIGITAL 2 Carta e digitale in Italian
enum_EPS_DOC_EMISSION_VALIDITY

Associated methods: SetDocumentEmissionMode and GetDocumentEmissionMode

Associated property: LastDocumentEmissionValidity

Native commands: 1133 and 1333

NOT_SET (GetDocumentEmissionMode only) 0 Read only
ALL_SUBSEQUENT_DOCS 1  
NEXT_DOC_ONLY 2  
enum_EPS_EFTPOS_ACT_DEACT_MODE

Associated methods: progEFTPOSConfiguration and readEFTPOSConfiguration

Associated property: LastActivationDeactivationMode

Native commands: 4031 and 4231

EFTPOS_OFF 0 Off
EFTPOS_ON_SETEFI 1 SETEFI
EFTPOS_ON_INGENICO 2 Ingenico protocol 17
enum_EPS_EREC_CUSTOMER_ID_TYPE

Associated methods: SetEReceiptCustomerDetails, GetEReceiptCustomerDetails and readEReceiptDocStatus

Associated properties: None

Native commands: 1132, 1332 and 9226

REGISTERED_ID 0  
EMAIL_ADDRESS 1  
PHONE_NUMBER 2  
ANONYMOUS_UUID 3 UUID generated by Scontrinosmart server
ANONYMOUS_PASSPHRASE 4  
ANONYMOUS_LOCAL_UUID 5 UUID generated by printer
enum_EPS_EXPORT_DESTINATION

Associated method: exportContentToFile

Associated properties: None

Native command: 9020

EXPORT_TO_USB_PEN_DRIVE 0  
EXPORT_TO_SD_CARD 1  
enum_EPS_EXPORT_MODE

Associated method: exportMFMPRContentToFile

Associated properties: None

Native command: 9003

EXPORT_BY_Z_REPORT_NUMBER

0  

EXPORT_BY_DATE

1  
enum_EPS_FIRMWARE_REPOSITORY_LOCATION

Subject to NDA.

FW_URL

0  

FW_USB_PEN_DRIVE

1  
enum_EPS_FIRMWARE_UP_REGISTRATION_FUNCTION

Subject to NDA.

FLASH_FW

0  

REGISTER_FW

1  

FLASH_AUTH_FW_SD_CARD

2  

DOWNLOAD_SPECIFIED_FW_TO_SD_CARD

3  

DOWNLOAD_LATEST_FW_TO_SD_CARD_NO_AUTH

4  
enum_EPS_FREE_OF_CHARGE_COUNTER_DOC_TYPE

Associated method: opReadTotaleFinanziarioOmaggiByDocType

Associated property: LastParametroDaLeggere

Native commands: 2050 and 2051

FREE_OF_CHARGE_SALES

83  

FREE_OF_CHARGE_REFUNDS

84  

FREE_OF_CHARGE_VOIDS

85  
enum_EPS_GRAPHIC_FILE_MODE

Associated methods: progGraphicFileConfiguration and readGraphicFileConfiguration

Associated property: LastGraphicFileMode

Native commands: 4034 and 4234

NO_GRAPHIC_FILE 0  
NON_VOLATILE_GRAPHIC_FILE_COUPON 100 Static graphic file
VOLATILE_GRAPHIC_FILE_COUPON 200 Single-use graphic file
GRAPHIC_FILE_FOR_NVRAM 210290 Indicative as the values are 2x0 in native protocol where x ranges from 1 to 9 (210, 220 etc. up to 290)
enum_EPS_LOTTERY_MESSAGE_PRINTING

Associated methods: progLotteryMessage and readLotteryMessage

Associated property: LastPrintMode

Native commands: 9019 and 9219

LOTTERY_MESSAGE_LINE_NOT_PRINTED 0  
LOTTERY_MESSAGE_LINE_PRINTED 1  
enum_EPS_LOTTERY_SEARCH_READ_DOCUMENT_TYPE

Associated method: searchAndReadLotteryDocStatus

Associated properties: None

Native command: 9218

LOTTERY_READ_ALL 0  
LOTTERY_SEARCH_ERRONEOUS 1  
enum_EPS_MAINTENANCE_COUNTER

Associated method: opReadMaintenanceCounter

Associated property: LastMaintenanceCounterType

Native command: 4295

ROW 1 Number of printed lines
THERMAL_HEAD 2 Print head activations
NUMBER_OF_CUT 3 Number of paper cuts
PRINTING_TIME 4 Cumulative print duration (hours)

PAPER_OR_PAPER_COVER_STATE

10 Paper or paper cover state

enum_EPS_MODIFIER_TYPE

Associated methods: opRepartoModificatoreLight and PrintRecModifier

Associated properties: None

Native command: 1090

MOD_ACCONTO

0 Deposit or down/payment
MOD_OMAGGIO 1 Free of charge
MOD_BUONO_MONOUSO 2 Single use voucher

enum_EPS_MOVE_FILE_DIRECTION

Associated method: moveFile

Associated properties: None

Native command: 9025

FROM_DA_INVIARE_TO_RIFIUTATI

0  
FROM_RIFIUTATI_TO_DA_INVIARE 1  
enum_EPS_NOT_PAID_COUNTER_TYPE

Associated method: opReadTotaleFinanziarioNonRiscossiByType

Associated property: LastParametroDaLeggere

Native commands: 2050 and 2051

GOODS_AND_SERVICES

73

GOODS_ONLY

74

SERVICES_ONLY 75
INVOICES_BASED_ON_DOC_COMM 76
DIRECT_RT_INVOICES 77 For future use
SSN_PHARMACY 78
enum_EPS_PHP_SCRIPT_TYPE

Associated methods: progPHPConfiguration and readPHPConfiguration

Associated property: LastPHPScriptType

Native commands: 4034 and 4234

PHP_NO_SCRIPT 0  
PHP_AUTO_SCRIPT_AWAIT_COUPON_REPLY 1  
PHP_AUTO_SCRIPT_NO_AWAIT_COUPON_REPLY 2  
PHP_BACKGROUND_SCRIPT 3  
PHP_AUTO_SCRIPT_AFTER_Z_REPORT 4  
enum_EPS_READ_ACCESS_CONTROL_FUNCTION

Associated method: readAccessControlConfiguration

Associated property: LastAccessControlIndex

Native command: 4238

READ_SESSION_TIMEOUT_DURATION_MINS 4  
READ_EMAIL_DEST_ADDRESS 5  
READ_SESSION_STATUS 20  
READ_SESSION_TIME_REMAINING 21  
enum_EPS_SALES_TYPE

Associated methods: opProgRepartoEsteso, SetDepartmentExt, opReadReparto and GetDepartment

Associated property: LastSalesType

Native commands: 4002 and 4202

GOODS_BENI

0 Goods

SERVICES_SERVIZI

1 Service
enum_EPS_SET_MANAGE_ACCESS_CONTROL_FUNCTION

Associated method: progOrManageAccessControl

Associated properties: None

Native command: 4038

SET_PASSWORD 1  
LOGIN 2  
LOGOUT 3  
SET_SESSION_TIMEOUT_DURATION_MINS 4  
SET_EMAIL_DEST_ADDRESS 5  
TEST_EMAIL 6  
ACTIVATE_PASSWORD_RECOVERY 7  
enum_EPS_TAX_COUNTER_TYPE

Associated method: opReadTotaleFinanziarioTasseByType

Associated property: LastParametroDaLeggere

Native commands: 2050 and 2051

CURRENT_SALES_TABLE

20

Tax and natures from 00 to 18
INVOICES_ALT

35

Same as 62 in fiscal firmware. Tax and natures from 00 to 18
CURRENT_OR_PREVIOUS_SALES_TABLE 40 Tax and natures from 00 to 59 except 20, 30, 40 and 50
CURRENT_OR_PREVIOUS_REFUNDS_TABLE 41 Tax and natures from 00 to 59 except 20, 30, 40 and 50
CURRENT_OR_PREVIOUS_VOIDS_TABLE 42 Tax and natures from 00 to 59 except 20, 30, 40 and 50
CURRENT_OR_PREVIOUS_NET_TABLE 43 Tax and natures from 00 to 59 except 20, 30, 40 and 50
CURRENT_OPEN_DOCUMENT 44 Tax and natures from 00 to 59 except 20, 30, 40 and 50
INVOICES 62 Same as 35 in fiscal firmware. Tax and natures from 00 to 18
enum_EPS_TRANS_CODE_TYPE

Associated method: sendElectronicPayOfflineTransDetails

Associated properties: None

Native command: 1108

OTHER

0  

STAN

1  
enum_EPS_URL_AUTH_TYPE

Associated methods: progURLAuth and readURLAuth

Associated properties: LastURLUsername and LastURLPassword

Native commands: 9022 and 9222

AUTH_CA_CERTIFICATE 50 For future use
AUTH_FIRMWARE_MOT 51
AUTH_FIRMWARE_SIG 52
AUTH_CSR_CERTIFICATE 53
AUTH_FIRMWARE_VERIFICATION 54
AUTH_DST_DEFINITIONS 55
AUTH_NTP_SERVER 56
AUTH_ACCESS_CONTROL_PASSWORD_RECOVERY 57
AUTH_E_RECEIPT_SERVER 58  
AUTH_E_RECEIPT_SERVER_OBFUSCATED 59  
enum_EPS_URL_TYPE

Associated methods: progURL and readURL

Associated properties: LastURL always. Also sets the following:

Native commands: 9022 and 9222

URL_CA_CERTIFICATE 0 Same as progCAAECertificateURL 9007 and
readCAAECertificateURL 9207
URL_FIRMWARE_MOT 1  
URL_FIRMWARE_SIG 2
URL_CSR_CERTIFICATE 3 CSR RT device certificate
URL_FIRMWARE_VERIFICATION 4  
URL_DST_DEFINITIONS 5  
URL_NTP_SERVER 6  
URL_ACCESS_CONTROL_PASSWORD_RECOVERY 7  
URL_E_RECEIPT_SERVER 8  
URL_E_RECEIPT_SERVER_OBFUSCATED 9  
URL_TAX_AUTHORITY_EVENTS 10 readURL only
URL_TAX_AUTHORITY_ACTIVATIONS 11 readURL only
URL_TAX_AUTHORITY_REGISTRATIONS 12 readURL only
URL_TAX_AUTHORITY_DAILY_TAKINGS 13 readURL only
URL_TAX_AUTHORITY_LOTTERY 14 readURL only
URL_TAX_AUTHORITY_INST_LOTT_CODES 15 readURL only
enum_EPS_VENT_VAT_COLUMN_PRINT_MODE

Associated methods: progATECOConfiguration and readATECOConfiguration

Associated property: LastVentVatColumnPrintMode

Native commands: 4037 and 4237

PRINT_PERCENTAGE 0 For possible future use
PRINT_VI 1 Currently VI is always printed
enum_EPS_WEB_APP_MEM_TYPE

Associated methods: progWebAppMemTypeConfiguration and readWebAppMemTypeConfiguration

Associated property: LastWebAppMemType

Native commands: 4034 and 4234

FISCAL_BOARD_FLASH_MEMORY 0  
USB_PEN_DRIVE 1  
SD_CARD 2  
enumEPS_ADDITIONAL_FISCAL_DOCUMENT_HEADER_LOCATION

Associated method: AdditionalFiscalDocumentHeader

Associated properties: None

Native command: 1078

EPS_BEFORE_LOGO 5 Equivalent to opAddRowDesc and RowType = 5
EPS_AFTER_LOGO 6 Equivalent to opAddRowDesc and RowType = 6
enumEPS_ALIGNLIGHT

Associated methods and native commands: See TextAlignment

Associated properties: None

EPS_ALIGN_SX 1 Left align the customer display text
EPS_ALIGN_DX 2 Right align the customer display text
EPS_WEIGHT_ALIGN_SX 3 opRepartoLight and PrintRecItem only
EPS_WEIGHT_ALIGN_DX 4 opRepartoLight and PrintRecItem only
enumEPS_COMM_MODALITY

Associated methods: All Connection Methods

Associated property: COMM_Modality

Native commands: N/a

EPS_SERIAL_COMM 0 RS-232
EPS_TCP_COMM 1 TCP/IP
EPS_USB_COMM 2 USB
enumEPS_INT_ERR

Associated methods: Most

Associated property: LastEERR

Native commands: All

EERR_CARTA_GIORNALE 1 See Printer Errors Table

 

EERR_CARTA_SCONTRINO 2
EERR_OFFLINE 3
EERR_ERR_04 4
EERR_ERR_05 5
EERR_ERR_06 6
EERR_SLIP_KO 7
EERR_TASTO_ERRATO 8
EERR_DATA_INFERIORE 9
EERR_DATA_ERRATA 10
EERR_SEQUENZA_ERRATA 11
EERR_DATI_INESISTENTI 12
EERR_VALORE_ERRATO 13
EERR_PROG_MATRICOLA 14
EERR_GIA_ESISTENTE 15
EERR_NON_PREVISTO 16
EERR_IMPOSSIBILE_ORA 17
EERR_NON_POSSIBILE 18
EERR_SCRITTA_INVALIDA 19
EERR_SUPERA_VALORE 20
EERR_SUPERA_LIMITE 21
EERR_NON_PROGRAMMATO 22
EERR_CHIUDI_SCONTRINO 23
EERR_CHIUDI_PAGAMENTO 24
EERR_MANCA_OPERATORE 25
EERR_CASSA_INFERIORE 26
EERR_OLTRE_PROGRAMMAZ 27
EERR_PC_NON_COLLEGATO 28
EERR_MANCA_MODULO 29
EERR_CHECKSUM_ERRATO 30
EERR_DATI_INESISTENTI_PC 31
EERR_ERR_32 32
EERR_ERR_33 33
EERR_MANCA_ATTIVAZIONE 34
EERR_SLIP_CONNESSIONE 35
EERR_ERR_36 36
EERR_SLIP_RIMUOVERE_MODULO 37
EERR_EFT_POS_IN_ERRORE 38
EERR_DOC_GIA_ANNULLATO 39
EERR_DOC_GIA_RESO 40
EERR_DOC_RIF_DOC_ANNULLO 41
EERR_DOC_RIF_DOC_RESO 42
enumEPS_OP_RETVALUE

Associated methods: Most

Associated properties: None

Native commands: All

 

EERR -1 See Erroneous Return Values Table
OP_OK (No error) 0 See Positive Return Value Table
OP_ERR_NOCOLL 1 See Erroneous Return Values Table
OP_ERR_PORTCLOSE 2
OP_ERR_TIMEOUT 3
OP_ERR_CHKS 4
OP_ERR_EUROLOCK- Obsolete 5
OP_ERR_FILENOTFOUND 6
OP_ERR_ACKTIMEOUT 7
OP_ERR_STXTIMEOUT 8
OP_ERR_OCXBUSY 9
OP_ERR_EXTENDEDGRAPHICLICENSENOTFOUND 10
OP_ERR_EXTENDEDTICKETINGLICENSENOTFOUND 11
OP_ERR_CREATESOCKETFAILED 12
OP_ERR_TCPCONNFAILED 13
OP_ERR_RECEIVE_TIMEOUT - Not used 14
OP_ERR_RECEIVE_NODATA - Not used 15
OP_ERR_EXTENDEDPROGRAMMINGLICENSENOTFOUND - Reserved for Epson 16
OP_ERR_USBCONNFAILED 17
OP_ERR_MULTI_COMMAND_SEQUENCE_FAILURE 18
OP_ERR_EXTENDEDRTLICENSENOTFOUND 19
OP_ERR_DEPRECATED_METHOD 20
OP_ERR_INVALID_ARGUMENT_VALUE 21
OP_ERR_EJ_QUERY 22
OP_ERR_EXTENDEDFWREGLICENSENOTFOUND 23
OP_ERR_EXTENDEDLOTTERYLICENSENOTFOUND 24
enumEPS_OPCODE

Associated methods: See last column

Associated property: LastOPCode

Native commands: See last column

OP_CODE_SUBT 1051 Methods below in the range from 1051 to 1183 have all been displaced.

opSubTot - 1051

OP_CODE_CONT_RIM 1171 Payment not complete - opContante - 1036
OP_CODE_CONT_REST 1172 Payment complete - opContante - 1036
OP_CODE_CONTVAL_RIM 1173 Payment not complete - opContanteVal - 1035
OP_CODE_CONTVAL_REST 1174 Payment complete - opContanteVal - 1035
OP_CODE_ASSEG_RIM 1175 Payment not complete - opAssegno - 1044
OP_CODE_ASSEG_REST 1176 Payment complete - opAssegno - 1044
OP_CODE_ASSEGVAL_RIM 1177 Payment not complete - opAssegnoVal - 1043
OP_CODE_ASSEGVAL_REST 1178 Payment complete - opAssegnoVal- 1043
OP_CODE_TICKET_RIM 1179 Payment not complete - opTicket - 1046
OP_CODE_TICKET_REST 1180 Payment complete - opTicket - 1046
OP_CODE_SUBT_RIM 1181 opSubTot - 1051
OP_CODE_CONTDESC_RIM 1182 Payment not complete - opContanteConDesc - 1069
OP_CODE_CONTDESC_REST 1183 Payment complete - opContanteConDesc - 1069
     
OP_CODE_REPORT_VAL 2020 Get_PrintReport - 2020 (obsolete)
OP_CODE_REPORT_END 2021 Get_PrintReport - 2020 (obsolete)
OP_CODE_FM_PRINTED 3020 Get_PrintFMReport - 3020 (obsolete)
OP_CODE_FM_VAL 3021 Get_PrintFMReport - 3020 (obsolete)
OP_CODE_FM_END 3022 Get_PrintFMReport - 3020 (obsolete)
     
OP_CODE_DGFENUMPRO_VAL 3100 Indicates that MPD (EJ / DGFE) reading should continue.

opReadDGFENumPro - 3100

OP_CODE_DGFEDATE_VAL 3101 Indicates that MPD (EJ / DGFE) reading should continue.

opReadDGFEDate - 3101

OP_CODE_DGFE_END 3102 Indicates that the end of the MPD (EJ / DGFE) reading is complete and no more data needs to be read. If set in first reply, it means no data found in specified range.

opReadDGFENumPro - 3100
opReadDGFEDate - 3101
opReadDGFEDate2 - 3103
opReadDGFEByNumbers - 3104

Get_PrintEJReport - 3105 (obsolete)

OP_CODE_DGFEDATE2_VAL 3103 Indicates that MPD (EJ / DGFE) reading should continue.

opReadDGFEDate2 - 3103

OP_CODE_DGFENUMPRO2_VAL 3104 Indicates that MPD (EJ / DGFE) reading should continue.

opReadDGFEByNumbers - 3104

OP_CODE_DGFE_VAL 3105 Get_PrintEJReport - 3105 (obsolete)
enumEPS_PAPER

Associated method: opAlzoCarta

Associated properties: None

Native command: 1148

EPS_SCONTRINO 1  
EPS_GIORNALE (obsolete) 2  
EPS_SCONTRINO_GIORNALE (obsolete) 3  
enumEPS_PERIODO

Associated methods: See Daily/Historical Totalisers Table

Associated properties: None

Native commands: 2050 and 2051

EPS_GIORNALIERO 1 Daily total
EPS_PERIODICO 2 Periodical total
enumPAYMENT_TYPE

Associated methods:
opPaymentLight and PrintRecTotal
PrintRecTotalVoid (obsolete)

Associated properties: None

Native commands: 1084 and 1090 (obsolete 1090 variant)

PAY_CASH 0 Cash
PAY_CHECK 1 Cheque
PAY_CC 2 Credit or credit card
PAY_TICKET 3 Ticket / voucher
PAY_MULTI_TICKET 4 Multiple tickets / vouchers
NOT_PAID 5 Not paid (non riscosso)
PAY_CASH_FOREIGNCURRENCY Obsolete
PAYMENT_DISCOUNT 6 Payment discount (sconto a pagare)
enumSubRim

Associated methods: opStampaVisSubtotale and PrintRecSubtotal

Associated property: LastTipoRichiestaSubTotal

Native command: 1086

SUBTOTAL 1  
RIM 2  
enumTipologiaRichiestaDGFE

Associated methods: Get_PrintEJData and Get_PrintEJDataByNumbers

Associated properties: None

Native commands: 3103 and 3104

DGFE_PRINT 0  
DGFE_READ 1  
enumTipologiaScontrinoDGFE

Associated methods: opReadDGFEDate2, QueryContent, opZDGFEDate2, Get_PrintEJData, opReadDGFEByNumbers, QueryContentByNumbers, opZDGFEByNumbers and Get_PrintEJDataByNumbers

Associated properties: None

Native commands: 3103 and 3104

DGFE_ALL 0  
DGFE_ONLY_FISCAL 1 Commercial documents
DGFE_ONLY_INVOICES 2  
DGFE_ONLY_ACCESS_TICKET 3 Box office tickets
DGFE_ONLY_CREDIT_NOTE 4 Obsolete
DGFE_ONLY_Z_REPORT 5 Obsolete
DGFE_ONLY_ELECTRONIC_PAYMENT 6 From version 6.2.0
enumTipoStampaVisSubtotale

Associated methods: opStampaVisSubtotale and PrintRecSubtotal

Associated properties: None

Native command: 1086

PRINT_AND_VIEW 0  
PRINT_ONLY 1  
VIEW_ONLY 2  
GET_ONLY 3  
enumTypeTicket

Subject to NDA.

T_PAPER_AND_DGFE 0  
T_ONLYPAPER 1  

 


Obsolete Enumerators

Obsolete Enumerators are coloured fuchsia.

Enumerator Name, Methods, Properties and Native Commands

Constant Value Names

Value

Comments

enum_EPS_ADJIUSTMENT_VOID_TYPE

Not used

DISCOUNT_ON_LAST_SOLD_ITEM 0  
DISCOUNT_ON_SUBTOTAL_AND_PRINT_SUBTOTAL 1  
DISCOUNT_ON_SUBTOTAL_NO_PRINT_SUBTOTAL 2  
DISCOUNT_ON_DEPARTMENT 3  
SURCHARGE_ON_LAST_SOLD_ITEM 5  
SURCHARGE_ON_SUBTOTAL_AND_PRINT_SUBTOTAL 6  
SURCHARGE_ON_SUBTOTAL_NO_PRINT_SUBTOTAL 7  
SURCHARGE_ON_DEPARTMENT 8  
enum_EPS_DGFE_REPORT

Associated method: Get_PrintEJReport

Associated property: LastOperationType

Native command: 3015

DGFE_REPORT_PRINT 0  
DGFE_REPORT_READ 1  
DGFE_REPORT_PC_PRINT 2  
DGFE_REPORT_PC_READ 3  
DGFE_REPORT_KEY_PRINT 4  
DGFE_REPORT_KEY_READ 5  
enum_EPS_DISPLAY_ALIGNMENT

Associated methods: PrintRecAdjustmentVoid and PrintRecTotalVoid

Associated properties: None

Native commands: 1089 and 1090

ALIGN_RIGHT 1  
ALIGH_LEFT 2  
enum_EPS_FM_REPORT

Associated method: Get_PrintFMReport

Associated properties: None

Native command: 3020

 FM_REPORT_PRINT 0  
FM_REPORT_READ 1  
enum_EPS_MEMORY_DUMP

Associated method: opMemoryDump

Associated property: LastMemoryDumpType

Native command: 4300

FLASH 0  
MF 1  
RAM 2  
enum_EPS_REPORT

Associated method: Get_PrintReport

Associated properties: None

Native command: 2020

REPORT_PRINT 0  
REPORT_READ 1  
enumEPS_EUROSETTINGS

Associated methods: N/a

Associated property: EuroSettings

Native commands: N/a

EPS_EUROSETTINGS_UNKNOWN 0 Do not set EuroSettings to this value
EPS_EUROSETTINGS_LIRE 1 Do not set EuroSettings to this value
EPS_EUROSETTINGS_EURO 2 EuroSettings is set to this value by default and should remain so
enumEPS_OPERATING_MODE

Associated methods: N/a

Associated property: OPERATING_Mode

Native commands: N/a

EPS_MASTER_SLAVE 0  
EPS_CLIENT_SERVER 1  
enumEPS_PROMO_TYPE

Associated method: opReadSalesPromotionTable, opReadSalesPromotionTableAmount and opProgSalesPromotionTable

Associated property: LastTypePromo

Native commands: 2060, 3060, 4060 and 4260

EPS_PROMO_EMPLOYEE 1  
EPS_PROMO_MENU 2  
EPS_PROMO_TICKET_SURPLUS 3  

 


Errors

 

Errors are split into two groups:

EpsonFp2 errors are defined with the prefix "OP_ERR_" followed by the description. In the case of printer PDU errors, the EERR value is returned and the specific printer error can be ascertained by reading the LastEERR property. GetLastErrorDescription can be used to return a verbose description. See Erroneous Return Values and Printer Errors tables.

The description of the internal printer errors with associated code together with common errors can also be found in the Communication Protocol document. For example, 17 means "Impossible now".

 


Events

 

 

 

Code Snippet Example

Private Sub EpsonFPControl1_FPError(ErrorLevel As Integer, ErrorCode As Long)

    MsgBox "ErrorLevel = " & ErrorLevel & vbCrLf & _
                "ErrorCode = " & ErrorCode & vbCrLf & _
                "Error description = " & EpsonFPControl1.GetLastErrorDescription(ErrorLevel, ErrorCode)

End Sub

 


Daily/Historical Totalisers Table

 

The following table lists the behaviour of GetData, GetDailyData and GetHistoricData generic totaliser methods related to native commands 2050/2051. It also lists the "direct" method for each index.

Index Totaliser

Number

Direct Method(s)

Properties Set

Notes

All
(except 32, 38 and 39)
      LastParametroDaLeggere always set except for grand total indexes 32, 38 and 39  
1 Departments

Department number (DepartmentCode)

opReadTotaleFinanziarioReparto

LastDatoLetto - Department number
LastTotalePezziRepartoLetti - Department pieces/quantity
LastTotaleImportiLetti - Total department amount

2 Refunds (obsolete)

N/a

opReadTotaleFinanziarioResi

LastDatoLetto - N/a

LastTotalePezziLetti - Operations

LastTotaleImportiLetti - Amount

 
3 Corrections (storni)

opReadTotaleFinanziarioStorni

4 Last operation voids

opReadTotaleFinanziarioCorrezioni

5 Open document voids

opReadTotaleFinanziarioAnnulliScontrino
opReadTotaleFinanziarioAnnulliDocumentoInCorso

6 Fixed value discounts

opReadTotaleFinanziarioScontiVal

7 Percentage discounts

opReadTotaleFinanziarioScontiPerc

8 Percentage surcharges

opReadTotaleFinanziarioMaggiorazioniPerc

9 Cash credit recoveries

opReadTotaleFinanziarioRecCreditiContanti

10 Cash in transactions

CurrencyCode

opReadTotaleFinanziarioEntrateCont

LastDatoLetto - Currency code

LastTotalePezziLetti - Operations

LastTotaleImportiLetti - Amount

Euro = 00
11 Cash out transactions

opReadTotaleFinanziarioUsciteCont

12 Cash drawer cash contents by currency

opReadTotaleFinanziarioContantiVal

13 Cash drawer cash contents in Euro N/a

opReadTotaleFinanziarioContanti

LastDatoLetto - N/a

LastTotalePezziLetti - Operations

LastTotaleImportiLetti - Amount 

 
14 Cheque credit recoveries

opReadTotaleFinanziarioRecCreditiAssegni

15 Cheque in transactions

CurrencyCode

opReadTotaleFinanziarioEntrateAssegni

LastDatoLetto - Currency code

LastTotalePezziLetti - Operations

LastTotaleImportiLetti - Amount

Euro = 00
16 Cheque out transactions opReadTotaleFinanziarioUsciteAssegni
17 Cash drawer cheque contents by currency opReadTotaleFinanziarioAssegni
18 Credit and credit card payments

Credit (0) or
credit card number (1 to 10)
NCartaCC

opReadTotaleFinanziarioCredCC

LastDatoLetto - Credit (0) or credit card number (1 to 10)
LastTotalePezziLetti - Operations
LastTotaleImportiLetti - Amount
 
19 Ticket payments

Ticket number (1 to 10)
TicketNumber

opReadTotaleFinanziarioTicket

LastDatoLetto - Ticket number (1 to 10)
LastTotalePezziLetti - Operations
LastTotaleImportiLetti - Amount
 
20 Sales document VAT

VAT or nature group (0 to 18)
VatCode

opReadTotaleFinanziarioTasse
opReadTotaleFinanziarioTasseByType

LastDatoLetto - VAT or nature group
LastImponibileLetto - Amount excluding VAT
LastTotaleImportiLetti - VAT amount
 
21 Cash drawer openings

N/a

opReadTotaleFinanziarioApertureCassetto

LastDatoLetto - N/a
LastTotalePezziLetti - N/a
LastTotaleConteggiLetti - Number of cash drawer openings
 
22 Invoices

opReadTotaleFinanziarioFatture

LastDatoLetto - N/a
LastTotalePezziLetti - Number of invoices emitted
LastTotaleImportiLetti - Amount
 
23 Personalised fiscal receipts

(ricevute fiscali) (obsolete)

opReadTotaleFinanziarioRicevute

LastDatoLetto - N/a
LastTotalePezziLetti - Number of personalised fiscal receipts emitted
LastTotaleImportiLetti - Amount
 
24 Number of commercial documents opReadTotaleFinanziarioScontriniFiscali
opReadTotaleFinanziarioDocumentiCommerciali
LastDatoLetto - N/a
LastTotalePezziLetti - N/a
LastTotaleConteggiLetti - Number of commercial documents emitted
 
25 Fiscal memory receipts (obsolete) opReadTotaleFinanziarioScontriniMemoriaFiscale LastDatoLetto - N/a
LastTotalePezziLetti - N/a
LastTotaleConteggiLetti - Number of fiscal memory receipts emitted
 
26 Number of management documents opReadTotaleFinanziarioScontriniNonFiscali
opReadTotaleFinanziarioDocumentiGestionali
LastDatoLetto - N/a
LastTotalePezziLetti - N/a
LastTotaleConteggiLetti - Number of management documents emitted
 
27 Number of daily closures (Z reports) opReadTotaleFinanziarioChiusureGiornaliere LastDatoLetto - N/a
LastTotalePezziLetti - N/a
LastTotaleConteggiLetti - Number of daily closures
EPS_GIORNALIERO only
28 Daily total opReadTotaleFinanziarioFiscaleGiornaliero LastDatoLetto - N/a
LastTotalePezziLetti - N/a
LastTotaleImportiLetti - Amount
EPS_GIORNALIERO only
29 Cash with description payments

Cash index (1 to 5)
NContante

opReadTotaleFinanziarioContantiConDesc LastDatoLetto - Cash index (1 to 5)
LastTotalePezziLetti - Number of payments
LastTotaleImportiLetti - Amount
 
30 Fixed amount surcharges N/a opReadTotaleFinanziarioMaggiorazioniVal LastDatoLetto - N/a
LastTotalePezziLetti - Operations
LastTotaleImportiLetti - Amount
 
31 Commercial refund documents amount opReadTotaleFinanziarioNoteDiCredito LastDatoLetto - N/a
LastTotalePezziLetti - N/a
LastTotaleImportiLetti - Amount
Same as index 36
32 Grand total and refund documents grand total amounts opReadGranTotaleNdc LastGranTotale - Commercial sale documents grand total
LastGranTotaleNoteDiCredito - Commercial refund documents grand total
LastNumAzzeramenti - Number of fiscal daily closures (Z report number)
Same as index 38
33 Ticket differences (obsolete) opReadTotaleFinanziarioDifferenzeTicket LastDatoLetto - N/a
LastTotalePezziLetti - Items
LastTotaleImportiLetti - Amount
34 First and latest invoice numbers opReadTotaleFinanziarioPrimoNrUltimoNrFattura LastDatoLetto - N/a
LastInvoiceStartNumber
LastInvoiceEndNumber
Same as index 61
35 Invoice VAT

VAT or nature group (0 to 18)
VatCode

opReadTotaleFinanziarioTasseFatture
opReadTotaleFinanziarioTasseByType
LastDatoLetto - VAT or nature group
LastImponibileLetto - Amount excluding VAT
LastTotaleImportiLetti - VAT Amount
Same as index 62
36 Commercial refund documents amount

N/a

opReadTotaleFinanziarioDocDiReso

LastDatoLetto - N/a
LastTotalePezziLetti - N/a
LastTotaleImportiLetti - Amount
Same as index 31
37 Commercial void documents amount

opReadTotaleFinanziarioDocDiAnnullo

 
38 Grand total and refund documents grand total amounts

opReadGranTotaleDocDiReso

LastGranTotale - Commercial sale documents grand total
LastGranTotaleDocDiReso - Commercial refund documents grand total
LastNumAzzeramenti - Number of fiscal daily closures (Z report number)
Same as index 32
39 Grand total and void documents grand total amounts

opReadGranTotaleDocDiAnnullo

LastGranTotale - Commercial sale documents grand total
LastGranTotaleDocDiAnnullo - Commercial void documents grand total
LastNumAzzeramenti - Number of fiscal daily closures (Z report number)
 
40 Commercial sale documents VAT

VAT or nature group (0 to 59)
VatCode

opReadTotaleFinanziarioTasseByType

LastDatoLetto - VAT or nature group
LastImponibileLetto - Amount excluding VAT
LastTotaleImportiLetti - VAT Amount
 
41 Commercial refund documents VAT  
42 Commercial void document VAT  
43 Commercial documents net VAT  
44 Current open document or invoice VAT  
45 Operators

Operator number (1 to 12)
RequiredOperator

opReadTotaleFinanziarioOperatori
opReadTotaleOperatori

LastDatoLetto - Operator number
LastTotalePezziLetti - Number of documents
LastTotaleImportiLetti - Amount
 
46 to 60

Not used

61 First and latest invoice numbers

N/a

None (use index 34 method)

 

Same as index 34

62 Invoice VAT

VAT or nature group (0 to 18)
VatCode

None (use index 35 method)

Same as index 35

63 Class I and III documents (obsolete) N/a

None
(use GetData, GetDailyData or GetHistoricData)

LastDatoLetto - N/a
LastTotalDocumentClassI - Amount
LastTotalDocumentClassIII - Amount
64 Weighing scales last operation LastDatoLetto - N/a
LastWeightFromScale - Weight in grams
LastAmountFromScale - Amount
65 Ticket payment voucher count For future use. No current specific method exists yet
66 to 69

Not used 

70 Deposit deduction modifier operations Department number (DepartmentCode) opReadTotaleFinanziarioRepartoAcconti LastDatoLetto - Department number

LastTotalePezziLetti - Operations

LastTotaleImportiLetti - Amount

 
71 Free of charge modifier operations opReadTotaleFinanziarioRepartoOmaggi  
72 Single-use voucher modifier operations opReadTotaleFinanziarioRepartoBuoniMonouso  
73 Not paid goods and services N/a opReadTotaleFinanziarioNonRiscossiByType LastDatoLetto - N/a

LastTotalePezziLetti - Operations

LastTotaleImportiLetti - Amount

 
74 Not paid goods only  
75 Not paid services only  
76 Not paid invoices based on a commercial document  
77 Not paid RT invoices  
78 Not paid SSN pharmacy  
79 Generic payment discounts opReadTotaleFinanziarioScontiAPagareGenerici  
80 Multi-use voucher payment discounts opReadTotaleFinanziarioScontiAPagareMultiuso  
81 Cash rounding downs opReadTotaleFinanziarioArrotondamentiPerDifetto  
82 Cash rounding ups opReadTotaleFinanziarioArrotondamentiPerEccesso
83 Free of Charge (omaggi) operations in sales documents opReadTotaleFinanziarioOmaggiByDocType  
84 Free of Charge (omaggi) operations in refund/return documents

 

85 Free of Charge (omaggi) operations in void documents  
86 Departments
(Commercial Refund documents only)

Department number (DepartmentCode)

opReadTotaleFinanziarioRepartoResi

LastDatoLetto - Department number
LastTotalePezziRepartoLetti - Department pieces/quantity
LastTotaleImportiLetti - Total department amount

From version 6.2.0

87 Departments
(Commercial Void documents only)

Department number (DepartmentCode)

opReadTotaleFinanziarioRepartoAnnulli

LastDatoLetto - Department number
LastTotalePezziRepartoLetti - Department pieces/quantity
LastTotaleImportiLetti - Total department amount

From version 6.2.0

Any "not used" index or one not present in the above table will set the following properties so that any new totalisers can be read in the future: