RUSProtocolAPI  5.2.02.0
Custom.Fiscal.RUSProtocolAPI.ProtocolAPI Class Reference

Public Member Functions

APIBaseResponse OpenConnection ()
 Open communication channel between library and printer More...
 
APIBaseResponse CloseConnection ()
 Close communication channel between library and printer More...
 
APIBaseResponse Beep (string operatorPassword)
 Printer plays an acoustic buzz More...
 
APIBaseResponse PrinterReboot (string operatorPassword)
 Printer performs a reboot More...
 
APIBaseResponse WriteECRSerialNumber (string operatorPassword, string serialNumber)
 Write a new Serial Number on ECR device More...
 
APIEntryReverseResponse EntryReverse (string operatorPassword, long quantity, long amount, int deptNumber, string text)
 Prints an entry reverse More...
 
APICheckClosingResponse CheckClosing (string operatorPassword, long amountPaymentType1, long amountPaymentType2, long amountPaymentType3, long amountPaymentType4, long amountPaymentType5, bool hasAdditionalPropertyCheck, string additionalPropertyCheckText, bool hasFieldReceiver, string receiver, bool hasFieldReceiverInn, string receiverInn, bool subtotalRounding)
 Prints the fiscal payments and close document if payments are higher than total for FW version 04.01.30 More...
 
APICheckClosingResponse CheckClosing (string operatorPassword, long amountPaymentCash, bool cashRounding, long amountPaymentCashless, long amountPaymentAdvance, long amountPaymentCredit, long amountPaymentOther, Enums.RoundingEnum additionalRounding, bool hasAdditionalPropertyCheck, string additionalPropertyCheckText, bool hasFieldReceiver, string receiver, bool hasFieldReceiverInn, string receiverInn, bool hasAdditionalUserProperty, string additionalUserPropertyName, string additionalUserPropertyValue)
 Prints the fiscal payments and close document if payments are higher than total for FW version => 04.01.40 More...
 
APICheckClosingResponse CheckClosing (string operatorPassword, long amountPaymentCash, bool cashRounding, long amountPaymentCashless, long amountPaymentAdvance, long amountPaymentCredit, long amountPaymentOther, Enums.RoundingEnum additionalRounding, bool hasAdditionalPropertyCheck, string additionalPropertyCheckText, bool hasFieldReceiver, string receiver, bool hasFieldReceiverInn, string receiverInn, bool hasAdditionalUserProperty, string additionalUserPropertyName, string additionalUserPropertyValue, bool hasAddresOfPayment, string addresOfPayment, bool hasPlaceOfPayment, string placeOfPayment)
 Prints the fiscal payments and close document if payments are higher than total for FW version => 04.03.xx More...
 
APICheckClosingResponse CheckClosing (string operatorPassword, long amountPaymentCash, bool cashRounding, long amountPaymentCashless, long amountPaymentAdvance, long amountPaymentCredit, long amountPaymentOther, Enums.RoundingEnum additionalRounding, bool hasAdditionalPropertyCheck, string additionalPropertyCheckText, bool hasFieldReceiver, string receiver, bool hasFieldReceiverInn, string receiverInn, bool hasAdditionalUserProperty, string additionalUserPropertyName, string additionalUserPropertyValue, bool hasAddresOfPayment, string addresOfPayment, bool hasPlaceOfPayment, string placeOfPayment, bool operationBetweenOrganizations, bool automatMode, string automatNumber)
 Prints the fiscal payments and close document if payments are higher than total for FW version => 04.04.01 < 04.06.16 More...
 
APICheckClosingResponse CheckClosing (string operatorPassword, long amountPaymentCash, bool cashRounding, long amountPaymentCashless, long amountPaymentAdvance, long amountPaymentCredit, long amountPaymentOther, Enums.RoundingEnum additionalRounding, bool kopecsRounding, int kopecsRoundingSum, bool hasAdditionalPropertyCheck, string additionalPropertyCheckText, bool hasFieldReceiver, string receiver, bool hasFieldReceiverInn, string receiverInn, bool hasAdditionalUserProperty, string additionalUserPropertyName, string additionalUserPropertyValue, bool hasAddresOfPayment, string addresOfPayment, bool hasPlaceOfPayment, string placeOfPayment, bool operationBetweenOrganizations, bool automatMode, string automatNumber)
 Prints the fiscal payments and close document if payments are higher than total for FW version => 04.06.16 More...
 
APICheckClosingResponse CheckClosing (string operatorPassword, long amountPaymentCash, bool cashRounding, long amountPaymentCashless, long amountPaymentAdvance, long amountPaymentCredit, long amountPaymentOther, Enums.RoundingEnum additionalRounding, bool kopecsRounding, int kopecsRoundingSum, bool hasAdditionalPropertyCheck, string additionalPropertyCheckText, bool hasFieldReceiver, string receiver, bool hasFieldReceiverInn, string receiverInn, bool hasAdditionalUserProperty, string additionalUserPropertyName, string additionalUserPropertyValue, bool hasAddresOfPayment, string addresOfPayment, bool hasPlaceOfPayment, string placeOfPayment, bool operationBetweenOrganizations, bool automatMode, string automatNumber, bool hasFOIV_tag1261, string foiv_tag1262, DateTime dateOfDocReason_tag1263, string numOfDocReason_tag1264, string valueOfBranchProp_tag1265, bool hasOperationCheckProperty, DateTime operationDateTime_1273, int operationIdentifier_1271, string operationData_tag1272, bool hasReceiverPurchaser, uint recieverPurchaserBits, string receiverPurchaserName_1227, string receiverPurchaserINN_1228, DateTime receiverPurchaserDateOfBirth_1243, string receiverPurchaserCitizenship_1244, int receiverPurchaserCodeOfDocumentType_1245, string receiverPurchaserDataOfDocument_1246, string receiverPurchaserPurchaserAddress_1254, bool flagField_bit15)
 Prints the fiscal payments and close document if payments are higher than total for FFD 1.2 More...
 
APIBaseResponse VoidLastItem (string operatorPassword)
 Void last element in current Fiscal Document More...
 
APISubtotalModifierResponse SubtotalModifier (string operatorPassword, bool isAddOn, bool isPercentage, bool printSubtotal, long amount, string decription)
 Perform a Subtotal Modifier More...
 
APIItemModifierResponse ItemModifier (string operatorPassword, bool isAddOn, bool isPercentage, bool printSubtotal, long amount, string decription)
 Perform an Item Modifier More...
 
APIBaseResponse CheckCancellation (string operatorPassword)
 Cancels the current receipt More...
 
APICheckSubtotalResponse CheckSubtotal (string operatorPassword, bool print)
 Performs current receipt subtotal More...
 
APIBaseResponse RepeatDocument (string operatorPassword, int firstTicketToPrint, int lastTicketToPrint, Enums.RepeatDocumentEnum documentType)
 Re-prints last receipt More...
 
APIBaseResponse OpenFiscalDocument (string operatorPassword, bool print, bool saveOnFile, Enums.ReceiptTypeEnum docType, Enums.TaxCodeEnum taxCode)
 Initiates a new fiscal document of a given type More...
 
