Search

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 nameDescriptionPossible valueRequired
pointOfSaleIDInteger
warehouseIDInteger
searchNameSearch by register name. Partial matches are also returned, but API searches only from the beginning of each field — not from the middle.String
searchAttributeNameSearch from attribute name. searchAttributeName and searchAttributeValue have to be specified bothString
searchAttributeValueSearch from attribute valueString
changedSinceRetrieve 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 nameTypeDescription
pointOfSaleIDInteger
nameString
warehouseIDIntegerID of the warehouse
warehouseNameStringName of the warehouse
addressString
phoneString
storeHoursStringOpening hours
geoLatitudeDecimal, 6 placesLatitude (geographical location)
geoLongitudeDecimal, 6 placesLongitude (geographical location)
paymentServiceProviderStringCard payment terminal / card swiper
receiptWidthDecimal
vatrateIDIntegerDefault 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.
vatrateDecimalDefault VAT (tax) rate percentage. See above.
vatSumRange1IntegerMulti-tier tax: threshold for Tier 2 tax. See a commoent about tax rates above.
vatrateIDrange1IntegerMulti-tier tax: Tier 2 tax percentage.
vatSumRange2IntegerMulti-tier tax: threshold for Tier 3 tax. See a commoent about tax rates above.
vatrateIDrange2IntegerMulti-tier tax: Tier 3 tax percentage.
printSalesPersonName0 or 1Print salesperson's name on receipt
shopNameStringShop name on customer display
defaultCustomerIDInteger
storeCreditEnabled0 or 1Whether customers are allowed to use store credit in this POS.
lastInvoiceNoIntegerFor 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).
lastCouponNoIntegerFor 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.
quickButtonsArrayList 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
addedUnix timestampCreation time.
lastModifiedUnix timestampLast modification time.
attributesArrayAdditional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value