DocumentationChangelog

Changelog

03.11.2024

Field idCustomer is deprecated in methods getTableContents, getBill and searchBills. The value is always null to ensure backward compatibility.

21.10.2024

Added documentation for auto and manual capture modes. Added documentation for Receipt.finalPrice for finalizing the bill with a lower price.

5.3.2024

Added documentation for requesting payment reports via API. This feature is still in beta.

22.02.2024

Increased item limit in getMealMenus() method to 5 000.

14.02.2024

Updated PayU testing card

19.12.2023

Added new receipt delivery type

12.12.2023

Upcharge details moved from extenstions to base integration

01.11.2023

Further refinments Added Upcharge feature

20.06.2023

Removed Czech EET parameters from fiscalInfo data structure

16.06.2023

Overhauled the order of categories Separated base methods and data structures from extensions

06.03.2023

Added updated testing cards for all supported countries Added Austrian fiscalization info in FiscalInfo datastructure Added German fiscalization info in FiscalInfo datastructure

08.08.2022

Added info about BillSubItem in BillItem

13.06.2022

Added info about lock timeout on paymentStart Added info about mandatory state checking on paymentClosed

10.06.2022

Added the “Loyalty cards” extension Removed the “Call the waiter” extension Removed the pairCustomer() method

04.04.2022

Cleared up production Pos-Id assignment process

23.03.2022

Added a section about Qerko functions and use cases

21.03.2022

Fixed a mistake in the Discount structure - the description property should be called name

07.01.2022

Added BKP in Slovakia FiscalInfo

05.01.2022

Added receiptDeliveryType POSTPONED

07.12.2021

Added the Slovakia-specific parameters to FiscalInfo Added the ReceiptDeliveryType parameter of the Receipt structure

12.10.2021

Fixed dead links Added the Orders extension doc link

22.06.2021

Improved documentation of Table

11.06.2021

Replaced testing credit card due to payment gateway switch Improved documentation of Websocket close codes

01.06.2021

Fixed some grammar mistakes and typos

31.12.2020

Updated test credit card

04.11.2019

Changed the magic keyword for switch to development environment to qerko-toggle-test Added examples Added headerLines, headerText, footerLines, footerText to FiscalInfo structure

27.06.2019

Added optional Extensions Corrected a few typos Corrected a few mistakes in examples

12.06.2019

Added payment diagram Added optional MethodCallResponse.calledMethod Added missing info about time limit of method cancelPayment(…) Added error codes: ACCESS_DENIED, ALREADY_AUTHORIZED, NO_SUCH_METHOD, NOT_FOUND, TIME_LIMIT_EXPIRED

01.06.2019

Changed Error.reason to Error.code Added list of Error Codes Removed Bill.roundingMode Added Bill.additionalData BillItem.tags are no longer required BillItem.minQuantity default value is 1 Removed BillDiscountOffer.roundingMode Renamed BillDiscountOffer.description to BillDiscountOffer.name Added Payment.additionalData Renamed Payment.tip to Payment.tipBrutto Removed Payment.total Renamed Payment.idUser to Payment.idCustomer Added Payment.state STARTED Added PaymentProvider.id Removed Receipt.additionalData Added Receipt.receiptInfo and structure ReceiptInfo Moved Receipt.footerLines to changes in ReceiptInfo.footerLines Moved Receipt.headerLines to changes in ReceiptInfo.headerLines Moved Receipt.waiter in ReceiptInfo.waiter Receipt.items are required now Added Receipt.fiscalInfo and structure FiscalInfo

24.5.2019

Removed BillItem.splittable Added BillItem.minQuantity Added Bill.roundingMode Added BillDiscountOffer.roundingMode Added Payment.tipNetto

17.5.2019

Renamed BillItem.amount to BillItem.quantity Added optional property Receipt.items Minor changes in descriptions

13.5.2019

Added locale into Authorization request message

9.5.2019

Payment.paymentProvider was replaced by Payment.parts Added PaymentPart structure Added BillItem.amount Added BillItem.id Added BillItem.splittable Changed BillItem.price

24.4.2019

Added headerLines a footerLines to the Receipt structure Removed lines form the Receipt structure

23.4.2019

Allow to skip nullable properties in data structures Renamed pairUser(…) to pairCustomer(…)

19.4.2019

Added Bill.denyDiscounts This can prevent Qerko from applying a discount

18. 4. 2019

It Is Paid is renamed to Qerko This document is in English now Introducing API v2. Added websocket support. Added Bill structure. This brings support for multiple bills on a table. Added BillDiscountOffer structure. This brings support for POS discount offers. Added BillItem structure. This brings support for additionalData that can be used by POS. This brings the all new tags set for item categorization or recognition. Added Discount structure. Successor of the Sale structure. Support for various discount sources. Added endpoint for cancelling the payment. For the ability to cancel the payment in case of a customer issue. Added getBill(…) method. For the ability to get the contents of an exact bill. Added pairUser(…) method. For the ability to pair Qerko’s users and POS loyalty DB. Added TaxInfo structure. Taxes are completely calculated by POS now. Added Receipt structure. Successor of BillInfo. Many changes due international differences. Added MethodCallRequest. Just for convenience. This has introduced no functional changes. Added MethodCallResponse. Type of MethodCallResponse.error has changed. Changed method error(…). Error is be reported using Error structure, not just string. Changed method getTableContents(…). Added idUser argument, so POS can offer discounts. Changed methods paymentProcessed(…) and paymentClosed(…). To prevent sending the same data more than once and the validation related with it. Structure Payment. Added Payment.paymentProvider Removed Payment.idTable. Replaced by Payment.idBill. Removed Payment.totalItems. It was confusing and useless. Removed Payment.timestamp. It was useless. Removed BillInfo structure. Replaced by Receipt. Removed Sale structure. Replaced by Discount. Removed TableContents structure. Replaced by Bill. Removed TableItem structure. Replaced by BillItem.