APIBaseResponse OpenFiscalDocument (string operatorPassword, bool print, bool saveOnFile, Enums.ReceiptTypeEnum docType, Enums.TaxCodeEnum taxCode, bool saveOnSD, bool saveTXT, bool saveTXTonSD)
 Initiates a new fiscal document of a given type (new format with flag "Save on SD" More...
 
APIBaseResponse OpenCorrectionDocument (string operatorPassword, bool print, bool saveOnFile, Enums.CorrectionReceiptTypeEnum docType, Enums.TaxCodeEnum taxCode, Enums.CorrectionTypeEnum correctionType, string reason, DateTime reasonDate, string reasonDocNumber)
 Initiates a new Correction Document More...
 
APIBaseResponse OpenCorrectionDocument (string operatorPassword, bool print, bool saveOnFile, Enums.CorrectionReceiptTypeEnum docType, Enums.TaxCodeEnum taxCode, Enums.CorrectionTypeEnum correctionType, string reason, DateTime reasonDate, string reasonDocNumber, bool saveOnSD, bool saveTXT, bool saveTXTonSD)
 Initiates a new Correction Document More...
 
APILastErrorResponse GetLastError (string operatorPassword)
 Get protocol last error code and description More...
 
APIBaseResponse SendOFDData (string operatorPassword, Enums.OFDDataTypeEnum dataType, string data)
 Send OFD data More...
 
APIBaseResponse SendOFDData (string operatorPassword, Enums.OFDDataTypeEnum dataType, int dataLength, byte[] data)
 Send OFD data More...
 
APIOpenFiscalDayResponse OpenFiscalDay (string operatorPassword, bool print, bool saveOnFile)
 Open Fiscal Day on Printer More...
 
APIOpenFiscalDayResponse OpenFiscalDay (string operatorPassword, bool print, bool saveOnFile, bool saveOnSD, bool saveTXT, bool saveTXTonSD)
 Open Fiscal Day on Printer (new command format with flag "Save to SD") More...
 
APIOpenFiscalDayResponse OpenFiscalDay (string operatorPassword, bool print, bool saveOnFile, bool saveOnSD, bool saveTXT, bool saveTXTonSD, bool hasAddressOfPayment, string addressOfPayment, bool hasPlaceOfPayment, string placeOfPayment)
 Open Fiscal Day on Printer (new command format with flag "Save to SD") Command format for Addres and Place of Payments More...
 
APIOpenFiscalDayResponse OpenFiscalDay (string operatorPassword, bool print, bool saveOnFile, bool saveOnSD, bool saveTXT, bool saveTXTonSD, bool hasAddressOfPayment, string addressOfPayment, bool hasPlaceOfPayment, string placeOfPayment, bool hasPropOfSession_1276, string PropOfSession_1276, bool hasDataOfSession_1277, List< byte > DataOfSession_1277)
 Open Fiscal Day on Printer for FFD 1.2 Command format for Addres and Place of Payments More...
 
APIBaseResponse OpenNotFiscalDocument (string operatorPassword, bool printOperator, bool printSerialNum, bool printHeader, bool printDateTime)
 Initiates a not fiscal ticket More...
 
APIBaseResponse PrintText (string operatorPassword, bool doubleWidth, bool automaticNewLine, bool halfWidth, bool doubleHeigth, bool border, bool halfHeigth, bool bold, bool italic, Enums.FontSizeEnum fontSize, string text)
 Prints a not fiscal line More...
 
APIBaseResponse PaperCut (string operatorPassword)
 Performs a paper cut More...
 
APIBaseResponse PrintIcon (string operatorPassword, int iconNumber, int windowHeight, int startX, int startY)
 Prints an image icon on document More...
 
APIBaseResponse PrintBarcode1D (string operatorPassword, int height, int scale, Enums.BarcodePositionEnum position, Enums.Barcode1DTypeEnum barcodeType, bool noAscii, bool noChecksum, bool textDoubleHeight, bool noHeaderNoFooter, string text)
 Prints a barcode 1D on document More...
 
APIBaseResponse PrintBarcode2D (string operatorPassword, int scale, Enums.Barcode2DTypeEnum barcodeType, int type, String inputText)
 Prints a barcode 2D on document More...
 
APIBaseResponse PrintByManualCommand (string operatorPassword, byte command, List< byte > inputBuffer)
 
APIBaseResponse PrintBarcodeCompact (string operatorPassword, int scale, string text)
 Prints a barcode with compact library More...
 
APIBaseResponse CloseNotFiscallDocument (string operatorPassword, bool printSerialNum, bool paperCut)
 Close current not fiscal ticket More...
 
APIFMResponse FMGetSessionCounter (string operatorPassword, Enums.FMCounterTypeEnum counterType)
 FM direct command: GET Session Counter More...
 
APIFMResponse FMGetOperationCounter (string operatorPassword, Enums.FMCounterTypeEnum counterType)
 FM direct command: GET Operation Counter More...
 
APIFMResponse FMGetSessionCounter (string operatorPassword, Enums.FMCounterTypeEnum counterType, Enums.FMOperationTypeEnum operationType)
 FM direct command: GET Session Counter by Operation Type More...
 
APIFMResponse FMGetFormat (string operatorPassword)
 FM direct command: GET Format More...
 
APIFMResponse FMRemainedValidity (string operatorPassword, DateTime date)
 FM direct command: Remained validity period request More...
 
APIFMResponse FMGetFreeMemory (string operatorPassword)
 FM direct command: GET Free Memory Resource More...
 
APIFMResponse FMNotTrasminttedCounter (string operatorPassword)
 FM direct command: GET Counter for NOT Trasmitted Documents More...
 
APIFMResponse FMGetTotalDataSize (string operatorPassword)
 FM direct command: GET Total Data Size More...
 
APIFMResponse FMGetRegistrationDocumentTVL (string operatorPassword)
 FM direct command: GET Registration Document TVL More...
 
APIFMResponse FMGetStatusMC (string operatorPassword)
 FM direct command: REQUEST OF FN STATUS ABOUT MK More...
 
APIFMResponse FMGetNotificationMC (string operatorPassword)
 FM direct command: REQUEST NOTIFICATION OF MK More...
 
APIFMResponse FMGetDocumentByNumber (string operatorPassword, int documentNumber)
 FM direct command: GET Document Data by Number More...
 
APIFMResponse FMStatus (string operatorPassword)
 FM direct command: GET Status More...
 
APIFMResponse FMSerialNumber (string operatorPassword)
 FM direct command: GET Serial Number More...
 
APIFMResponse FMExpiryDate (string operatorPassword)
 FM direct command: GET Expiry Date More...
 
APIFMResponse FMVersion (string operatorPassword)
 FM direct command: GET FM Version More...
 
APIFMResponse FMOfdStatus (string operatorPassword)
 FM direct command: GET ODF Status More...
 
APIFMResponse FMGetFiscalDocumentByNumber (string operatorPassword, int documentNumber)
 FM direct command: GET Document by number More...
 
APIFMResponse FMGetFiscalDocumentACKFromServer (string operatorPassword, int documentNumber)
 FM direct command: GET Document ACK from server More...
 
APIFMResponse FMGetCountNotACKFromServer (string operatorPassword)
 FM direct command: GET quantity of not acked document from server More...
 
APIFMResponse FMGetFiscalizationTotals (string operatorPassword, int registrationNumber)
 FM direct command: GET fiscalization amount totals More...
 
APIFMResponse FMGetFiscalizationSTVL (string operatorPassword, int registrationNumber, int tvlTag)
 FM direct command: GET fiscalization STVL More...
 
APIFMResponse FMGetFiscalDocument (string operatorPassword, int documentNumber)
 FM direct command: GET Fiscal Document More...
 
APIFMResponse FMGetFiscalDocumentTVL (string operatorPassword)
 FM direct command: GET Fiscal Document TVL More...
 
APIFMResponse FMGetRecentSessionParams (string operatorPassword)
 FM direct command: GET recent session parameters More...
 
APIFMResponse FMGenericCommand (string operatorPassword, int format, int retry, bool logEnable, bool semaphore, int timeout, List< byte > command)
 FM direct command: Send Generic command to FM More...
 
APIGetDateResponse GetPrinterDateTime (string operatorPassword)
 Returns actual date and time stored on printer More...
 
APILastFMReceiptDataResponse GetLastFMReceiptData (string operatorPassword)
 Returns data stored in FM about last document More...
 
APIPrinterStatusResponse GetPrinterStatus (string operatorPassword)
 Returns current printer status More...
 
APIShiftStatusResponse ShiftStatus (string operatorPassword)
 Returns current shift status More...
 
APIReceiptStatusResponse GetReceiptStatus (string operatorPassword)
 Returns current document status More...
 
APILastReceiptDataResponse GetLastReceiptData (string operatorPassword)
 Returns last document general data More...
 
APIGrandTotalStatusResponse GetGrandTotalStatus (string operatorPassword)
 Returns printer grand totals More...
 
APIDayTotalStatusResponse GetDayTotalStatus (string operatorPassword)
 Returns daily totals More...
 
APITicketTotalStatusResponse GetTicketTotalStatus (string operatorPassword)
 Returns current ticket totals More...
 
APITicketInfoResponse GetTicketInfo (string operatorPassword)
 Returns ticket info More...
 
APINotTrasmittedCounterStatusResponse GetNotTrasmittedCounterStatus (string operatorPassword)
 Returns not trasmitted amount counter totals More...
 
APIDrawerCounterStatusResponse GetDrawerCounterStatus (string operatorPassword)
 Returns cash in drawer counters More...
 
APIStatisticReportResponse GetStatisticReport (string operatorPassword, Enums.StatisticReportEnum reportType, int departmentRowNumber)
 Returns an amount report list More...
 
APIStatisticDiscountReportResponse GetStatisticDiscountReport (string operatorPassword, int rowNumber)
 Returns a discount report list More...
 
APIStatisticAllowedDataResponse GetStatisticAllowedData (string operatorPassword)
 Get Allowed field list for current ECR status More...
 
APIPrinterInfoResponse GetPrinterInfo (string operatorPassword)
 Returns general printer info More...
 
APIGetVATTableResponse GetVATTable (string operatorPassword)
 Returns VAT table array value More...
 
APIGetPrinterParamsResponse GetPrinterParameters (string operatorPassword)
 Returns print parameters More...
 
APIGetTicketConfigurationParamsResponse GetTicketConfigurationParameters (string operatorPassword)
 Returns ticket parameters More...
 
APIGetGeneralConfigurationResponse GetPrinterGeneralConfiguration (string operatorPassword)
 Returns general configuration papameters More...
 
APIGetHeaderConfigurationResponse GetHeaderConfiguration (string operatorPassword)
 Returns header rows More...
 
APIGetHeaderConfigurationResponse GetHeaderConfiguration_V2 (string operatorPassword)
 Returns header rows for fw ver => 04.01.23 More...
 
APIGetHeaderConfigurationResponse GetFooterConfiguration (string operatorPassword)
 Returns trailer rows More...
 
APIGetHeaderConfigurationResponse GetFooterConfiguration_V2 (string operatorPassword)
 Returns trailer rows for fw ver => 04.01.23 More...
 
APIGetOFDConfigurationResponse GetOFDConfiguration (string operatorPassword)
 Returns OFD parameters More...
 
APIGetCommunicationConfigurationResponse GetCommunicationConfiguration (string operatorPassword)
 Returns Printer general communication parameters More...
 
APIGetTK302RS232ConfigurationResponse GetTK302RS232Configuration (string operatorPassword)
 Returns TK302-FB RS232 communication parameters More...
 
APIGetTK302USBConfigurationResponse GetTK302USBConfiguration (string operatorPassword)
 Returns TK302-FB RS232 communication parameters More...
 
APIGetTK302PaperConfigurationResponse GetTK302PaperConfiguration (string operatorPassword)
 Returns TK302-FB RS232 communication parameters More...
 
APIGetEthernetConfigurationResponse GetEthernetConfiguration (string operatorPassword)
 Returns Printer ethernet communication parameters More...
 
APIGetTK302EthernetConfigurationResponse GetTK302EthernetConfiguration (string operatorPassword)
 Returns Printer ethernet communication parameters More...
 
APIGetWiFiConfigurationResponse GetWifiConfiguration (string operatorPassword)
 Returns WiFi parameters More...
 
APIGetUSBProfileConfigurationResponse GetUSBProfileConfiguration (string operatorPassword)
 Returns USB Profile parameters More...
 
APIGetDepartmentTableRowResponse GetDepartmentTableRow (string operatorPassword, int rowIndex)
 Returns a row of Department table More...
 
APIGetOperatorTableRowResponse GetOperatorTableRow (string operatorPassword, int rowIndex)
 Returns a row of Operator table More...
 
APIGetPaymentTableRowResponse GetPaymenytTableRow (string operatorPassword, int rowIndex)
 Returns a row of Paymenyt table More...
 
APIBaseResponse SetVATTable (string operatorPassword, int[] items)
 Writes VAT table values More...
 
APIBaseResponse SetPrinterParameters (string operatorPassword, int printEnergy, int printSpeed, int bottomLineFeed, int interlineCompression, uint ticketFormat, int cutterEnabled)
 Write print parameters More...
 
APIBaseResponse SetPrinterParameters (string operatorPassword, int printEnergy, int printSpeed, int bottomLineFeed, int interlineCompression, uint ticketFormat, Enums.DirectoryConfigurationEnum directoryConfiguration, Enums.FilenameConfigurationEnum filenameConfiguration, Enums.FilenameExtensionEnum filenameExtension)
 Write print parameters vor VKP80III-F. No CUTTER parameter!!! More...
 
APIBaseResponse SetPrinterParameters (string operatorPassword, int printEnergy, int printSpeed, int bottomLineFeed, int interlineCompression, uint ticketFormat, int cutterEnabled, Enums.DirectoryConfigurationEnum directoryConfiguration, Enums.FilenameConfigurationEnum filenameConfiguration, Enums.FilenameExtensionEnum filenameExtension)
 Write print parameters More...
 
APIBaseResponse SetTicketConfigurationParameters (string operatorPassword, bool asyncPrint, bool cancelledDocPrint, bool notFiscTicketHeader, bool printPluCode, bool printSubtotal, bool printNumPieces, bool printOnlyIfNotZero, bool printPeriodical, bool printOperator, bool printUnitQty, bool ticketCopy, bool printDetailVat, bool saveTicketBmp)
 Write ticket parameters More...
 
APIBaseResponse SetPrinterGeneralConfiguration (string operatorPassword, int deviceModel, int mandatorySubtotal, int NegativeCashDrawer, int cashDrawerVoltage, int fpuMode, int ExtraInfo, int displayBacklight, int displayContrast)
 Write general configuration parameters More...
 
APIBaseResponse SetHeaderConfiguration (string operatorPassword, APITkRow[] items)
 Writes Header table values More...
 
APIBaseResponse SetHeaderConfiguration_V2 (string operatorPassword, APITkRow[] items)
 Writes Header table V2 values More...
 
APIBaseResponse SetFooterConfiguration (string operatorPassword, APITkRow[] items)
 Writes Trailer table values More...
 
APIBaseResponse SetFooterConfiguration_V2 (string operatorPassword, APITkRow[] items)
 Writes Trailer table values for fw => 04.01.23 More...
 
APIBaseResponse SetOFDTagValue (string operatorPassword, Enums.OFDDataTypeEnum ofdDataType, string data)
 Write HD DN parameters More...
 
APIBaseResponse SetOFDConfiguration (string operatorPassword, string webSiteUrl, int webSitePort, Enums.FDOChannelEnum channel, int timerFN, int timerC, int timerACK, uint ofdConfiguration)
 Writes OFD table values for Q3X-F and TK302-FB, data string length 141 bytes More...
 
APIBaseResponse SetOFDConfiguration (string operatorPassword, string webSiteUrl, int webSitePort, Enums.FDOChannelEnum channel, int timerFN, int timerC, int timerACK, uint ofdConfiguration, string oismUrl, int oismPort, int oismTimeout1, int oismTimeout2, string web3Url, int web3Port, int web3Timeout1, int web3Timeout2)
 Writes OFD table values for FFD 1.2 More...
 
APIBaseResponse SetOFDConfiguration (string operatorPassword, string webSiteUrl, int webSitePort, int timerFN, int timerC, int timerACK, uint ofdConfiguration, string oismUrl, int oismPort, int oismTimeout1, int oismTimeout2, string web3Url, int web3Port, int web3Timeout1, int web3Timeout2)
 Writes OFD table values for FFD 1.2 More...
 
APIBaseResponse SetOFDConfiguration (string operatorPassword, string webSiteUrl, int webSitePort, int timerFN, int timerC, int timerACK, uint ofdConfiguration)
 Writes OFD table values for FUSION, data string length 140 bytes More...
 
APIBaseResponse SetCommunicationConfiguration (string operatorPassword, Enums.ProtocolEnum protocol, int baudrate, int bitNumber, bool txFooter, bool txEcho, Enums.HandshakeEnum handshake, bool displayLine, Enums.PCChannelTypeEnum pcChannel, Enums.PaperMissingEnum paperMissing)
 Writes communication parameters More...
 
APIBaseResponse SetEthernetConfiguration (string operatorPassword, bool dhcpEnabled, IPAddress address, IPAddress netMask, IPAddress gateway, IPAddress dns, int port)
 Writes ethernet parameters More...
 
APIBaseResponse SetTK302EthernetConfiguration (string operatorPassword, bool dhcpEnabled, string printerName, IPAddress address, IPAddress netMask, IPAddress gateway, IPAddress dns1, IPAddress dns2, int port)
 Writes ethernet parameters for TK302-FB More...
 
APIBaseResponse SetWifiConfiguration (string operatorPassword, bool wifiEnabled, string ssid, Enums.SecurityTypeEnum security, string password, bool dhcpEnabled, IPAddress address, IPAddress netMask, IPAddress gateway, IPAddress dns, int port)
 Writes wifi parameters More...
 
APIBaseResponse SetTK302RS232Configuration (string operatorPassword, int baudRate, int dataLength, int Parity, Enums.TK302HandshakeEnum handshake, int busyCondition)
 Writes RS232 parameters More...
 
APIBaseResponse SetTK302PaperConfiguration (string operatorPassword, bool cutterEnabled, int paperWidth, int charsInch, int printDensity, int speed)
 Writes paper parameters, Family 10182, 10119, 10114, 10200, 10115 More...
 
APIBaseResponse SetTK302USBConfiguration (string operatorPassword, int usbAddress, Enums.TK302UsbClassEnum usbClass)
 Writes RS232 parameters More...
 
APIBaseResponse SetDepartmentTableRow (string operatorPassword, int rowIndex, APIDepartment value)
 Writes values in Department table More...
 
APIBaseResponse SetOperatorTableRow (string operatorPassword, int rowIndex, APIOperator value)
 Writes values in Opeator table More...
 
APIBaseResponse SetPaymentTableRow (string operatorPassword, int rowIndex, APIPayment value)
 Writes values in Payment table More...
 
APIBaseResponse FileOpen (string operatorPassword, string fileName, Enums.FileOpenModeEnum accessMode, int fileLength)
 Open a file on printer disk More...
 
APIBaseResponse FileClose (string operatorPassword)
 Close the file previously open on printer disk More...
 
APIBaseResponse FileClose (string operatorPassword, string MD5)
 Close the file previously open on printer disk More...
 
APIBaseResponse FileWrite (string operatorPassword, List< byte > imgBytes)
 Write the file previously open on printer disk More...
 
APIBaseResponse FileSeek (string operatorPassword, uint origin, uint offset)
 Seek the file previously open on printer disk More...
 
APIBaseResponse FileDelete (string operatorPassword, string fileName)
 Delete a file on printer disk More...
 
APIFileGetSizeResponse FileGetSize (string operatorPassword)
 Get the current file size More...
 
APIFileReadResponse FileRead (string operatorPassword, int fileLength)
 Read the current file data More...
 
APIDiskInfoResponse DiskInfo (string operatorPassword, byte diskIndex)
 Get info of selected memory More...
 
APIBaseResponse SetUSBProfileConfiguration (string operatorPassword, Enums.UsbProfileEnum profile)
 Set USB profile for printer More...
 
APIGetEjectorConfigResponse GetEjectorConfig (string operatorPassword)
 Returns Ejector configuration papameters for VKP80III-F More...
 
APIBaseResponse SetEjectorConfig (string operatorPassword, int TicketMode, bool Presentation, bool Ejection, int Direction)
 Writes Ejector configuration papameters for VKP80III-F More...
 
APIBaseResponse EjectTicket (string operatorPassword)
 Eject ticket. For VKP80III-F only More...
 
APIBaseResponse SetRemoteServerSettings (string operatorPassword, ServerChannelEnum ServerChannel, string ServerAddress, ServerTimeZoneEnum ServerTimeZone, string UserName, string Password, uint TimeEventPeriod, uint EventValue, uint InternalEventValue, uint ACLValue, uint EnableLogValue, ServerOperationEnum Operation, string Group, int ACTTimeout, int ACTAttempts, int FileTimeout, int FileAttempts)
 Set Remote Server Cofiguration for Monitoring service More...
 
APIBaseResponse SendSveltaLines (string operatorPassword, string[] values, Custom.Fiscal.RUSProtocolAPI.Enums.SveltaTicketTypeEnum dataType)
 Send SVELTA lines to printer More...
 
APIBaseResponse MCConfirmationForMC (string operatorPassword, Enums.MCConfirmationEnum MCConfirmation)
 Confirmation for Marking Codes More...
 
APIBaseResponse GraphicTicketOpen (string operatorPassword, string ticketName, bool ticketRotation, int ticketXSize, int ticketYSize)
 Open Graphic Ticket More...
 
APIBaseResponse GraphicTicketClose (string operatorPassword, bool Print, bool saveOnFile, bool cutPaper)
 Close Graphic Ticket and print More...
 
APIBaseResponse GraphicTicketLine (string operatorPassword, bool Print, bool SaveOnFile, int LineX1, int LineY1, int LineX2, int LineY2, int LineWidth, int LineReverse, int LinePattern, int FillingPattern)
 Add Line/Frame to Graphic Ticket More...
 
APIBaseResponse InsertBitmapToGraphicTicket (string operatorPassword, bool Print, bool SaveOnFile, int Rotatoin, int BitmapX, int BitmapY, int BitmapIndex, int ScaleX, int ScaleY)
 Insert Bitmap in Graphic Ticket More...
 
APIBaseResponse GraphicTicketBarcode1D (string operatorPassword, bool Print, bool SaveOnFile, int Rotation, int positionX, int positionY, int height, int scale, int alignment, Enums.Barcode1DTypeEnum barcodeType, string text)
 Insert Barcode from Library 1 - Fast barcode library More...
 
APIBaseResponse InsertLineToGraphicTicket (string operatorPassword, bool Print, bool SaveOnFile, int Rotation, int positionX, int positionY, Enums.Barcode2DTypeEnum CodeType, int scale, int Flags, string text)
 Insert Barcode from Library 2 - Extended barcode Library More...
 
APIBaseResponse GraphicTicketBarcodeQR (string operatorPassword, bool Print, bool SaveOnFile, int Rotation, int positionX, int positionY, int scale, string text)
 Insert Compact QR Code to Graphic Ticket from Library 3 More...
 
APIBaseResponse GraphicTicketText (string operatorPassword, bool Print, bool SaveOnFile, int TextRotation, int TextX, int TextY, int TextScaleX, int TextScaleY, int FontSize, int FontStyle, string Text)
 Add Text to Graphic Ticket More...
 
APIServerStatusResponse GetServerStatusResponse (string operatorPassword, bool OFDServerPing, bool OISMServerPing, bool ASOKPServerPing)
 
APIRemoteServerSettingsResponse GetRemoteServerSettings (string operatorPassword)
 REMOTE SERVER ACCES, FAMILY CODE 036 CHANNEL (1 byte, list) 0~DISABLED 1~OFD CHANNEL 2~FILE ONLY SERVER ADDRESS(64 bytes, text) TIME ZONA(1 byte, list) 2~КАЛИНИНГРАДСКОЕ ВРЕМЯ UTC+2 3~МОСКОВСКОЕ ВРЕМЯ UTC+3 4~САМАРСКОЕ ВРЕМЯ UTC+4 5~ЕКАТЕРИНБУРГСКОЕ ВРЕМЯ UTC+5 6~ОМСКОЕ ВРЕМЯ UTC+6 7~КРАСНОЯРСКОЕ ВРЕМЯ UTC+7 8~ИРКУТСКОЕ ВРЕМЯ UTC+8 9~ЯКУТСКОЕ ВРЕМЯ UTC+9 10~ВЛАДИВОСТОКСКОЕ ВРЕМЯ UTC+10 11~МАГАДАНСКОЕ ВРЕМЯ UTC+11 12~КАМЧАТСКОЕ ВРЕМЯ UTC+12 BA USER(64 bytes, text) BA PASSWORD(64 bytes, text) TIME EVENT PERIOD(4 bytes, unsigned long). Range: from 60(1 hour) to 2976(2days) EVENT(4 bytes, unsigned long). Settable from bit 0 to 3. INTERNAL EVENT(4 bytes, unsigned long). Settable from bit 0 to 17. ACCESS LEVEL(4 bytes, unsigned long). Settable from bit 0 to 5. ENABLE LOG(4 bytes, unsigned long). Settable from bit 0 to 2. OPERATION(4 bytes, list) 0~NO OPERATIONS 1~DELETE RAM LOG GROUP(32 bytes, text) DEV/ACT STATUS TIMEOUT(2 bytes, unsigned short) DEV/ACT STATUS # OF ATTEMPTS(2 bytes, unsigned short) FIRMWARE FILE DOWNLOAD TIMEOUT(2 bytes, unsigned short) FIRMWARE FILE DOWNLOAD # OF ATTEMPTS(2 bytes, unsigned short) More...
 
APIAdvancedResponse GetFMInfo (string operatorPassword, int destination, Enums.FMInfoEnum documentType)
 Get FM info More...
 
APIAdvancedResponse GetECRInfo (string operatorPassword, int destination)
 Get FM info More...
 
APIAdvancedResponse GetFDbyNumber (string operatorPassword, int destination, int firstFD, int lastFD, Enums.LastFiscalDocumentEnum reportType)
 Get FM info More...
 
APIAdvancedResponse GetOFDConfirmation (string operatorPassword, int destination, int firstFD, int lastFD)
 Get FM info More...
 

Static Public Member Functions

static byte [] StringToByteArray (string hex)
 

Protected Member Functions

virtual void OnPortStatusChangedEvent (PortStatusEventArgs e)
 

Properties

bool PortIsOpened [get]
 Return the connection status of the communication port More...
 
Enums.ComunicationTypeEnum ComunicationType [set]
 Set the communication channel More...
 
Enums.LogLevelEnum LogLevel [get, set]
 Set the library log level More...
 
object [] ComunicationParams [set]
 Group of parameters for set up the communication channel. RS232 Object list: int baudRate, int dataBits, Handshake handshake, Parity parity, string portName, StopBits stopBits, bool dtr, bool rts More...
 
int CapVATTableRowCount [get]
 Returns the VAT table row number More...
 
int CapHeaderTableRowCount [get]
 Returns the Header table row number More...
 
int CapFooterTableRowCount [get]
 Returns the Footer table row number More...
 
int CapDepartmentTableRowCount [get]
 Returns the Department table row number More...
 
int CapOperatorTableRowCount [get]
 Returns the Operator table row number More...
 
int CapPaymentTableRowCount [get]
 Returns the Payment table row number More...
 

Events

PortStatusEventHandler PortStatusChangedEvent [add, remove]
 

Member Function Documentation

◆ Beep()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.Beep ( string  operatorPassword)
inline

Printer plays an acoustic buzz

RUS Protocol Command: 0x13

Parameters
operatorPassword
Returns
APIBaseResponse class type

◆ CheckCancellation()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CheckCancellation ( string  operatorPassword)
inline

Cancels the current receipt

RUS Protocol Command: 0x88

Parameters
operatorPassword
Returns
APIBaseResponse class type

◆ CheckClosing() [1/6]

APICheckClosingResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CheckClosing ( string  operatorPassword,
long  amountPaymentType1,
long  amountPaymentType2,
long  amountPaymentType3,
long  amountPaymentType4,
long  amountPaymentType5,
bool  hasAdditionalPropertyCheck,
string  additionalPropertyCheckText,
bool  hasFieldReceiver,
string  receiver,
bool  hasFieldReceiverInn,
string  receiverInn,
bool  subtotalRounding 
)
inline

Prints the fiscal payments and close document if payments are higher than total for FW version 04.01.30

RUS Protocol Command: 0x85

Parameters
operatorPassword
amountPaymentType1Sum of Cash (by cash)
amountPaymentType2Sum of Electronically (non-cash)
amountPaymentType3Sum of Prepaid (prepayment (advance))
amountPaymentType4Sum of Credit (postpayment (credit))
amountPaymentType5Sum of other payment (other payment method (consideration))
hasAdditionalPropertyCheckDelcares if the line contains the "Additional property of check" (#1192)
additionalPropertyCheckTextIf the flag hasAdditionalPropertyCheck is "true" set the additional property of check (#1192)
hasFieldReceiverDelcares if the line contains the Receiver (Purchaser) (#1227)
receiverIf the flag hasFieldreceiver is "true" set the Receiver tag (#1227)
hasFieldReceiverInnDelcares if the line contains the Receiver (Purchaser) INN (#1228)
receiverInnIf the flag hasFieldreceiverInn is "true" set the Receiver INN tag (#1228)
subtotalRoundingEnable rounding of ticket subtotal to 1.00 rubles(e.g. 1.75RUB becomes 1.00RUB) for cash payment part, if possible
Returns
APICheckClosingResponse class type

◆ CheckClosing() [2/6]

APICheckClosingResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CheckClosing ( string  operatorPassword,
long  amountPaymentCash,
bool  cashRounding,
long  amountPaymentCashless,
long  amountPaymentAdvance,
long  amountPaymentCredit,
long  amountPaymentOther,
Enums.RoundingEnum  additionalRounding,
bool  hasAdditionalPropertyCheck,
string  additionalPropertyCheckText,
bool  hasFieldReceiver,
string  receiver,
bool  hasFieldReceiverInn,
string  receiverInn,
bool  hasAdditionalUserProperty,
string  additionalUserPropertyName,
string  additionalUserPropertyValue 
)
inline

Prints the fiscal payments and close document if payments are higher than total for FW version => 04.01.40

RUS Protocol Command: 0x85

Parameters
operatorPassword
amountPaymentCashSum of Cash (by cash)
cashRoundingenable rounding of ticket subtotal to 1.00 rubles(e.g. 1.75RUB -> 1.00RUB) for cash payment part
amountPaymentCashlessSum of Electronically (non-cash)
amountPaymentAdvanceSum of Prepaid (prepayment (advance))
amountPaymentCreditSum of Credit (postpayment (credit))
amountPaymentOtherSum of other payment (other payment method (consideration))
additionalRoundingenable rounding of ticket subtotal to 1.00 rubles(e.g. 1.75RUB -> 1.00RUB) for other payment part
hasAdditionalPropertyCheckDelcares if the line contains the "Additional property of check" (#1192)
additionalPropertyCheckTextIf the flag hasAdditionalPropertyCheck is "true" set the additional property of check (#1192)
hasFieldReceiverDelcares if the line contains the Receiver (Purchaser) (#1227)
receiverIf the flag hasFieldreceiver is "true" set the Receiver tag (#1227)
hasFieldReceiverInnDelcares if the line contains the Receiver (Purchaser) INN (#1228)
receiverInnIf the flag hasFieldreceiverInn is "true" set the Receiver INN tag (#1228)
hasAdditionalUserPropertyDelcares if the line contains the "Additional user property" (#1192)
additionalUserPropertyNameIf the flag hasAdditionalUserProperty is "true" Name of additional user property (#1085)(VERS>=04.01.23)
additionalUserPropertyValueIf the flag hasAdditionalUserProperty is "true" Value of additional user property (#1086)(VERS>=04.01.23)
Returns
APICheckClosingResponse class type

◆ CheckClosing() [3/6]

APICheckClosingResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CheckClosing ( string  operatorPassword,
long  amountPaymentCash,
bool  cashRounding,
long  amountPaymentCashless,
long  amountPaymentAdvance,
long  amountPaymentCredit,
long  amountPaymentOther,
Enums.RoundingEnum  additionalRounding,
bool  hasAdditionalPropertyCheck,
string  additionalPropertyCheckText,
bool  hasFieldReceiver,
string  receiver,
bool  hasFieldReceiverInn,
string  receiverInn,
bool  hasAdditionalUserProperty,
string  additionalUserPropertyName,
string  additionalUserPropertyValue,
bool  hasAddresOfPayment,
string  addresOfPayment,
bool  hasPlaceOfPayment,
string  placeOfPayment 
)
inline

Prints the fiscal payments and close document if payments are higher than total for FW version => 04.03.xx

RUS Protocol Command: 0x85

Parameters
operatorPassword
amountPaymentCashSum of Cash (by cash)
cashRoundingenable rounding of ticket subtotal to 1.00 rubles(e.g. 1.75RUB -> 1.00RUB) for cash payment part
amountPaymentCashlessSum of Electronically (non-cash)
amountPaymentAdvanceSum of Prepaid (prepayment (advance))
amountPaymentCreditSum of Credit (postpayment (credit))
amountPaymentOtherSum of other payment (other payment method (consideration))
additionalRoundingenable rounding of ticket subtotal to 1.00 rubles(e.g. 1.75RUB -> 1.00RUB) for other payment part
hasAdditionalPropertyCheckDelcares if the line contains the "Additional property of check" (#1192)
additionalPropertyCheckTextIf the flag hasAdditionalPropertyCheck is "true" set the additional property of check (#1192)
hasFieldReceiverDelcares if the line contains the Receiver (Purchaser) (#1227)
receiverIf the flag hasFieldreceiver is "true" set the Receiver tag (#1227)
hasFieldReceiverInnDelcares if the line contains the Receiver (Purchaser) INN (#1228)
receiverInnIf the flag hasFieldreceiverInn is "true" set the Receiver INN tag (#1228)
hasAdditionalUserPropertyDelcares if the line contains the "Additional user property" (#1192)
additionalUserPropertyNameIf the flag hasAdditionalUserProperty is "true" Name of additional user property (#1085)(VERS>=04.01.23)
additionalUserPropertyValueIf the flag hasAdditionalUserProperty is "true" Value of additional user property (#1086)(VERS>=04.01.23)
hasAddresOfPaymentDeclare to set Addres of Payment tag (#1009)
addresOfPaymentIf the flag "hasAddresOfPayment" is true set the Addres of Payment
hasPlaceOfPaymentDeclare to set Place of Payment tag (#1187)
placeOfPaymentIf the flag "hasPlaceOfPayment" is true set the Place of Payment
Returns
APICheckClosingResponse class type

◆ CheckClosing() [4/6]

APICheckClosingResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CheckClosing ( string  operatorPassword,
long  amountPaymentCash,
bool  cashRounding,
long  amountPaymentCashless,
long  amountPaymentAdvance,
long  amountPaymentCredit,
long  amountPaymentOther,
Enums.RoundingEnum  additionalRounding,
bool  hasAdditionalPropertyCheck,
string  additionalPropertyCheckText,
bool  hasFieldReceiver,
string  receiver,
bool  hasFieldReceiverInn,
string  receiverInn,
bool  hasAdditionalUserProperty,
string  additionalUserPropertyName,
string  additionalUserPropertyValue,
bool  hasAddresOfPayment,
string  addresOfPayment,
bool  hasPlaceOfPayment,
string  placeOfPayment,
bool  operationBetweenOrganizations,
bool  automatMode,
string  automatNumber 
)
inline

Prints the fiscal payments and close document if payments are higher than total for FW version => 04.04.01 < 04.06.16

RUS Protocol Command: 0x85

Parameters
operatorPassword
amountPaymentCashSum of Cash (by cash)
cashRoundingenable rounding of ticket subtotal to 1.00 rubles(e.g. 1.75RUB -> 1.00RUB) for cash payment part
amountPaymentCashlessSum of Electronically (non-cash)
amountPaymentAdvanceSum of Prepaid (prepayment (advance))
amountPaymentCreditSum of Credit (postpayment (credit))
amountPaymentOtherSum of other payment (other payment method (consideration))
additionalRoundingSelect type of additional Rounding
hasAdditionalPropertyCheckDelcares if the line contains the "Additional property of check" (#1192)
additionalPropertyCheckTextIf the flag hasAdditionalPropertyCheck is "true" set the additional property of check (#1192)
hasFieldReceiverDelcares if the line contains the Receiver (Purchaser) (#1227)
receiverIf the flag hasFieldreceiver is "true" set the Receiver tag (#1227)
hasFieldReceiverInnDelcares if the line contains the Receiver (Purchaser) INN (#1228)
receiverInnIf the flag hasFieldreceiverInn is "true" set the Receiver INN tag (#1228)
hasAdditionalUserPropertyDelcares if the line contains the "Additional user property" (#1192)
additionalUserPropertyNameIf the flag hasAdditionalUserProperty is "true" Name of additional user property (#1085)(VERS>=04.01.23)
additionalUserPropertyValueIf the flag hasAdditionalUserProperty is "true" Value of additional user property (#1086)(VERS>=04.01.23)
hasAddresOfPaymentDeclare to set Addres of Payment tag (#1009)
addresOfPaymentIf the flag "hasAddresOfPayment" is true set the Addres of Payment
hasPlaceOfPaymentDeclare to set Place of Payment tag (#1187)
placeOfPaymentIf the flag "hasPlaceOfPayment" is true set the Place of Payment
operationBetweenOrganizationsSet flag of operations between Organizations. Add "VAT" in TOTALS in print form of check
automatModeDeclare to set Automat (#1036) is present
automatNumberAUTOMAT# (#1036) only if "automaticMode" is true
Returns
APICheckClosingResponse class type

◆ CheckClosing() [5/6]

APICheckClosingResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CheckClosing ( string  operatorPassword,
long  amountPaymentCash,
bool  cashRounding,
long  amountPaymentCashless,
long  amountPaymentAdvance,
long  amountPaymentCredit,
long  amountPaymentOther,
Enums.RoundingEnum  additionalRounding,
bool  kopecsRounding,
int  kopecsRoundingSum,
bool  hasAdditionalPropertyCheck,
string  additionalPropertyCheckText,
bool  hasFieldReceiver,
string  receiver,
bool  hasFieldReceiverInn,
string  receiverInn,
bool  hasAdditionalUserProperty,
string  additionalUserPropertyName,
string  additionalUserPropertyValue,
bool  hasAddresOfPayment,
string  addresOfPayment,
bool  hasPlaceOfPayment,
string  placeOfPayment,
bool  operationBetweenOrganizations,
bool  automatMode,
string  automatNumber 
)
inline

Prints the fiscal payments and close document if payments are higher than total for FW version => 04.06.16

RUS Protocol Command: 0x85

Parameters
operatorPassword
amountPaymentCashSum of Cash (by cash)
cashRoundingenable rounding of ticket subtotal to 1.00 rubles(e.g. 1.75RUB -> 1.00RUB) for cash payment part
amountPaymentCashlessSum of Electronically (non-cash)
amountPaymentAdvanceSum of Prepaid (prepayment (advance))
amountPaymentCreditSum of Credit (postpayment (credit))
amountPaymentOtherSum of other payment (other payment method (consideration))
additionalRoundingSelect type of additional Rounding
kopecsRoundingRound Kopecs
hasAdditionalPropertyCheckDelcares if the line contains the "Additional property of check" (#1192)
additionalPropertyCheckTextIf the flag hasAdditionalPropertyCheck is "true" set the additional property of check (#1192)
hasFieldReceiverDelcares if the line contains the Receiver (Purchaser) (#1227)
receiverIf the flag hasFieldreceiver is "true" set the Receiver tag (#1227)
hasFieldReceiverInnDelcares if the line contains the Receiver (Purchaser) INN (#1228)
receiverInnIf the flag hasFieldreceiverInn is "true" set the Receiver INN tag (#1228)
hasAdditionalUserPropertyDelcares if the line contains the "Additional user property" (#1192)
additionalUserPropertyNameIf the flag hasAdditionalUserProperty is "true" Name of additional user property (#1085)(VERS>=04.01.23)
additionalUserPropertyValueIf the flag hasAdditionalUserProperty is "true" Value of additional user property (#1086)(VERS>=04.01.23)
hasAddresOfPaymentDeclare to set Addres of Payment tag (#1009)
addresOfPaymentIf the flag "hasAddresOfPayment" is true set the Addres of Payment
hasPlaceOfPaymentDeclare to set Place of Payment tag (#1187)
placeOfPaymentIf the flag "hasPlaceOfPayment" is true set the Place of Payment
operationBetweenOrganizationsSet flag of operations between Organizations. Add "VAT" in TOTALS in print form of check
automatModeDeclare to set Automat (#1036) is present
automatNumberAUTOMAT# (#1036) only if "automaticMode" is true
Returns
APICheckClosingResponse class type

◆ CheckClosing() [6/6]

APICheckClosingResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CheckClosing ( string  operatorPassword,
long  amountPaymentCash,
bool  cashRounding,
long  amountPaymentCashless,
long  amountPaymentAdvance,
long  amountPaymentCredit,
long  amountPaymentOther,
Enums.RoundingEnum  additionalRounding,
bool  kopecsRounding,
int  kopecsRoundingSum,
bool  hasAdditionalPropertyCheck,
string  additionalPropertyCheckText,
bool  hasFieldReceiver,
string  receiver,
bool  hasFieldReceiverInn,
string  receiverInn,
bool  hasAdditionalUserProperty,
string  additionalUserPropertyName,
string  additionalUserPropertyValue,
bool  hasAddresOfPayment,
string  addresOfPayment,
bool  hasPlaceOfPayment,
string  placeOfPayment,
bool  operationBetweenOrganizations,
bool  automatMode,
string  automatNumber,
bool  hasFOIV_tag1261,
string  foiv_tag1262,
DateTime  dateOfDocReason_tag1263,
string  numOfDocReason_tag1264,
string  valueOfBranchProp_tag1265,
bool  hasOperationCheckProperty,
DateTime  operationDateTime_1273,
int  operationIdentifier_1271,
string  operationData_tag1272,
bool  hasReceiverPurchaser,
uint  recieverPurchaserBits,
string  receiverPurchaserName_1227,
string  receiverPurchaserINN_1228,
DateTime  receiverPurchaserDateOfBirth_1243,
string  receiverPurchaserCitizenship_1244,
int  receiverPurchaserCodeOfDocumentType_1245,
string  receiverPurchaserDataOfDocument_1246,
string  receiverPurchaserPurchaserAddress_1254,
bool  flagField_bit15 
)
inline

Prints the fiscal payments and close document if payments are higher than total for FFD 1.2

RUS Protocol Command: 0x85

Parameters
operatorPassword
amountPaymentCashSum of Cash (by cash)
cashRoundingenable rounding of ticket subtotal to 1.00 rubles(e.g. 1.75RUB -> 1.00RUB) for cash payment part
amountPaymentCashlessSum of Electronically (non-cash)
amountPaymentAdvanceSum of Prepaid (prepayment (advance))
amountPaymentCreditSum of Credit (postpayment (credit))
amountPaymentOtherSum of other payment (other payment method (consideration))
additionalRoundingSelect type of additional Rounding
kopecsRoundingRound Kopecs
hasAdditionalPropertyCheckDelcares if the line contains the "Additional property of check" (#1192)
additionalPropertyCheckTextIf the flag hasAdditionalPropertyCheck is "true" set the additional property of check (#1192)
hasFieldReceiverDelcares if the line contains the Receiver (Purchaser) (#1227)
receiverIf the flag hasFieldreceiver is "true" set the Receiver tag (#1227)
hasFieldReceiverInnDelcares if the line contains the Receiver (Purchaser) INN (#1228)
receiverInnIf the flag hasFieldreceiverInn is "true" set the Receiver INN tag (#1228)
hasAdditionalUserPropertyDelcares if the line contains the "Additional user property" (#1192)
additionalUserPropertyNameIf the flag hasAdditionalUserProperty is "true" Name of additional user property (#1085)(VERS>=04.01.23)
additionalUserPropertyValueIf the flag hasAdditionalUserProperty is "true" Value of additional user property (#1086)(VERS>=04.01.23)
hasAddresOfPaymentDeclare to set Addres of Payment tag (#1009)
addresOfPaymentIf the flag "hasAddresOfPayment" is true set the Addres of Payment
hasPlaceOfPaymentDeclare to set Place of Payment tag (#1187)
placeOfPaymentIf the flag "hasPlaceOfPayment" is true set the Place of Payment
operationBetweenOrganizationsSet flag of operations between Organizations. Add "VAT" in TOTALS in print form of check
automatModeDeclare to set Automat (#1036) is present
automatNumberAUTOMAT# (#1036) only if "automaticMode" is true
Returns
APICheckClosingResponse class type

◆ CheckSubtotal()

APICheckSubtotalResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CheckSubtotal ( string  operatorPassword,
bool  print 
)
inline

Performs current receipt subtotal

RUS Protocol Command: 0x89

Parameters
operatorPassword
printPrint a line on receipt
Returns
APICheckSubtotalResponse class type

◆ CloseConnection()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CloseConnection ( )
inline

Close communication channel between library and printer

Returns
APIBaseResponse class type

◆ CloseNotFiscallDocument()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CloseNotFiscallDocument ( string  operatorPassword,
bool  printSerialNum,
bool  paperCut 
)
inline

Close current not fiscal ticket

RUS Protocol Command: 0xDF

Parameters
operatorPassword
printSerialNumDefines if ECR serial number is printed
paperCutDefines if paper is cut
Returns
APIBaseResponse class type

◆ DiskInfo()

APIDiskInfoResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.DiskInfo ( string  operatorPassword,
byte  diskIndex 
)
inline

Get info of selected memory

RUS Protocol Command: 0x48

Parameters
operatorPassword
diskIndexDisk: 0: nor disk; 1: mmc:0; 2: mmc:1; 3: ram disk
Returns
APIDiskInfoResponse class type

◆ EjectTicket()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.EjectTicket ( string  operatorPassword)
inline

Eject ticket. For VKP80III-F only

RUS Protocol Command: 0x27

Parameters
operatorPassword
Returns
APIBaseResponse class type

◆ EntryReverse()

APIEntryReverseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.EntryReverse ( string  operatorPassword,
long  quantity,
long  amount,
int  deptNumber,
string  text 
)
inline

Prints an entry reverse

RUS Protocol Command: 0x84

Parameters
operatorPassword
quantityNumber of items
amountPrice of the line item
deptNumberDepartment of the line item
textText describing the item
Returns
APIEntryReverseResponse class type

◆ FileClose() [1/2]

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FileClose ( string  operatorPassword)
inline

Close the file previously open on printer disk

RUS Protocol Command: 0x4F

Parameters
operatorPassword
Returns
APIBaseResponse class type

◆ FileClose() [2/2]

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FileClose ( string  operatorPassword,
string  MD5 
)
inline

Close the file previously open on printer disk

RUS Protocol Command: 0x4F

Parameters
operatorPassword
MD5MD5 of selected Firmware file
Returns
APIBaseResponse class type

◆ FileDelete()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FileDelete ( string  operatorPassword,
string  fileName 
)
inline

Delete a file on printer disk

RUS Protocol Command: 0x49

Parameters
operatorPassword
fileNameName of the file to delete
Returns
APIBaseResponse class type

◆ FileGetSize()

APIFileGetSizeResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FileGetSize ( string  operatorPassword)
inline

Get the current file size

RUS Protocol Command: 0x4A

Parameters
operatorPassword
Returns
APIFileGetSizeResponse class type

◆ FileOpen()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FileOpen ( string  operatorPassword,
string  fileName,
Enums.FileOpenModeEnum  accessMode,
int  fileLength 
)
inline

Open a file on printer disk

RUS Protocol Command: 0x4B

Firmware so File Access Mode

  • r Opens text file for reading.
  • w Truncates to zero length or creates text file for writing.
  • a Appends; opens/creates text file for writing at endof-file.
  • rb Opens binary file for reading.
  • wb Truncates to zero length or creates binary file for writing.
  • ab Appends; opens/creates binary file for writing at end-of-file.
  • r+ Opens text file for update (reading and writing).
  • w+ Truncates to zero length or creates text file for update.
  • a+ Appends; opens/creates text file for update, writing at end-of-file.
  • rb+ Opens binary file for update (reading and writing).
  • wb+ Truncates to zero length or creates binary file for update.
  • ab+ Appends; opens/creates binary file for update, writing at end-of-file.
Parameters
operatorPassword
fileNameName of the file to open in Write or Read mode
accessModeType of access mode
fileLengthLength of the file
Returns
APIBaseResponse class type

◆ FileRead()

APIFileReadResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FileRead ( string  operatorPassword,
int  fileLength 
)
inline

Read the current file data

RUS Protocol Command: 0x4C

Parameters
operatorPassword
fileLengthfile length, Byte
Returns
APIFileReadResponse class type

◆ FileSeek()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FileSeek ( string  operatorPassword,
uint  origin,
uint  offset 
)
inline

Seek the file previously open on printer disk

RUS Protocol Command: 0x4E

Parameters
operatorPassword
originOrigin position
offsetOffset value for seek file
Returns
APIBaseResponse class type

◆ FileWrite()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FileWrite ( string  operatorPassword,
List< byte >  imgBytes 
)
inline

Write the file previously open on printer disk

RUS Protocol Command: 0x4D

Parameters
operatorPassword
imgBytesData to be writed on file
Returns
APIBaseResponse class type

◆ FMExpiryDate()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMExpiryDate ( string  operatorPassword)
inline

FM direct command: GET Expiry Date

RUS Protocol Command: 0xE2

FM Command: 0x32

Parameters
operatorPassword
Returns
APIFMResponse class type

◆ FMGenericCommand()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGenericCommand ( string  operatorPassword,
int  format,
int  retry,
bool  logEnable,
bool  semaphore,
int  timeout,
List< byte >  command 
)
inline

FM direct command: Send Generic command to FM

RUS Protocol Command: 0xEF

FM Command: any

Parameters
operatorPassword
formatFormat: 0=full packet, 1=only command(error) and data field
retry1..10: number of retry in case of timeout

<param

Returns
APIFMResponse class type

◆ FMGetCountNotACKFromServer()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetCountNotACKFromServer ( string  operatorPassword)
inline

FM direct command: GET quantity of not acked document from server

RUS Protocol Command: 0xE7

FM Command: 0x42

Parameters
operatorPassword
Returns
APIFMResponse class type

◆ FMGetDocumentByNumber()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetDocumentByNumber ( string  operatorPassword,
int  documentNumber 
)
inline

FM direct command: GET Document Data by Number

RUS Protocol Command: 0xCF

FM Command: 0x50

Parameters
operatorPassword
documentNumber
Returns
APIFMResponse class type

◆ FMGetFiscalDocument()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetFiscalDocument ( string  operatorPassword,
int  documentNumber 
)
inline

FM direct command: GET Fiscal Document

RUS Protocol Command: 0xEA

FM Command: 0x45

Parameters
operatorPassword
documentNumberDocument stored number
Returns
APIFMResponse class type

Referenced by Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetLastFMReceiptData().

◆ FMGetFiscalDocumentACKFromServer()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetFiscalDocumentACKFromServer ( string  operatorPassword,
int  documentNumber 
)
inline

FM direct command: GET Document ACK from server

RUS Protocol Command: 0xE6

FM Command: 0x41

Parameters
operatorPassword
documentNumberDocument stored number
Returns
APIFMResponse class type

◆ FMGetFiscalDocumentByNumber()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetFiscalDocumentByNumber ( string  operatorPassword,
int  documentNumber 
)
inline

FM direct command: GET Document by number

RUS Protocol Command: 0xE5

FM Command: 0x40

Parameters
operatorPassword
documentNumberDocument stored number
Returns
APIFMResponse class type

◆ FMGetFiscalDocumentTVL()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetFiscalDocumentTVL ( string  operatorPassword)
inline

FM direct command: GET Fiscal Document TVL

RUS Protocol Command: 0xEB

FM Command: 0x46

Parameters
operatorPassword
Returns
APIFMResponse class type

Referenced by Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetLastFMReceiptData().

◆ FMGetFiscalizationSTVL()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetFiscalizationSTVL ( string  operatorPassword,
int  registrationNumber,
int  tvlTag 
)
inline

FM direct command: GET fiscalization STVL

RUS Protocol Command: 0xE9

FM Command: 0x44

Parameters
operatorPassword
registrationNumberRegistration id number
tvlTagTVL parameter
Returns
APIFMResponse class type

◆ FMGetFiscalizationTotals()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetFiscalizationTotals ( string  operatorPassword,
int  registrationNumber 
)
inline

FM direct command: GET fiscalization amount totals

RUS Protocol Command: 0xE8

FM Command: 0x43

Parameters
operatorPassword
registrationNumberregistration id number
Returns
APIFMResponse class type

◆ FMGetFormat()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetFormat ( string  operatorPassword)
inline

FM direct command: GET Format

RUS Protocol Command: 0xC3

FM Command: 0x3A

Parameters
operatorPassword
Returns
APIFMResponse class type

◆ FMGetFreeMemory()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetFreeMemory ( string  operatorPassword)
inline

FM direct command: GET Free Memory Resource

RUS Protocol Command: 0xC5

FM Command: 0x3D

Parameters
operatorPassword
Returns
APIFMResponse class type

◆ FMGetNotificationMC()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetNotificationMC ( string  operatorPassword)
inline

FM direct command: REQUEST NOTIFICATION OF MK

RUS Protocol Command: 0xCA

FM Command: 0xBA

Parameters
operatorPassword
Returns
APIFMResponse class type

◆ FMGetOperationCounter()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetOperationCounter ( string  operatorPassword,
Enums.FMCounterTypeEnum  counterType 
)
inline

FM direct command: GET Operation Counter

RUS Protocol Command: 0xC1

FM Command: 0x37

Parameters
operatorPassword
counterType
Returns
APIFMResponse class type

◆ FMGetRecentSessionParams()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetRecentSessionParams ( string  operatorPassword)
inline

FM direct command: GET recent session parameters

RUS Protocol Command: 0xEC

FM Command: 0x10

Parameters
operatorPassword
Returns
APIFMResponse class type

◆ FMGetRegistrationDocumentTVL()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetRegistrationDocumentTVL ( string  operatorPassword)
inline

FM direct command: GET Registration Document TVL

RUS Protocol Command: 0xC8

FM Command: 0x47

Parameters
operatorPassword
Returns
APIFMResponse class type

◆ FMGetSessionCounter() [1/2]

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetSessionCounter ( string  operatorPassword,
Enums.FMCounterTypeEnum  counterType 
)
inline

FM direct command: GET Session Counter

RUS Protocol Command: 0xC0

FM Command: 0x36

Parameters
operatorPassword
counterType
Returns
APIFMResponse class type

◆ FMGetSessionCounter() [2/2]

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetSessionCounter ( string  operatorPassword,
Enums.FMCounterTypeEnum  counterType,
Enums.FMOperationTypeEnum  operationType 
)
inline

FM direct command: GET Session Counter by Operation Type

RUS Protocol Command: 0xC2

FM Command: 0x38

Parameters
operatorPassword
counterType
operationType
Returns
APIFMResponse class type

◆ FMGetStatusMC()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetStatusMC ( string  operatorPassword)
inline

FM direct command: REQUEST OF FN STATUS ABOUT MK

RUS Protocol Command: 0xC9

FM Command: 0xB0

Parameters
operatorPassword
Returns
APIFMResponse class type

◆ FMGetTotalDataSize()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMGetTotalDataSize ( string  operatorPassword)
inline

FM direct command: GET Total Data Size

RUS Protocol Command: 0xC7

FM Command: 0xA7

Parameters
operatorPassword
Returns
APIFMResponse class type

◆ FMNotTrasminttedCounter()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMNotTrasminttedCounter ( string  operatorPassword)
inline

FM direct command: GET Counter for NOT Trasmitted Documents

RUS Protocol Command: 0xC6

FM Command: 0x39

Parameters
operatorPassword
Returns
APIFMResponse class type

◆ FMOfdStatus()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMOfdStatus ( string  operatorPassword)
inline

FM direct command: GET ODF Status

RUS Protocol Command: 0xE4

FM Command: 0x20

Parameters
operatorPassword
Returns
APIFMResponse class type

◆ FMRemainedValidity()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMRemainedValidity ( string  operatorPassword,
DateTime  date 
)
inline

FM direct command: Remained validity period request

RUS Protocol Command: 0xC4

FM Command: 0x3B

Parameters
operatorPassword
date
Returns
APIFMResponse class type

◆ FMSerialNumber()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMSerialNumber ( string  operatorPassword)
inline

FM direct command: GET Serial Number

RUS Protocol Command: 0xE1

FM Command: 0x31

Parameters
operatorPassword
Returns
APIFMResponse class type

◆ FMStatus()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMStatus ( string  operatorPassword)
inline

FM direct command: GET Status

RUS Protocol Command: 0xE0

FM Command: 0x30

Parameters
operatorPassword
Returns
APIFMResponse class type

Referenced by Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetLastFMReceiptData().

◆ FMVersion()

APIFMResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.FMVersion ( string  operatorPassword)
inline

FM direct command: GET FM Version

RUS Protocol Command: 0xE3

FM Command: 0x33

Parameters
operatorPassword
Returns
APIFMResponse class type

◆ GetCommunicationConfiguration()

APIGetCommunicationConfigurationResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetCommunicationConfiguration ( string  operatorPassword)
inline

Returns Printer general communication parameters

Parameters
operatorPassword
Returns
APIGetCommunicationConfigurationResponse class type

◆ GetDayTotalStatus()

APIDayTotalStatusResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetDayTotalStatus ( string  operatorPassword)
inline

Returns daily totals

RUS Protocol Command: 0xF6

Parameters
operatorPassword
Returns
APIDayTotalStatusResponse class type

◆ GetDepartmentTableRow()

APIGetDepartmentTableRowResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetDepartmentTableRow ( string  operatorPassword,
int  rowIndex 
)
inline

Returns a row of Department table

Parameters
operatorPassword
rowIndexIndex of the row
Returns
APIGetDepartmentTableRowResponse class type

◆ GetDrawerCounterStatus()

APIDrawerCounterStatusResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetDrawerCounterStatus ( string  operatorPassword)
inline

Returns cash in drawer counters

RUS Protocol Command: 0xFA

Parameters
operatorPassword
Returns
APIDrawerCounterStatusResponse class type

◆ GetECRInfo()

APIAdvancedResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetECRInfo ( string  operatorPassword,
int  destination 
)
inline

Get FM info

FAMILY CODE 701

Parameters
operatorPassword
destination0 - print info, 1 - send to PC
Returns
APIBaseResponse class type

◆ GetEjectorConfig()

APIGetEjectorConfigResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetEjectorConfig ( string  operatorPassword)
inline

Returns Ejector configuration papameters for VKP80III-F

Parameters
operatorPassword
Returns
APIGetEjectorConfigResponse class type

◆ GetEthernetConfiguration()

APIGetEthernetConfigurationResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetEthernetConfiguration ( string  operatorPassword)
inline

Returns Printer ethernet communication parameters

Parameters
operatorPassword
Returns
APIGetEthernetConfigurationResponse class type

◆ GetFDbyNumber()

APIAdvancedResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetFDbyNumber ( string  operatorPassword,
int  destination,
int  firstFD,
int  lastFD,
Enums.LastFiscalDocumentEnum  reportType 
)
inline

Get FM info

FAMILY CODE 784

Parameters
operatorPassword
destination0 - print info, 1 - send to PC
firstFDfist FD to print
lastFDlast FD to print
reportTypereport type: LastFiscalDocumentEnum 0 - short; 1 - full
Returns
APIAdvancedResponse class type

◆ GetFMInfo()

APIAdvancedResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetFMInfo ( string  operatorPassword,
int  destination,
Enums.FMInfoEnum  documentType 
)
inline

Get FM info

FAMILY CODE 783

Parameters
operatorPassword
destination0 - print info, 1 - send to PC
documentType0 - FM Status, 1 - Registration total, 2 - OFD State
Returns
APIBaseResponse class type

◆ GetFooterConfiguration()

APIGetHeaderConfigurationResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetFooterConfiguration ( string  operatorPassword)
inline

Returns trailer rows

Parameters
operatorPassword
Returns
APIGetHeaderConfigurationResponse class type

◆ GetFooterConfiguration_V2()

APIGetHeaderConfigurationResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetFooterConfiguration_V2 ( string  operatorPassword)
inline

Returns trailer rows for fw ver => 04.01.23

Parameters
operatorPassword
Returns
APIGetHeaderConfigurationResponse class type

◆ GetGrandTotalStatus()

APIGrandTotalStatusResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetGrandTotalStatus ( string  operatorPassword)
inline

Returns printer grand totals

RUS Protocol Command: 0xF5

Parameters
operatorPassword
Returns
APIGrandTotalStatusResponse class type

◆ GetHeaderConfiguration()

APIGetHeaderConfigurationResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetHeaderConfiguration ( string  operatorPassword)
inline

Returns header rows

Parameters
operatorPassword
Returns
APIGetHeaderConfigurationResponse class type

◆ GetHeaderConfiguration_V2()

APIGetHeaderConfigurationResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetHeaderConfiguration_V2 ( string  operatorPassword)
inline

Returns header rows for fw ver => 04.01.23

Parameters
operatorPassword
Returns
APIGetHeaderConfigurationResponse class type

◆ GetLastError()

APILastErrorResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetLastError ( string  operatorPassword)
inline

Get protocol last error code and description

RUS Protocol Command: 0xD7

Parameters
operatorPassword
Returns
APILastErrorResponse class type

◆ GetLastFMReceiptData()

APILastFMReceiptDataResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetLastFMReceiptData ( string  operatorPassword)
inline

Returns data stored in FM about last document

Parameters
operatorPassword
Returns
APILastFMReceiptDataResponse class type

◆ GetLastReceiptData()

APILastReceiptDataResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetLastReceiptData ( string  operatorPassword)
inline

Returns last document general data

RUS Protocol Command: 0xF4

Parameters
operatorPassword
Returns
APILastReceiptDataResponse class type

◆ GetNotTrasmittedCounterStatus()

APINotTrasmittedCounterStatusResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetNotTrasmittedCounterStatus ( string  operatorPassword)
inline

Returns not trasmitted amount counter totals

RUS Protocol Command: 0xF9

Parameters
operatorPassword
Returns
APINotTrasmittedCounterStatusResponse class type

◆ GetOFDConfiguration()

APIGetOFDConfigurationResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetOFDConfiguration ( string  operatorPassword)
inline

Returns OFD parameters

Parameters
operatorPassword
Returns
APIGetOFDConfigurationResponse class type

◆ GetOFDConfirmation()

APIAdvancedResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetOFDConfirmation ( string  operatorPassword,
int  destination,
int  firstFD,
int  lastFD 
)
inline

Get FM info

FAMILY CODE 787

Parameters
operatorPassword
destination0 - print info, 1 - send to PC
firstFDfist FD to print
lastFDlast FD to print
Returns
APIAdvancedResponse class type

◆ GetOperatorTableRow()

APIGetOperatorTableRowResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetOperatorTableRow ( string  operatorPassword,
int  rowIndex 
)
inline

Returns a row of Operator table

Parameters
operatorPassword
rowIndexIndex of the row
Returns
APIGetOperatorTableRowResponse class type

◆ GetPaymenytTableRow()

APIGetPaymentTableRowResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetPaymenytTableRow ( string  operatorPassword,
int  rowIndex 
)
inline

Returns a row of Paymenyt table

Parameters
operatorPassword
rowIndexIndex of the row
Returns
APIGetPaymentTableRowResponse class type

◆ GetPrinterDateTime()

APIGetDateResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetPrinterDateTime ( string  operatorPassword)
inline

Returns actual date and time stored on printer

RUS Protocol Command: 0xF0

Parameters
operatorPassword
Returns
APIGetDateResponse class type

◆ GetPrinterGeneralConfiguration()

APIGetGeneralConfigurationResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetPrinterGeneralConfiguration ( string  operatorPassword)
inline

Returns general configuration papameters

Parameters
operatorPassword
Returns
APIGetGeneralConfigurationResponse class type

◆ GetPrinterInfo()

APIPrinterInfoResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetPrinterInfo ( string  operatorPassword)
inline

Returns general printer info

RUS Protocol Command: 0xFF

Parameters
operatorPassword
Returns
APIPrinterInfoResponse class type

◆ GetPrinterParameters()

APIGetPrinterParamsResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetPrinterParameters ( string  operatorPassword)
inline

Returns print parameters

Parameters
operatorPassword
Returns
APIGetPrinterParamsResponse class type

◆ GetPrinterStatus()

APIPrinterStatusResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetPrinterStatus ( string  operatorPassword)
inline

Returns current printer status

RUS Protocol Command: 0xF1

Parameters
operatorPassword
Returns
APIPrinterStatusResponse class type

◆ GetReceiptStatus()

APIReceiptStatusResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetReceiptStatus ( string  operatorPassword)
inline

Returns current document status

RUS Protocol Command: 0xF3

0: not in progress 1: fiscal ticket open, no sale done 2: sale 3: payments 4: change print 5: fixed lines 6: closing executed 7: courtesy messages 8: ejection 9: not fiscal ticket open

Parameters
operatorPassword
Returns
APIReceiptStatusResponse class type

◆ GetRemoteServerSettings()

APIRemoteServerSettingsResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetRemoteServerSettings ( string  operatorPassword)
inline

REMOTE SERVER ACCES, FAMILY CODE 036 CHANNEL (1 byte, list) 0~DISABLED 1~OFD CHANNEL 2~FILE ONLY SERVER ADDRESS(64 bytes, text) TIME ZONA(1 byte, list) 2~КАЛИНИНГРАДСКОЕ ВРЕМЯ UTC+2 3~МОСКОВСКОЕ ВРЕМЯ UTC+3 4~САМАРСКОЕ ВРЕМЯ UTC+4 5~ЕКАТЕРИНБУРГСКОЕ ВРЕМЯ UTC+5 6~ОМСКОЕ ВРЕМЯ UTC+6 7~КРАСНОЯРСКОЕ ВРЕМЯ UTC+7 8~ИРКУТСКОЕ ВРЕМЯ UTC+8 9~ЯКУТСКОЕ ВРЕМЯ UTC+9 10~ВЛАДИВОСТОКСКОЕ ВРЕМЯ UTC+10 11~МАГАДАНСКОЕ ВРЕМЯ UTC+11 12~КАМЧАТСКОЕ ВРЕМЯ UTC+12 BA USER(64 bytes, text) BA PASSWORD(64 bytes, text) TIME EVENT PERIOD(4 bytes, unsigned long). Range: from 60(1 hour) to 2976(2days) EVENT(4 bytes, unsigned long). Settable from bit 0 to 3. INTERNAL EVENT(4 bytes, unsigned long). Settable from bit 0 to 17. ACCESS LEVEL(4 bytes, unsigned long). Settable from bit 0 to 5. ENABLE LOG(4 bytes, unsigned long). Settable from bit 0 to 2. OPERATION(4 bytes, list) 0~NO OPERATIONS 1~DELETE RAM LOG GROUP(32 bytes, text) DEV/ACT STATUS TIMEOUT(2 bytes, unsigned short) DEV/ACT STATUS # OF ATTEMPTS(2 bytes, unsigned short) FIRMWARE FILE DOWNLOAD TIMEOUT(2 bytes, unsigned short) FIRMWARE FILE DOWNLOAD # OF ATTEMPTS(2 bytes, unsigned short)

◆ GetStatisticAllowedData()

APIStatisticAllowedDataResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetStatisticAllowedData ( string  operatorPassword)
inline

Get Allowed field list for current ECR status

RUS Protocol Command: 0xFE

Parameters
operatorPassword
Returns
APIStatisticAllowedDataResponse class type

◆ GetStatisticDiscountReport()

APIStatisticDiscountReportResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetStatisticDiscountReport ( string  operatorPassword,
int  rowNumber 
)
inline

Returns a discount report list

RUS Protocol Command: 0xFC

Parameters
operatorPassword
rowNumberNumber of row
Returns
APIStatisticDiscountReportResponse class type

◆ GetStatisticReport()

APIStatisticReportResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetStatisticReport ( string  operatorPassword,
Enums.StatisticReportEnum  reportType,
int  departmentRowNumber 
)
inline

Returns an amount report list

RUS Protocol Command: 0xFB

Parameters
operatorPassword
reportTypeReport type
departmentRowNumberNumber of row
Returns
APIStatisticReportResponse class type

◆ GetTicketConfigurationParameters()

APIGetTicketConfigurationParamsResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetTicketConfigurationParameters ( string  operatorPassword)
inline

Returns ticket parameters

Parameters
operatorPassword
Returns
APIGetTicketConfigurationParamsResponse class type

◆ GetTicketInfo()

APITicketInfoResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetTicketInfo ( string  operatorPassword)
inline

Returns ticket info

RUS Protocol Command: 0xF8

Parameters
operatorPassword
Returns
APITicketInfoResponse class type

◆ GetTicketTotalStatus()

APITicketTotalStatusResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetTicketTotalStatus ( string  operatorPassword)
inline

Returns current ticket totals

RUS Protocol Command: 0xF7

Parameters
operatorPassword
Returns
APITicketTotalStatusResponse class type

◆ GetTK302EthernetConfiguration()

APIGetTK302EthernetConfigurationResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetTK302EthernetConfiguration ( string  operatorPassword)
inline

Returns Printer ethernet communication parameters

Parameters
operatorPassword
Returns
APIGetTK302EthernetConfigurationResponse class type

◆ GetTK302PaperConfiguration()

APIGetTK302PaperConfigurationResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetTK302PaperConfiguration ( string  operatorPassword)
inline

Returns TK302-FB RS232 communication parameters

Parameters
operatorPassword
Returns
APIGetTK302USBConfigurationResponse class type

◆ GetTK302RS232Configuration()

APIGetTK302RS232ConfigurationResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetTK302RS232Configuration ( string  operatorPassword)
inline

Returns TK302-FB RS232 communication parameters

Parameters
operatorPassword
Returns
APIGetTK302RS232ConfigurationResponse class type

◆ GetTK302USBConfiguration()

APIGetTK302USBConfigurationResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetTK302USBConfiguration ( string  operatorPassword)
inline

Returns TK302-FB RS232 communication parameters

Parameters
operatorPassword
Returns
APIGetTK302USBConfigurationResponse class type

◆ GetUSBProfileConfiguration()

APIGetUSBProfileConfigurationResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetUSBProfileConfiguration ( string  operatorPassword)
inline

Returns USB Profile parameters

Parameters
operatorPassword
Returns
APIGetUSBProfileConfigurationResponse class type

◆ GetVATTable()

APIGetVATTableResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetVATTable ( string  operatorPassword)
inline

Returns VAT table array value

Parameters
operatorPassword
Returns
APIGetVATTableResponse class type

◆ GetWifiConfiguration()

APIGetWiFiConfigurationResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GetWifiConfiguration ( string  operatorPassword)
inline

Returns WiFi parameters

Parameters
operatorPassword
Returns
APIGetWiFiParamsResponse class type

◆ GraphicTicketBarcode1D()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GraphicTicketBarcode1D ( string  operatorPassword,
bool  Print,
bool  SaveOnFile,
int  Rotation,
int  positionX,
int  positionY,
int  height,
int  scale,
int  alignment,
Enums.Barcode1DTypeEnum  barcodeType,
string  text 
)
inline

Insert Barcode from Library 1 - Fast barcode library

RUS Protocol Command: 0xB4

Parameters
operatorPassword
PrintDefines ticket name and path
SaveOnFileSave to bitmap
RotationDefines ticket rotation 0 - no Rotation, 1 - 90, 2 - 180, 3 - 270
positionX“Bitmap size X - 1”: barcode alignment coordinate
positionY“Bitmap size Y - 1”: barcode alignment coordinate
heightBarcode height
scaleBarcode scale
alignmentBarcode position (0: left; 1: right)
barcodeTypeBarcode type
textText to print into barcode
Returns
APIBaseResponse class type

◆ GraphicTicketBarcodeQR()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GraphicTicketBarcodeQR ( string  operatorPassword,
bool  Print,
bool  SaveOnFile,
int  Rotation,
int  positionX,
int  positionY,
int  scale,
string  text 
)
inline

Insert Compact QR Code to Graphic Ticket from Library 3

RUS Protocol Command: 0xB6

Parameters
operatorPassword
PrintDefines ticket name and path
SaveOnFileSave to bitmap
RotationDefines ticket rotation 0 - no Rotation, 1-90, 2 - 180, 3 - 270
positionX"Bitmap size X - 1": barcode alignment coordinate
positionY"Bitmap size Y - 1": barcode alignment coordinate
scaleBarcode scale
textText to print into barcode, 1...256
Returns
APIBaseResponse class type

◆ GraphicTicketClose()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GraphicTicketClose ( string  operatorPassword,
bool  Print,
bool  saveOnFile,
bool  cutPaper 
)
inline

Close Graphic Ticket and print

RUS Protocol Command: 0xB1

Parameters
operatorPassword
PrintDefines Print ticket on paper
saveOnFileDefines save ticket bitmap in printer memory
cutPaperDefines cut ticket after printing
Returns
APIBaseResponse class type

◆ GraphicTicketLine()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GraphicTicketLine ( string  operatorPassword,
bool  Print,
bool  SaveOnFile,
int  LineX1,
int  LineY1,
int  LineX2,
int  LineY2,
int  LineWidth,
int  LineReverse,
int  LinePattern,
int  FillingPattern 
)
inline

Add Line/Frame to Graphic Ticket

RUS Protocol Command: 0xB2

Parameters
operatorPassword
PrintDefines Print line on paper
SaveOnFileDefines save line bitmap in printer memory
LineX10..."Bitmap size X-1": if X1==X2 or Y1==Y2 a line will be drawn
LineY10..."Bitmap size Y-1"
LineX20..."Bitmap size X-1"
LineY20..."Bitmap size Y-1"
LineWidth1...16: for the frames, the line thickness is developed inwards; downwards for horizontal lines and to the right for vertical lines
LineReverseReverse line: valid only for lines; the line thickness is developed upwards and to the left. 0 -..., 1 -...
LinePatternReserved
FillingPatternvalid only for frames: 0 - white, 1 - black
Returns
APIBaseResponse class type

◆ GraphicTicketOpen()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GraphicTicketOpen ( string  operatorPassword,
string  ticketName,
bool  ticketRotation,
int  ticketXSize,
int  ticketYSize 
)
inline

Open Graphic Ticket

RUS Protocol Command: 0xB0

Parameters
operatorPassword
ticketNameDefines ticket name and path
ticketRotationDefines ticket rotation 0-horizontal, 1-vertical
ticketXSizeDefines ticket bitmap size X 8...576
ticketYSizeDefines ticket bitmap size Y 8...2048
Returns
APIBaseResponse class type

◆ GraphicTicketText()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.GraphicTicketText ( string  operatorPassword,
bool  Print,
bool  SaveOnFile,
int  TextRotation,
int  TextX,
int  TextY,
int  TextScaleX,
int  TextScaleY,
int  FontSize,
int  FontStyle,
string  Text 
)
inline

Add Text to Graphic Ticket

RUS Protocol Command: 0xB7

Parameters
operatorPassword
PrintPrint on printer, but not save text
SaveOnFileSave text on File
TextRotation0…3 relatively to the orientation set with the open command: 0->no rotation, 1->rotate 90°, 2->rotate 180°, 3->rotate 270°
TextX0.. "Bitmap size X - 1": coordinate of the upper left corner of the rotated text
TextY0.. "Bitmap size Y - 1": coordinate of the upper left corner of the rotated text
TextScaleX1…8
TextScaleY1…8
FontSizeChars 01..05 change the font of the following bytes.
FontStyle10 - bold, 11 - no bold, 12 - italic, 13 - no italic
Text1 to 256 bytes
Returns
APIBaseResponse class type

◆ InsertBitmapToGraphicTicket()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.InsertBitmapToGraphicTicket ( string  operatorPassword,
bool  Print,
bool  SaveOnFile,
int  Rotatoin,
int  BitmapX,
int  BitmapY,
int  BitmapIndex,
int  ScaleX,
int  ScaleY 
)
inline

Insert Bitmap in Graphic Ticket

RUS Protocol Command: 0xB3

Parameters
operatorPassword
PrintDefines Print line on paper
SaveOnFileDefines save line bitmap in printer memory
Rotatoin0...3 relatively to the orientation set with the open command. 0->no rotation, 1->rotate 90Р’В°, 2->rotate 180Р’В°, 3->rotate 270Р’В°
BitmapX0..."Bitmap size X - 1": coordinate of the upper left corner of the rotated bitmap
BitmapY0..."Bitmap size Y - 1": coordinate of the upper left corner of the rotated bitmap
BitmapIndexBitmap number 1...25
ScaleXDefines bitmap scale X: 1...8
ScaleYDefines bitmap scale Y: 1...8
Returns
APIBaseResponse class type

◆ InsertLineToGraphicTicket()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.InsertLineToGraphicTicket ( string  operatorPassword,
bool  Print,
bool  SaveOnFile,
int  Rotation,
int  positionX,
int  positionY,
Enums.Barcode2DTypeEnum  CodeType,
int  scale,
int  Flags,
string  text 
)
inline

Insert Barcode from Library 2 - Extended barcode Library

RUS Protocol Command: 0xB5

Parameters
operatorPassword
PrintDefines ticket name and path
SaveOnFileSave to bitmap
RotationDefines ticket rotation 0 - no Rotation, 1 - 90, 2 - 180, 3 - 270
positionX“Bitmap size X - 1”: coordinate of the upper left corner of the rotated barcode
positionY“Bitmap size Y - 1”: coordinate of the upper left corner of the rotated barcode
CodeTypeQR-Code type: 6: QRCODE, 7: GS1DATABAR, 8: PDF417
scaleBarCode scale, value expressed in tenths
FlagsReserved
textText to print into barcode 1...256
Returns
APIBaseResponse class type

◆ ItemModifier()

APIItemModifierResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.ItemModifier ( string  operatorPassword,
bool  isAddOn,
bool  isPercentage,
bool  printSubtotal,
long  amount,
string  decription 
)
inline

Perform an Item Modifier

RUS Protocol Command: 0x90

Parameters
operatorPassword
isAddOnUse 'false' to execute a Discount, 'true' to execute an Add-On
isPercentageUse 'false' to use an Absolute Amount, 'true' to use a Percentage Value
printSubtotalSet if Subtotal Line Must be Printed
amountvalue of the Modifier
decription
Returns
APIItemModifierResponse class type

◆ MCConfirmationForMC()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.MCConfirmationForMC ( string  operatorPassword,
Enums.MCConfirmationEnum  MCConfirmation 
)
inline

Confirmation for Marking Codes

RUS Protocol Command: 0x92

Parameters
operatorPasswordOperator password
confirmationCodeConfirmation code: 1=confirm sale, 2=exclude sale from ticket, 2=ticket cancel
Returns
APIBaseResponse class type

◆ OpenConnection()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.OpenConnection ( )
inline

Open communication channel between library and printer

Returns
APIBaseResponse class type

◆ OpenCorrectionDocument() [1/2]

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.OpenCorrectionDocument ( string  operatorPassword,
bool  print,
bool  saveOnFile,
Enums.CorrectionReceiptTypeEnum  docType,
Enums.TaxCodeEnum  taxCode,
Enums.CorrectionTypeEnum  correctionType,
string  reason,
DateTime  reasonDate,
string  reasonDocNumber 
)
inline

Initiates a new Correction Document

RUS Protocol Command: 0xD6

Parameters
operatorPassword
printExecute physical print on paper
saveOnFileSave the document on a file
Parameters
docTypeType of document to correct
taxCodeTax code class
correctionTypeType of correction
reasonReason for correction
reasonDateDate of the reason of correction
reasonDocNumberDocument number of the reason of correction
Returns
APIBaseResponse class type

◆ OpenCorrectionDocument() [2/2]

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.OpenCorrectionDocument ( string  operatorPassword,
bool  print,
bool  saveOnFile,
Enums.CorrectionReceiptTypeEnum  docType,
Enums.TaxCodeEnum  taxCode,
Enums.CorrectionTypeEnum  correctionType,
string  reason,
DateTime  reasonDate,
string  reasonDocNumber,
bool  saveOnSD,
bool  saveTXT,
bool  saveTXTonSD 
)
inline

Initiates a new Correction Document

RUS Protocol Command: 0xD6

Parameters
operatorPassword
printExecute physical print on paper
saveOnFileSave the document on a file
Parameters
docTypeType of document to correct
taxCodeTax code class
correctionTypeType of correction
reasonReason for correction
reasonDateDate of the reason of correction
reasonDocNumberCocument number of the reason of correction
saveOnSD
saveTXT
saveTXTonSD
Returns
APIBaseResponse class type

◆ OpenFiscalDay() [1/4]

APIOpenFiscalDayResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.OpenFiscalDay ( string  operatorPassword,
bool  print,
bool  saveOnFile 
)
inline

Open Fiscal Day on Printer

RUS Protocol Command: 0xD9

Parameters
operatorPassword
printExecute physical print on paper
saveOnFileSave data on a file
Returns
APIOpenFiscalDayResponse class type

◆ OpenFiscalDay() [2/4]

APIOpenFiscalDayResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.OpenFiscalDay ( string  operatorPassword,
bool  print,
bool  saveOnFile,
bool  saveOnSD,
bool  saveTXT,
bool  saveTXTonSD 
)
inline

Open Fiscal Day on Printer (new command format with flag "Save to SD")

RUS Protocol Command: 0xD9

Parameters
operatorPassword
printExecute physical print on paper
saveOnFileSave .spl document on a file
saveOnSDSave .spl document on SD Card for TK, K3, FUSION
saveTXTSave .txt document on a file
saveTXTonSDSave .txt document on SD Card for TK, K3, FUSION
Returns
APIOpenFiscalDayResponse class type

◆ OpenFiscalDay() [3/4]

APIOpenFiscalDayResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.OpenFiscalDay ( string  operatorPassword,
bool  print,
bool  saveOnFile,
bool  saveOnSD,
bool  saveTXT,
bool  saveTXTonSD,
bool  hasAddressOfPayment,
string  addressOfPayment,
bool  hasPlaceOfPayment,
string  placeOfPayment 
)
inline

Open Fiscal Day on Printer (new command format with flag "Save to SD") Command format for Addres and Place of Payments

RUS Protocol Command: 0xD9

Parameters
operatorPassword
printExecute physical print on paper
saveOnFileSave .spl document on a file
saveOnSDSave .spl document on SD Card for TK, K3, FUSION
saveTXTSave .txt document on a file
saveTXTonSDSave .txt document on SD Card for TK, K3, FUSION
hasAddressOfPaymentflag for Address of Payment
addressOfPaymentAddress of Payment
hasPlaceOfPaymentflag for Place of Payment
placeOfPaymentPlace Of Payment
Returns
APIOpenFiscalDayResponse class type

◆ OpenFiscalDay() [4/4]

APIOpenFiscalDayResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.OpenFiscalDay ( string  operatorPassword,
bool  print,
bool  saveOnFile,
bool  saveOnSD,
bool  saveTXT,
bool  saveTXTonSD,
bool  hasAddressOfPayment,
string  addressOfPayment,
bool  hasPlaceOfPayment,
string  placeOfPayment,
bool  hasPropOfSession_1276,
string  PropOfSession_1276,
bool  hasDataOfSession_1277,
List< byte >  DataOfSession_1277 
)
inline

Open Fiscal Day on Printer for FFD 1.2 Command format for Addres and Place of Payments

RUS Protocol Command: 0xD9

Parameters
operatorPassword
printExecute physical print on paper
saveOnFileSave .spl document on a file
saveOnSDSave .spl document on SD Card for TK, K3, FUSION
saveTXTSave .txt document on a file
saveTXTonSDSave .txt document on SD Card for TK, K3, FUSION
hasAddressOfPaymentflag for Address of Payment
addressOfPaymentAddress of Payment
hasPlaceOfPaymentflag for Place of Payment
placeOfPaymentPlace Of Payment
hasPropOfSessionADD.PROP.OF SESSION CLOSE REP (#1278) is present
PropOfSessionPROP.OF SESSION CLOSE REP (#1278)
hasDataOfSessionADD.DATA OF SESSION CLOSE REP (#1279) is present
DataOfSessionDATA OF SESSION CLOSE REP (#1279)
Returns
APIOpenFiscalDayResponse class type

◆ OpenFiscalDocument() [1/2]

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.OpenFiscalDocument ( string  operatorPassword,
bool  print,
bool  saveOnFile,
Enums.ReceiptTypeEnum  docType,
Enums.TaxCodeEnum  taxCode 
)
inline

Initiates a new fiscal document of a given type

RUS Protocol Command: 0x8D

Parameters
operatorPassword
printExecute physical print on paper
saveOnFileSave the document on a file
docTypeSets if the receipt is a sale, a purchase, a sale return or a purchase return document
taxCodeSets the tax code nature
Returns
APIBaseResponse class type

◆ OpenFiscalDocument() [2/2]

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.OpenFiscalDocument ( string  operatorPassword,
bool  print,
bool  saveOnFile,
Enums.ReceiptTypeEnum  docType,
Enums.TaxCodeEnum  taxCode,
bool  saveOnSD,
bool  saveTXT,
bool  saveTXTonSD 
)
inline

Initiates a new fiscal document of a given type (new format with flag "Save on SD"

RUS Protocol Command: 0x8D

Parameters
operatorPassword
printExecute physical print on paper
saveOnFileSave .spl document on a file
docTypeSets if the receipt is a sale, a purchase, a sale return or a purchase return document
taxCodeSets the tax code nature
saveOnSDSave .spl document on SD Card for TK, K3, FUSION
saveTXTSave .txt document on a file
saveTXTonSDSave .txt document on SD Card for TK, K3, FUSION
Returns
APIBaseResponse class type

◆ OpenNotFiscalDocument()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.OpenNotFiscalDocument ( string  operatorPassword,
bool  printOperator,
bool  printSerialNum,
bool  printHeader,
bool  printDateTime 
)
inline

Initiates a not fiscal ticket

RUS Protocol Command: 0xDA

Parameters
operatorPassword
printOperatorDefines if operator info is printed on ticket
printSerialNumDefines if serial number is printed on ticket
printHeaderDefines if header lines are printed on ticket
printDateTimeDefines if date and time info are printed on ticket
Returns
APIBaseResponse class type

◆ PaperCut()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.PaperCut ( string  operatorPassword)
inline

Performs a paper cut

RUS Protocol Command: 0xDC

Parameters
operatorPassword
Returns
APIBaseResponse class type

◆ PrintBarcode1D()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.PrintBarcode1D ( string  operatorPassword,
int  height,
int  scale,
Enums.BarcodePositionEnum  position,
Enums.Barcode1DTypeEnum  barcodeType,
bool  noAscii,
bool  noChecksum,
bool  textDoubleHeight,
bool  noHeaderNoFooter,
string  text 
)
inline

Prints a barcode 1D on document

RUS Protocol Command: 0xDE

Parameters
operatorPassword
heightBarcode height
scaleBarcode scale
positionBarcode position (0: left; 1: center; 2: right)
barcodeTypeBarcode type
noAsciiNo ascii data
noChecksumNo checksum data
textDoubleHeightDouble Height text style
noHeaderNoFooterNo header nor footer style
textText to print into barcode
Returns
APIBaseResponse class type

◆ PrintBarcode2D()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.PrintBarcode2D ( string  operatorPassword,
int  scale,
Enums.Barcode2DTypeEnum  barcodeType,
int  type,
String  inputText 
)
inline

Prints a barcode 2D on document

RUS Protocol Command: 0xDE

Parameters
operatorPassword
scaleBarcode scale
barcodeTypeBarcode type
typeFlag for type field
inputTextText to print into barcode
Returns
APIBaseResponse class type

◆ PrintBarcodeCompact()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.PrintBarcodeCompact ( string  operatorPassword,
int  scale,
string  text 
)
inline

Prints a barcode with compact library

RUS Protocol Command: 0xDE

Parameters
operatorPassword
scaleBarcode scale
textText to print into barcode
Returns
APIBaseResponse class type

◆ PrinterReboot()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.PrinterReboot ( string  operatorPassword)
inline

Printer performs a reboot

RUS Protocol Command 0x16 with params 0x80->just restart the printer (as powering on->off->on);

Parameters
operatorPassword
Returns
APIBaseResponse class type

◆ PrintIcon()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.PrintIcon ( string  operatorPassword,
int  iconNumber,
int  windowHeight,
int  startX,
int  startY 
)
inline

Prints an image icon on document

RUS Protocol Command: 0xDD

Parameters
operatorPassword
iconNumberIcon id to print (1..25)
windowHeightHeight of the area where the image is printed
startXPrint start X coordinate (must be multiple of 8)
startYPrint start Y coordinate
Returns
APIBaseResponse class type

◆ PrintText()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.PrintText ( string  operatorPassword,
bool  doubleWidth,
bool  automaticNewLine,
bool  halfWidth,
bool  doubleHeigth,
bool  border,
bool  halfHeigth,
bool  bold,
bool  italic,
Enums.FontSizeEnum  fontSize,
string  text 
)
inline

Prints a not fiscal line

RUS Protocol Command: 0xDB

Parameters
operatorPassword
doubleWidthDouble Width style
automaticNewLineAutomatic new line at space
halfWidthHalf Width style
doubleHeigthDouble Heigth style
borderText border
halfHeigthHalf Heigth style
boldBold style
italicItalic style
fontSizesize of Font 01...05. If not set, using default Font
textText to print
Returns
APIBaseResponse class type

◆ RepeatDocument()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.RepeatDocument ( string  operatorPassword,
int  firstTicketToPrint,
int  lastTicketToPrint,
Enums.RepeatDocumentEnum  documentType 
)
inline

Re-prints last receipt

RUS Protocol Command: 0x8C

Parameters
operatorPassword
firstTicketToPrintFirst ticket to print
lastTicketToPrintLast ticket to print
documentTypeClass of the document to repeat
Returns
APIBaseResponse class type

◆ SendOFDData() [1/2]

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SendOFDData ( string  operatorPassword,
Enums.OFDDataTypeEnum  dataType,
string  data 
)
inline

Send OFD data

RUS Protocol Command: 0xD8

FFD 1.0

Parameters
operatorPassword
dataTypeType of the OFD data
dataData in string format
Returns

◆ SendOFDData() [2/2]

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SendOFDData ( string  operatorPassword,
Enums.OFDDataTypeEnum  dataType,
int  dataLength,
byte []  data 
)
inline

Send OFD data

RUS Protocol Command: 0xD8

FFD 1.05 and 1.1

Parameters
operatorPassword
dataTypeType of the OFD data
dataLengthLength of data array
dataData array
Returns
APIBaseResponse class type

◆ SendSveltaLines()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SendSveltaLines ( string  operatorPassword,
string []  values,
Custom.Fiscal.RUSProtocolAPI.Enums.SveltaTicketTypeEnum  dataType 
)
inline

Send SVELTA lines to printer

TK302 PRINTER see Commands Manual

Parameters
operatorPassword
valuesString in SVELTA format. see APPENDIX A5 in Commands Manual
dataTypeSvelta ticket type: 0: Full, 1: Open, 2: Sell, 3: close, 99: File
Returns
APIBaseResponse class type

◆ SetCommunicationConfiguration()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetCommunicationConfiguration ( string  operatorPassword,
Enums.ProtocolEnum  protocol,
int  baudrate,
int  bitNumber,
bool  txFooter,
bool  txEcho,
Enums.HandshakeEnum  handshake,
bool  displayLine,
Enums.PCChannelTypeEnum  pcChannel,
Enums.PaperMissingEnum  paperMissing 
)
inline

Writes communication parameters

FAMILY CODE 910

For parameters range value see description of APIGetCommunicationConfigurationResponse class

Parameters
operatorPassword
protocolProtocol value
baudrateBaudrate value
bitNumberRS232 settings
txFooterXON\XOFF TX Footer enabled
txEchoXON\XOFF TX Echo enabled
handshakeRS232 handshake type
displayLineDisplay sale line
pcChannelChannel type for communication with PC
paperMissingSettings for Paper Missing Management
Returns
APIBaseResponse class type

◆ SetDepartmentTableRow()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetDepartmentTableRow ( string  operatorPassword,
int  rowIndex,
APIDepartment  value 
)
inline

Writes values in Department table

FAMILY CODE 120

For parameters range value see description of APIDepartment class

Parameters
operatorPassword
rowIndexIndex of the row to update
valueNew department row element
Returns
APIBaseResponse class type

◆ SetEjectorConfig()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetEjectorConfig ( string  operatorPassword,
int  TicketMode,
bool  Presentation,
bool  Ejection,
int  Direction 
)
inline

Writes Ejector configuration papameters for VKP80III-F

Family code 671

Parameters
operatorPasswordOperator Password
TicketModeTicket mode param: 0-Normal; 1-Collect; 2-FeedAway; 3-LoopAway
PresentationPresentation: true - Enable; false - Disable
EjectionPresentation: true - Enable; false - Disable
DirectionDirection param: 0-Backward; 1-Forward
Returns
APIBaseResponse class type

◆ SetEthernetConfiguration()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetEthernetConfiguration ( string  operatorPassword,
bool  dhcpEnabled,
IPAddress  address,
IPAddress  netMask,
IPAddress  gateway,
IPAddress  dns,
int  port 
)
inline

Writes ethernet parameters

FAMILY CODE 911

For parameters range value see description of APIGetEthernetConfigurationResponse class

Parameters
operatorPassword
dhcpEnabledDHCP enabled
addressIP address
netMaskNet mask
gatewayGateway
dnsDNS
portIP port
Returns
APIBaseResponse class type

◆ SetFooterConfiguration()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetFooterConfiguration ( string  operatorPassword,
APITkRow []  items 
)
inline

Writes Trailer table values

FAMILY CODE 923

For parameters range value see description of APITkRow class

Note
All the elements must be passed
Parameters
operatorPassword
itemsArray of ticket row values
Returns
APIBaseResponse class type

◆ SetFooterConfiguration_V2()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetFooterConfiguration_V2 ( string  operatorPassword,
APITkRow []  items 
)
inline

Writes Trailer table values for fw => 04.01.23

FAMILY CODE 923

For parameters range value see description of APITkRow class

Note
All the elements must be passed
Parameters
operatorPassword
itemsArray of ticket row values
Returns
APIBaseResponse class type

◆ SetHeaderConfiguration()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetHeaderConfiguration ( string  operatorPassword,
APITkRow []  items 
)
inline

Writes Header table values

FAMILY CODE 921

For parameters range value see description of APITkRow class

Note
All the elements must be passed
Parameters
operatorPassword
itemsArray of ticket row values
Returns
APIBaseResponse class type

◆ SetHeaderConfiguration_V2()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetHeaderConfiguration_V2 ( string  operatorPassword,
APITkRow []  items 
)
inline

Writes Header table V2 values

FAMILY CODE 921

For parameters range value see description of APITkRow class

Note
All the elements must be passed
Parameters
operatorPassword
itemsArray of ticket row values
Returns
APIBaseResponse class type

◆ SetOFDConfiguration() [1/4]

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetOFDConfiguration ( string  operatorPassword,
string  webSiteUrl,
int  webSitePort,
Enums.FDOChannelEnum  channel,
int  timerFN,
int  timerC,
int  timerACK,
uint  ofdConfiguration 
)
inline

Writes OFD table values for Q3X-F and TK302-FB, data string length 141 bytes

FAMILY CODE 030

Parameters
operatorPassword
webSiteUrlUrl or IP of OFD server
webSitePortPort of OFD server
channelTransmission channel type
timerFNTimer FN: 1...60
timerCTimer C!: 1...3600
timerACKTimer ACK: 0...300
ofdConfigurationofd configuration, see FAMILY CODE 030 description in Commands Manual
Returns
APIBaseResponse class type

◆ SetOFDConfiguration() [2/4]

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetOFDConfiguration ( string  operatorPassword,
string  webSiteUrl,
int  webSitePort,
Enums.FDOChannelEnum  channel,
int  timerFN,
int  timerC,
int  timerACK,
uint  ofdConfiguration,
string  oismUrl,
int  oismPort,
int  oismTimeout1,
int  oismTimeout2,
string  web3Url,
int  web3Port,
int  web3Timeout1,
int  web3Timeout2 
)
inline

Writes OFD table values for FFD 1.2

FAMILY CODE 030

Parameters
operatorPassword
webSiteUrlUrl or IP of OFD server
webSitePortPort of OFD server
channelTransmission channel type
timerFNTimer FN: 1...60
timerCTimer C!: 1...3600
timerACKTimer ACK: 0...300
ofdConfigurationofd configuration, see FAMILY CODE 030 description in Commands Manual
oismUrlOISM server url or IP
oismPortOISM server Port
oismTimeout1OISM Server Timeout 1
oismTimeout2Oism Server Timeout 2
web3UrlWeb3 url or Port
web3PortWeb3 Port
web3Timeout1Web3 Timeout 1
web3Timeout2Web3 Timeout 2
Returns
APIBaseResponse class type

◆ SetOFDConfiguration() [3/4]

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetOFDConfiguration ( string  operatorPassword,
string  webSiteUrl,
int  webSitePort,
int  timerFN,
int  timerC,
int  timerACK,
uint  ofdConfiguration,
string  oismUrl,
int  oismPort,
int  oismTimeout1,
int  oismTimeout2,
string  web3Url,
int  web3Port,
int  web3Timeout1,
int  web3Timeout2 
)
inline

Writes OFD table values for FFD 1.2

FAMILY CODE 030

Parameters
operatorPassword
webSiteUrlUrl or IP of OFD server
webSitePortPort of OFD server
timerFNTimer FN: 1...60
timerCTimer C!: 1...3600
timerACKTimer ACK: 0...300
ofdConfigurationofd configuration, see FAMILY CODE 030 description in Commands Manual
oismUrlOISM server url or IP
oismPortOISM server Port
oismTimeout1OISM Server Timeout 1
oismTimeout2Oism Server Timeout 2
web3UrlWeb3 url or Port
web3PortWeb3 Port
web3Timeout1Web3 Timeout 1
web3Timeout2Web3 Timeout 2
Returns
APIBaseResponse class type

◆ SetOFDConfiguration() [4/4]

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetOFDConfiguration ( string  operatorPassword,
string  webSiteUrl,
int  webSitePort,
int  timerFN,
int  timerC,
int  timerACK,
uint  ofdConfiguration 
)
inline

Writes OFD table values for FUSION, data string length 140 bytes

FAMILY CODE 030

Parameters
operatorPassword
webSiteUrlUrl or IP of OFD server
webSitePortPort of OFD server
timerFNTimer FN: 1...60
timerCTimer C!: 1...3600
timerACKTimer ACK: 0...300
ofdConfigurationofd configuration, see FAMILY CODE 030 description in Commands Manual
Returns
APIBaseResponse class type

◆ SetOFDTagValue()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetOFDTagValue ( string  operatorPassword,
Enums.OFDDataTypeEnum  ofdDataType,
string  data 
)
inline

Write HD DN parameters

Parameters
operatorPassword
ofdDataTypeOFD data TAG
dataData to write
Returns
APIBaseResponse class type

◆ SetOperatorTableRow()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetOperatorTableRow ( string  operatorPassword,
int  rowIndex,
APIOperator  value 
)
inline

Writes values in Opeator table

FAMILY CODE 320

For parameters range value see description of APIOperator class

Parameters
operatorPassword
rowIndexIndex of the row to update
valueNew operator row element
Returns
APIBaseResponse class type

◆ SetPaymentTableRow()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetPaymentTableRow ( string  operatorPassword,
int  rowIndex,
APIPayment  value 
)
inline

Writes values in Payment table

FAMILY CODE 520

For parameters range value see description of APIPayment class

Parameters
operatorPassword
rowIndexIndex of the row to update
valueNew payment row element
Returns
APIBaseResponse class type

◆ SetPrinterGeneralConfiguration()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetPrinterGeneralConfiguration ( string  operatorPassword,
int  deviceModel,
int  mandatorySubtotal,
int  NegativeCashDrawer,
int  cashDrawerVoltage,
int  fpuMode,
int  ExtraInfo,
int  displayBacklight,
int  displayContrast 
)
inline

Write general configuration parameters

FAMILY CODE 019

For parameters range value see description of APIGetGeneralConfigurationResponse class

Parameters
operatorPassword
deviceModel1 - Q3X-F, 2 - FUSION, 3 - TK302-FB
mandatorySubtotalMandatory subtotal value
NegativeCashDrawerAllow negative CashDrawer
cashDrawerVoltageCash drawer voltage value: 0: 24V, 1: 12V, 2: 6V
fpuModeFPU Mode value
ExtraInfo
displayBacklight0...100
displayContrast0...9
Returns
APIBaseResponse class type

◆ SetPrinterParameters() [1/3]

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetPrinterParameters ( string  operatorPassword,
int  printEnergy,
int  printSpeed,
int  bottomLineFeed,
int  interlineCompression,
uint  ticketFormat,
int  cutterEnabled 
)
inline

Write print parameters

FAMILY CODE 018

For parameters range value see description of APIGetPrinterParamsResponse class

Parameters
operatorPassword
printEnergyPrint energy value
printSpeedPrint speed value
bottomLineFeedBottom line feed value
interlineCompressionInterline compression value
ticketFormatSet the ticket layout
cutterEnabledCutter enabled
Returns
APIBaseResponse class type

◆ SetPrinterParameters() [2/3]

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetPrinterParameters ( string  operatorPassword,
int  printEnergy,
int  printSpeed,
int  bottomLineFeed,
int  interlineCompression,
uint  ticketFormat,
Enums.DirectoryConfigurationEnum  directoryConfiguration,
Enums.FilenameConfigurationEnum  filenameConfiguration,
Enums.FilenameExtensionEnum  filenameExtension 
)
inline

Write print parameters vor VKP80III-F. No CUTTER parameter!!!

FAMILY CODE 018

For parameters range value see description of APIGetPrinterParamsResponse class

Parameters
operatorPassword
printEnergyPrint energy value
printSpeedPrint speed value
bottomLineFeedBottom line feed value
interlineCompressionInterline compression value
ticketFormatSet the ticket layout
directoryConfiguration
filenameConfiguration
filenameExtension
Returns
APIBaseResponse class type

◆ SetPrinterParameters() [3/3]

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetPrinterParameters ( string  operatorPassword,
int  printEnergy,
int  printSpeed,
int  bottomLineFeed,
int  interlineCompression,
uint  ticketFormat,
int  cutterEnabled,
Enums.DirectoryConfigurationEnum  directoryConfiguration,
Enums.FilenameConfigurationEnum  filenameConfiguration,
Enums.FilenameExtensionEnum  filenameExtension 
)
inline

Write print parameters

FAMILY CODE 018

For parameters range value see description of APIGetPrinterParamsResponse class

Parameters
operatorPassword
printEnergyPrint energy value
printSpeedPrint speed value
bottomLineFeedBottom line feed value
interlineCompressionInterline compression value
ticketFormatSet the ticket layout
cutterEnabledCutter enabled
directoryConfiguration
filenameConfiguration
filenameExtension
Returns
APIBaseResponse class type

◆ SetRemoteServerSettings()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetRemoteServerSettings ( string  operatorPassword,
ServerChannelEnum  ServerChannel,
string  ServerAddress,
ServerTimeZoneEnum  ServerTimeZone,
string  UserName,
string  Password,
uint  TimeEventPeriod,
uint  EventValue,
uint  InternalEventValue,
uint  ACLValue,
uint  EnableLogValue,
ServerOperationEnum  Operation,
string  Group,
int  ACTTimeout,
int  ACTAttempts,
int  FileTimeout,
int  FileAttempts 
)
inline

Set Remote Server Cofiguration for Monitoring service

Parameters
operatorPassword
Returns
APIBaseResponse class type

◆ SetTicketConfigurationParameters()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetTicketConfigurationParameters ( string  operatorPassword,
bool  asyncPrint,
bool  cancelledDocPrint,
bool  notFiscTicketHeader,
bool  printPluCode,
bool  printSubtotal,
bool  printNumPieces,
bool  printOnlyIfNotZero,
bool  printPeriodical,
bool  printOperator,
bool  printUnitQty,
bool  ticketCopy,
bool  printDetailVat,
bool  saveTicketBmp 
)
inline

Write ticket parameters

FAMILY CODE 020

Parameters
operatorPassword
asyncPrintPrint in Asyncronous Mode
cancelledDocPrintPrint Cancelled Documents
notFiscTicketHeaderPrint Header on Not Fiscal Ticket
printPluCodePrint PLU Code
printSubtotalPrint Subtotal
printNumPiecesPrint Number of Pieces
printOnlyIfNotZeroPrint the Item Only if Amount is Not 0
printPeriodicalPrint Periodical Report
printOperatorPrint Operator Info
printUnitQtyQuantity 1 Print 1x
ticketCopyPrint Ticket Copy
printDetailVatPrint VAT Detail
saveTicketBmpSave icket on .bmp File
Returns
APIBaseResponse class type

◆ SetTK302EthernetConfiguration()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetTK302EthernetConfiguration ( string  operatorPassword,
bool  dhcpEnabled,
string  printerName,
IPAddress  address,
IPAddress  netMask,
IPAddress  gateway,
IPAddress  dns1,
IPAddress  dns2,
int  port 
)
inline

Writes ethernet parameters for TK302-FB

FAMILY CODE 911

For parameters range value see description of APIGetTK302EthernetConfigurationResponse class

Parameters
operatorPassword
dhcpEnabledDHCP enabled
printerNamePrinter Name
addressIP address
netMaskNet mask
gatewayGateway
dns1DNS1
dns2DNS2
portIP port
Returns
APIBaseResponse class type

◆ SetTK302PaperConfiguration()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetTK302PaperConfiguration ( string  operatorPassword,
bool  cutterEnabled,
int  paperWidth,
int  charsInch,
int  printDensity,
int  speed 
)
inline

Writes paper parameters, Family 10182, 10119, 10114, 10200, 10115

FAMILY CODE 10001...10005

For parameters range value see description of APIGetTK302RS232ConfigurationResponse class

Parameters
operatorPassword
cutterEnabledcutter Enabled. Family 10182
paperWidthpaper width. Family 10119
charsInchchars/inch. Family 10114
printDensityprint Density. Family 10200
speedSpeed/Quality. Family 10115
Returns
APIBaseResponse class type

◆ SetTK302RS232Configuration()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetTK302RS232Configuration ( string  operatorPassword,
int  baudRate,
int  dataLength,
int  Parity,
Enums.TK302HandshakeEnum  handshake,
int  busyCondition 
)
inline

Writes RS232 parameters

FAMILY CODE 10001...10005

For parameters range value see description of APIGetTK302RS232ConfigurationResponse class

Parameters
operatorPassword
baudRateBaudrate value
dataLengthdata Length
ParityRS232 Parity
handshakeRS232 handshake type
busyConditionRS232 Busy Condition
Returns
APIBaseResponse class type

◆ SetTK302USBConfiguration()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetTK302USBConfiguration ( string  operatorPassword,
int  usbAddress,
Enums.TK302UsbClassEnum  usbClass 
)
inline

Writes RS232 parameters

FAMILY CODE 10001...10005

For parameters range value see description of APIGetTK302RS232ConfigurationResponse class

Parameters
operatorPassword
usbClassBaudrate value
usbAddressdata Length
Returns
APIBaseResponse class type

◆ SetUSBProfileConfiguration()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetUSBProfileConfiguration ( string  operatorPassword,
Enums.UsbProfileEnum  profile 
)
inline

Set USB profile for printer

FAMILY CODE 647

Parameters
operatorPassword
profileUSB Profile
Returns
APIBaseResponse class type

◆ SetVATTable()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetVATTable ( string  operatorPassword,
int []  items 
)
inline

Writes VAT table values

FAMILY CODE 016

Note
All the elements must be passed
Parameters
operatorPassword
itemsArray of vat values
Returns
APIBaseResponse class type

◆ SetWifiConfiguration()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SetWifiConfiguration ( string  operatorPassword,
bool  wifiEnabled,
string  ssid,
Enums.SecurityTypeEnum  security,
string  password,
bool  dhcpEnabled,
IPAddress  address,
IPAddress  netMask,
IPAddress  gateway,
IPAddress  dns,
int  port 
)
inline

Writes wifi parameters

FAMILY CODE 912

For parameters range value see description of APIGetWifiConfigurationResponse class

Parameters
operatorPassword
wifiEnabledWi-Fi feature is enabled
ssidSSID name
securitySecurity type
passwordPassword
dhcpEnabledDHCP service is on
addressIP address
netMaskNet Mask
gatewayGateway address
dnsDNS 1
portIP port
Returns
APIBaseResponse class type

◆ ShiftStatus()

APIShiftStatusResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.ShiftStatus ( string  operatorPassword)
inline

Returns current shift status

RUS Protocol Command: 0xF2

Parameters
operatorPassword
Returns
APIShiftStatusResponse class type

◆ SubtotalModifier()

APISubtotalModifierResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.SubtotalModifier ( string  operatorPassword,
bool  isAddOn,
bool  isPercentage,
bool  printSubtotal,
long  amount,
string  decription 
)
inline

Perform a Subtotal Modifier

RUS Protocol Command: 0x90

Parameters
operatorPassword
isAddOnUse 'false' to execute a Discount, 'true' to execute an Add-On
isPercentageUse 'false' to use an Absolute Amount, 'true' to use a Percentage Value
printSubtotalSet if Subtotal Line Must be Printed
amountvalue of the Modifier
decription
Returns
APISubtotalModifierResponse class type

◆ VoidLastItem()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.VoidLastItem ( string  operatorPassword)
inline

Void last element in current Fiscal Document

RUS Protocol Command: 0x8F

Parameters
operatorPassword
Returns
APIBaseResponse class type

◆ WriteECRSerialNumber()

APIBaseResponse Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.WriteECRSerialNumber ( string  operatorPassword,
string  serialNumber 
)
inline

Write a new Serial Number on ECR device

RUS Protocol Command: 0x17

Parameters
operatorPassword
serialNumberECR Serial Number. max 20 chars
Returns
APIBaseResponse class type

Property Documentation

◆ CapDepartmentTableRowCount

int Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CapDepartmentTableRowCount
get

Returns the Department table row number

◆ CapFooterTableRowCount

int Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CapFooterTableRowCount
get

Returns the Footer table row number

◆ CapHeaderTableRowCount

int Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CapHeaderTableRowCount
get

Returns the Header table row number

◆ CapOperatorTableRowCount

int Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CapOperatorTableRowCount
get

Returns the Operator table row number

◆ CapPaymentTableRowCount

int Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CapPaymentTableRowCount
get

Returns the Payment table row number

◆ CapVATTableRowCount

int Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.CapVATTableRowCount
get

Returns the VAT table row number

◆ ComunicationParams

object [] Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.ComunicationParams
set

Group of parameters for set up the communication channel. RS232 Object list: int baudRate, int dataBits, Handshake handshake, Parity parity, string portName, StopBits stopBits, bool dtr, bool rts

Ethernet Object list: string adress, int port

Referenced by Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.OpenConnection().

◆ ComunicationType

Enums.ComunicationTypeEnum Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.ComunicationType
set

Set the communication channel

Referenced by Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.OpenConnection().

◆ LogLevel

Enums.LogLevelEnum Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.LogLevel
getset

Set the library log level

◆ PortIsOpened

bool Custom.Fiscal.RUSProtocolAPI.ProtocolAPI.PortIsOpened
get

Return the connection status of the communication port