Wiki

    Contact support:

    Email: support@erply.com

    returns

    Sales Returns in the POS

    Benefits of Product ReturnsIncrease customer loyalty and long-term profits92% of customers will buy something again if the return process is easy. Customers are more likely to spend money at the store...

    Gift Cards

    Benefits of Gift CardsGift cards are a built-in option in Erply, accessible to all customers.Flexible payments to attract new business 61% of consumers prefer to receive gift cards during the holiday ...

    Offline Warehouse

    Benefits of Offline WarehouseManage returned items to decrease inventory lossThe offline warehouse is a dedicated location to host damaged or broken items.When a customer returns an item, your team ma...

    Payments Configuration in Berlin POS

    POS Settings > Payments Configuration This is where you can configure allowed tenders on sales and returns (with and without receipts), as well as limiting amounts for each tender type. If the “Limit”...

    Product Return / Credit Invoice

    Benefits of Product ReturnsBoost store trafficCustomers are more likely to make a purchase once they enter your store. Enabling partial or full returns encourages them to add an item to their order, t...

    API Version 1.45.0

    New Features All API calls now allow to optionally specify which fields must be returned. By default, API returns the whole dataset as always; but if a list of fields is specified, the records will be...

    Shopify connector features and setup

    Shopify connector requirementsA paid Shopify planAn Erply accountThe Shopify connector plugin enabled on your Erply account*to have this added, please get in touch with our customer support at support...

    5. Other Libraries

    Additional useful methods you can call from your plugin. 1. Make a Request to Erply API ErplyAPI implements, under a namespace Helios.ErplyAPI, following methods: Method Comment request Regular reques...

    Inventory write-off

    Why use the inventory write-off system? Inventory Write-Off decreases the stock level of items in Erply. It also includes a section on the reason codes that can be associated with such Write-Offs.Use ...

    2. Authentication-Related Calls

    getSessionKeyUser getSessionKeyInfo getJwtToken getIdentityToken These are the calls you need when user is already logged-in (your application or service has obtained a session key from somewhere) and...

    How To Create a Store Report With Erply APIs

    A “Store Report” is an overview of store operations. Such a report typically contains multiple tables of data, not just a single dataset. The report can cover only one day, or a longer period of time....

    Classic Back Office Version 4.37.0

    February 1, 2021 New Features Feature "Copy user group" has been implemented. Feature "Reason code on purchase returns" has been implemented. The feature can be enabled from Settings → Configuration →...

    Berlin Back Office Version 5.34.0

    February 1, 2021 New Features Feature "Copy user group" has been implemented. Feature "Reason code on purchase returns" has been implemented. The feature can be enabled from Settings → Configuration →...

    POS Brazil Version 4.18.0

    FeaturesCurrency format (numberformat) now also used in:recent-: -layaways, -orders, -sales, -invoices, -offersgift card popupproduct informationemployee statsclose day main popup + tenderspayment mod...

    Account Administration API

    This REST API implements calls for managing registers (points of sale), locations (warehouses), users and employees.The API also returns information on whether an account belongs to a multi-account ch...

    API Version 1.73.0

    December 01, 2021 New features API call savePurchaseDocument now can update existing purchase document numbers. API call subtractCustomerRewardPoints now returns the id of the subtraction record that ...

    Advanced Settings

    Default prefixesDefault prefixes are used in the following cases:Erply returns report with warehouse code not present in the Store dimension. This can only happen if the data load long time (i.e. lot ...

    POS Brazil Version 4.44.3

    Fixes:Fixed issue with Pax Payment integration recording returns payments with positive amount in BOFixed issue where coupon printing would fail due to not having an expiry dateW** - DSC discount now ...

    POS Brazil Version 4.49.0

    Features:Re-enabled referenced returns for Adyen Payment IntegrationMatrix products get added to the shopping cart as soon as all their dimensions are selected (No need to press Save explicitly in the...

    POS Brazil Version 4.49.6

    Fixes:Allow entering gift card number that contains spaces when paying with a gift cardFix Cayan not displaying the message of the failed payment / the "Unreferenced returns are currently not supporte...

    POS Brazil Version 4.50.7

    Features:"Global Payments/TSYS/Cayan" Payment Integration - added support for unreferenced returnsAdded new fields (receiptInfoStreet, receiptInfoCity, receiptInfoState, receiptInfoAddress2, receiptIn...

    Promotions

    Benefits of PromotionsEncourage repeat business 90% of customers look for coupons when making online and offline purchases. Offering flat or percent-based discounts during holidays or seasonal changes...

    Error Handling Best Practices

    Erply API's response always contains a header block, named "status". Within that block, there is a field named "errorCode". If the field has a value of 0, the call has completed successfully. If it co...

    Adyen integration setup

    Adyen payment integration should ONLY be used with secure connection (https). This means that Erply POS must be running in https://app.erply.com/live/Register Adyen accountGo to Adyen's website and re...

    Sign In and Out of the POS

    Benefits of Unique POS LoginsEasily track employee actions at the POSEmployee logins give you a paper trail to follow for vital POS and back office functions. Keep track of employee sales and hours wo...

    WMS API

    WMS (Warehouse Management Software) is a system to support warehouse management and optimize its functionality. This document is focused on the API side of WMS. For authentication, the following param...

    Logins

    Benefits of unique POS loginsEasily track employee actions at the POSEmployee logins give you a paper trail to follow for vital POS and back office functions. Keep track of employee sales and hours wo...

    Classic Back Office Version 4.30.2

    Oct 5, 2020 Improvements Behavior of the filter "Type of transaction: sales / returns" in Reports > Sales has been changed. Filtering is now done based on row quantity: positive quantities are "sales"...

    API Version 1.63.3

    March 23, 2021 New Features New call added "getDefaultLanguage" Support for editing document permission levels. getCompanyInfo call now returns a new field "Intermediator code". Improvements Precision...

    Berlin Back Office Version 5.42.0

    July 5, 2021New Features1. Actual Reports sales document printouts: new fields.The dataset now contains customer's current amount of reward points, points earned with the current sale, and new point b...

    POS Brazil Version 4.29.4

    Fixes: Fixed issue with product price being always 0 Fixed issue with returns with free priced items not working Fixed issue with layaway reset on payment window close Fixed issue with gift card seria...

    External Credit Card Payments (no integration)

    Also known as "External integration" or previously "standalone terminal" This setup is intended for processing card payment outside Erply and then manually input in the POS the ammount that was paid, ...

    POS Brazil Version 4.38.1

    Fixes:Customer creation form data is shown correctly nowPrices on returns are correct nowCheck and Card limits can no longer be bypassed by adding multiples of payments.If a payment is not within the ...

    POS Brazil Version 4.38.3

    New featuresNew setting allow_price_editing_for_exchanges_and_returns to unlock the price field for returnsFixesScanner no longer bypasses config parameter pos_allow_selling_only_from_pricelist1Plugin...

    POS Brazil Version 4.44.7

    Fixes:Location name in the header now wraps its content on new line if the location name is too long to fitReferenced returns now contain save the returnReasonID correctly to sale document and are vis...

    API Version 1.45.2

    April 8, 2020 New Features New API call "getServiceEndpoints" has been added. This API call returns the endpoints of other, special-purpose Erply APIs("microservices"). Since Erply accounts are locate...

    API Version 1.46.0

    April 13, 2020 New Features This API version introduces a new feature — promotion tiering. "Tiers" allow to organize promotions into groups, to affect the order in which promotions are applied. The ne...

    API Version 1.54.0

    October 13, 2020 New Features API calls getCampaigns and saveCampaign now support multiple product groups and multiple product categories (instead of just one) and multiple brands (a new feature). Mul...

    POS Brazil Version 4.14.0

    FixesMatrix selection menu refactored - now works correctly with the setting to only allow variations that are in stockProductOrderEdit inputs now allow cursor key navigation againProductOrderEdit inp...

    Classic Back Office Version 4.38.0

    February 9, 2021 New Features New configuration option "Reason code on purchase return is required" can be used to make reason codes mandatory on purchase returns. New workflow for transfer orders whe...

    POS Brazil Version 4.20.1

    Fixes: Customer discount issue introduced by 4.20.0 release is now fixed and working correctly Scanning customer now returns the same information as customer search from the main Customer Search field...

    Classic Back Office Version 4.46.0

    July 5, 2021New Features1. Actual Reports sales document printouts: new fields.The dataset now contains customer's current amount of reward points, points earned with the current sale, and new point b...

    POS Brazil Version 4.38.4

    FixesCancel layaway feature now disabled for users without permission to make returns without receiptDefault language option in settings→language now saves correctlyDeprecations“Advanced product filte...

    API Version 1.75.0

    February 2, 2022 New Features The "Partial Tax Exempt" feature is now supported on US accounts. Improvements Input parameter "name" in API call getCampaigns now returns all promotions where beginning ...

    Whats New in Brazil Point of Sale

    Welcome to Brazil, our latest POS software.Built on a new engine and sporting a very similar interface to Berlin, Brazil is a powerful tool to help you manage your business effectively. Supported by o...

    Javascript math with time zones

    Question: As a developer, I need to query for records from a specific date — but the API call requires the time range to be specified as Unix timestamps.From user's perspective, “records from a specif...

    Pricing API

    This REST API contains calls for managing price lists.There is also a call for querying a product's sales price and tax rate. The GET /v1/products/price call consults all price lists that are currentl...

    Pending Sales / Save Sale

    Benefits of Saving as SaleErply allows you to save a sale at the POS to be pulled up at a later time. Saved sales do not put stock on hold, and can be resumed and completed from any POS.Customer probl...

    WMS app

    Say hello to the Erply Warehouse Management System (WMS) app! Erply WMS is an all-in-one warehouse solution that increases accuracy and boosts employee productivity throughout the entire warehouse pro...

    Stocktake Android v2.1.8+38

    April 6, 2020 What's new Weak connection? More support for OFFLINE mode: create new stocktake, access the list of “in progress” stocktakes in offline You can now add product category and supplier filt...

    Stocktake iOS 2.1.8+38

    April 6, 2020 What's new Weak connection? More support for OFFLINE mode: create new stocktake, access the list of “in progress” stocktakes in offline You can now add product category and supplier filt...

    Purchase documents

    In order to see all purchase documents, please navigate to Purchase > All purchase documents. It is possible to apply different filters and also filter per purchase document type (purchase orders, pur...

    Berlin Back Office Version 5.35.0

    February 9, 2021 New Features New configuration option "Reason code on purchase return is required" can be used to make reason codes mandatory on purchase returns. Improvements Version number is now d...

    POS Brazil Version 4.17.0

    FeaturesWeighted barcode implementationPrinting coupons automatically if such a rule existsDefault coupon template addedNew setting in Configuration/General. Sort products in products group by: 'name'...

    POS Brazil Version 4.25.1

    Fixes Fixed issue with Nets Payment Integration charging customers instead of refunding them during unreferenced returns and exchanges. Features Added possibility to switch to offline/online modes ma...

    POS Brazil Version 4.35.0

    Fixes:Product grid buttons now correctly include/exclude tax even when locally fetchedProducts get added with correct price when selecting a pending saleFixed default groups plugin overwriting iD*** c...

    Introduction to Swagger

    New Erply APIs offer a web interface called Swagger.A Swagger page:Contains the documentation of that API: which calls are available, what is the structure and meaning of the input and output.Serves a...

    API Version 1.80.0

    May 18, 2022New FeaturesAPI calls savePurchaseDocument, updatePurchaseDocumentAdditionalCosts and updatePurchaseDocumentRows no longer allow two API clients to simultaneously edit the same document. I...

    POS Brazil Version 4.48.0

    New featuresOffers menu now shows only unfulfilled offersAdded keyboard navigation to customer results as wellOptimized workflow so that translations would not get lostAdded contacts table to customer...

    Erply Reports explained

    Erply Reports explained This guide explains the data values in each of Erply’s reports. Sales reports Sales Summary report Sales Summary Period: The dates from which the information is gathered. This ...

    Erply Back Office Terminology

    Erply Back Office Terminology CRM The CRM module is a solution to manage current and potential customer relationships. Use customer purchasing history to better understand your shopper’s habits and ke...

    API Version 1.52.0

    Sep 11, 2020 New Features When saving a purchase invoice with savePurchaseDocument, API will now update the statuses of linked purchase orders to "partially received or "received", as appropriate. API...

    API version 1.57.0

    November 26, 2020 New Features Field "priceListProductID" has been added to the output of API call getProductsFromSupplierPriceLists. API call getCustomers, input parameter "searchNameIncrementally" n...

    Sales Documents

    Properties of a Sales DocumentA sales document is associated with a customer and a location. (The sale is made to one specific customer, in one specific location.)A sales document may be confirmed or ...

    POS Brazil Version 4.42.2

    Fixes:Fixed error where Cayan customer display was not sending cart infoAdded support for returns of zero-priced products...

    POS Brazil Version 4.42.3

    Fixes:Fix issue with PEFTPOS refunds. POS would return the money to the customer, but the payment stored to Erply would be with positive instead of negative amount.Fix issue with PEFTPOS endpoint for ...

    POS Brazil Version 4.46.2

    Plugins:Custom buttons plugin: Fix product buttons getting stuck in loading state after a saleFixes:Adyen integration no longer shows success message in case of a failure during voidFixed tax exemptio...

    Authenticate

    PrerequisitesFor API authentication, you need:Your account number (customer code). This is typically a six-digit number.Your user name.Your password.You can authenticate with the same credentials that...

    API Version 1.77.0

    April 13, 2022New Features1. API call getPointsOfSale now supports configuration setting "Do not reuse a number when a POS transaction is canceled or a sales document is deleted". 2. Support for disco...

    API Version 1.44.0

    March 19, 2020 New Features The following API calls have been added: getAllCustomerExternalIds getCustomerIdByExternalId getExternalIdsByCustomerId removeCustomerExternalId saveCustomerExternalId API ...

    PIM API Version 1.12.5

    Jun 25, 2020 New Features Added pagination, sorting and filtering for Product Groups, Categories, Brands, Suppliers and Families. Added GET /v1/product/parameter/option/{id}/products endpoint to get a...

    API Version 1.50.0

    Jul 7, 2020 New Features API call saveSalesDocument now supports idempotency when creating new sales documents. API client can add input parameter "temporaryUUID" to the request. Subsequent calls with...

    POS Brazil Version 4.05.2

    FeaturesClose day tenders no longer have TIPBack Office receipt footer supported in PatchScriptBack Office receipt announcement/message supported in PatchScriptPatchscript prices are rounded to 2 deci...

    POS Brazil Version 4.19.2

    Fixes: POS is now passing correctly return reason to the sale document User no longer gets warned that product is out of stock if it is a non-stock product "Promotion only takes place in this store: "...

    POS Brazil Version 4.21.0

    FeaturesOffline locking (PBIB-1321)When in offline mode, POS can be locked with a temporary pin so that it can be logged back into without requiring a network connection.Due to the security implicatio...

    POS Brazil Version 4.29.5

    Fixes: Fixed bug where product out of stock message would appear when changing product's amount in cart Fixed issue that caused the POS to crash on entering Customer Display Plugin configs Fixed issue...

    4. Algorithm Versions

    Over time, we have made modifications to the calculations. Each of these modifications has created a new "version".In each version, both the "NetPrice" and "PriceWithTax" methods are implemented.Curre...

    Error codes

    This is a list of error codes that API calls may return.An error code is always returned in the "status" block, in field "errorCode". If the error is related to a specific input parameter, you will fi...

    Store Credit

    Benefits of Store CreditSafer refundsStore credit can be used as an easy refund system. Payment processors charge extra for reverting a card transaction, and returning cash to customers may open up po...

    POS Brazil Version 4.08.1

    Features Bigger images in Product order View. Product view image now has optional image navigation under the currently previewed picture - it is minimized by default. The user can expand it by clicki...

    Scanning Configuration

    Erply Brazil POS allows you to customize the search logic when scanning a barcode. You can define what records should be searched for a match, and based on what fields.This guide covers the different ...

    API Version 1.82.0

    June 29, 2022New Features1. API now produces enriched web hook events. (https://wiki.erply.com/article/1540-enriched-events)2. Filter parameter "campaignIDs" has been added to API call getCampaigns.3....