getPointsOfSale

Retrieve all registers (points of sale), in all shops and locations. One shop can have many registers. A register has field "warehouseID" to indicate which store or warehouse it is located in.

Input parameters

Parameter name Description Possible value Required
pointOfSaleID    Integer    
warehouseID    Integer    
searchName  Search by register name. Partial matches are also returned, but API searches only from the beginning of each field — not from the middle.  String    
searchAttributeName  Search from attribute name. searchAttributeName and searchAttributeValue have to be specified both  String    
searchAttributeValue  Search from attribute value  String    
changedSince  Retrieve only items that have been added or modified since the specified timestamp. Use it to keep a local database in sync with ERPLY.  Integer (Unix timestamp)    

Response

Field name Type Description
pointOfSaleID  Integer    
name  String    
warehouseID  Integer  ID of the warehouse  
warehouseName  String  Name of the warehouse  
address  String    
phone  String    
storeHours  String  Opening hours  
geoLatitude  Decimal, 6 places  Latitude (geographical location)  
geoLongitude  Decimal, 6 places  Longitude (geographical location)  
paymentServiceProvider  String  Card payment terminal / card swiper  
receiptWidth  Decimal    
vatrateID  Integer  Default VAT (tax) rate ID in this register.

NB! In ERPLY there is a whole hierarchy of tax rates, and rules for applying these tax rates. POS default tax rate is just one possible rule; tax rate may also be set at product level, location level, or product group level. Finally, certain customers may be marked as tax exempt, and there are different multi-tier tax rates.

You should use API call calculateShoppingCart to retrieve the appropriate tax rate for a specific customer and product in a specific location.  
vatrate  Decimal  Default VAT (tax) rate percentage. See above.  
vatSumRange1  Integer  Multi-tier tax: threshold for Tier 2 tax. See a commoent about tax rates above.  
vatrateIDrange1  Integer  Multi-tier tax: Tier 2 tax percentage.  
vatSumRange2  Integer  Multi-tier tax: threshold for Tier 3 tax. See a commoent about tax rates above.  
vatrateIDrange2  Integer  Multi-tier tax: Tier 3 tax percentage.  
printSalesPersonName  0 or 1  Print salesperson's name on receipt  
shopName  String  Shop name on customer display  
defaultCustomerID  Integer    
storeCreditEnabled  0 or 1  Whether customers are allowed to use store credit in this POS.  
lastInvoiceNo  Integer  For Windows Point Of Sale / Touch POS. Last invoice number issued by the POS application. POS application uses this field to continue correct numbering after reinstall/reload.

You may also use these numbers for your own API application (eg. a webshop), provided that you are NOT using our Windows Point Of Sale software. The correct way to use this field is to take the provided number and add 1 to it.

A separate number series is used, different from the one in Erply backend. The numbers consist of 8+ digits (a register ID prefix + number sequence 1,000,000...3,999,999).  
lastCouponNo  Integer  For Windows Point Of Sale only. Last coupon number issued by Windows Point Of Sale. The Windows application uses this field to continue correct numbering after reinstall.  
quickButtons  Array  List of products and services that cashier can select with quick keys in this POS. The items are listed in order. Each item is either a product or a service. Item structure:
Field nameTypeDescription
productIDIntegerID of a product
serviceIDIntegerID of the service
 
added  Unix timestamp  Creation time.  
lastModified  Unix timestamp  Last modification time.  
attributes  Array  Additional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value