getReceiptPrints

Get a list of receipt printings.

To register that a receipt has been printed, use API call registerReceiptPrint.

The presence of this API call does NOT mean that Erply back office, API and point-of-sale applications actually register all printings of invoices and receipts, and that all this information is already available over API. If you have a particular feature you want to implement, you need to create the full workflow yourself, using this pair of API calls — "registerReceiptPrint" and "getReceiptPrints".

At the moment, only Berlin POS uses the "registerReceiptPrint" call, and only on Swedish accounts — to meet the needs of Swedish Z Reports.

Input parameters

Parameter name Description Possible value Required
startTimestamp  Specify the beginning of the time range.  Integer (Unix timestamp)  yes  
endTimestamp  Specify the end of the time range.  Integer (Unix timestamp)  yes  
pointOfSaleID  Optionally, retrieve printings from one specific register only. If omitted, printings from all registers are returned.  Integer    
recordsOnPage  Number of records API should return. By default 20, at most 100.  Integer    
pageNo  API returns at most recordsOnPage items at a time. To retrive the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1".  Integer    

Response

Field name Type Description
invoiceID  Integer  Sales document that was printed. Depending on POS configuration (in the Swedish example), or depending on what you have registered with registerReceiptPrint, this might be a sales document of any type (an invoice-waybill, or even a sales order), not specifically a receipt.  
pointOfSaleID  Integer  Register at which the sales document was printed. This might be different from the register in which the transaction was originally made.  
timestamp  Integer (Unix timestamp)  Printing time.  
isReprint  Integer (0 or 1)  Whether it was a reprint or not. (A print is a "reprint" if it is produced later — regardless of whether the customer already got a paper receipt at transaction time or not.)  
invoiceTotal  Decimal  Total value of the sales document, in sales document's currency, with VAT.