Point of Sales#

In this tutorial, you will learn about the POS feature, covering configuration, creating point of sales, and setting it by area.

Prerequisites#

To utilise this feature, you need the following:

  • Make sure that both modules OpenSPP POS: ID Redemption and OpenSPP POS are installed and activated. For details on installing additional modules, refer to the Module installation documentation.

  • Have existing individual records in your registry, either by creating records manually or importing records into OpenSPP.

  • Have an access role either as System Admin or POS operator to perform tasks in the POS application.

  • Have an access role as System Admin to perform tasks in OpenSPP. Learn more about assigning user role in the guide User access.

  • Have an existing cycle with beneficiaries and entitlements generated on a program. Learn more about this in the guide Create program.

Objective#

By the end of this tutorial, you will be able to configure point of sales, manage, classify by area, and generate transactions within the POS feature.

Process#

Verify POS module#

To be able to create point of sales, you have to make sure that the necessary modules are installed and activated on your OpenSPP instance. This can be verified by logging in to your OpenSPP instance as Administrator, go to Apps, search for OpenSPP POS and OpenSPP POS: ID Redemption respectively and if not already done, activate them by clicking Activate button.

OpenSPP POS module activation screen showing both POS modules with Activate buttons

Upon successful activation, the button label should change to Learn more.

Configure POS Settings#

Navigate to the menu screen. On the sidebar menu, click Point of Sale to open the POS dashboard.

Point of Sale dashboard showing configured POS stations in a table format

Click on Configuration and select Payment methods to see the payment methods available. By default, the options Cash, Bank and Customer Account are available.

Payment methods configuration screen showing Cash, Bank, and Customer Account options

Create point of sales#

To create a point of sale, click on Point of Sales from the sidebar, click Configuration and select Point of Sales, then click on New.

Point of Sales configuration screen with New button highlighted

Assign a name to the point of sale you want to create. It is also possible to assign the shop to a specific area by selecting the desired area from the dropdown. Click on Save button to keep the changes.

Point of Sale creation form with name field and area dropdown selection

Select payment methods#

To select a payment method for your point of sale, click on Point of Sales from the sidebar, navigate to Configuration and click on Settings. From the Point of Sale dropdown, click and select the point of sale you want to manage.

Point of Sale settings screen with dropdown to select specific POS station

Once you have selected a point of sale, click on the dropdown from Payment methods and select the desired payment methods for this point of sale. Click the Save button to keep the changes.

Please Note: For Cash payment method a unique payment method needs to be created for each point of sale. In order to create a new Cash payment method, navigate to Point of Sale, click on Configuration and select Payment methods, then click New.

New payment method creation screen with form fields

Define the name of the payment method and click on the Journal Input field.

Payment method form with name field and Journal dropdown

Click on Search More from the dropdown.

Journal selection dropdown with Search More option highlighted

Click on New button.

Journal creation dialog with New button

Define the Journal name, then select Cash under Type dropdown. To complete the journal creation, click Save & Close.

Journal creation form with name field, Cash type selection, and Save & Close button

You may now select the new Cash payment method for a point of sale. Navigate to Configuration and click on Settings. Select a Point of sale. Then under payment methods dropdown, select your new Cash payment method and click Save.

POS settings screen showing new Cash payment method selected in dropdown

Group point of sales by area#

In order to group point of sales by area, make sure you have areas already existing in your OpenSPP instance. Learn more about importing areas in the guide Import areas. From the sidebar, navigate to Point of Sale, select Configuration and click Point of Sales. Select the point of sale you wish to manage and assign by clicking an area from the dropdown Area.

POS configuration screen with Area dropdown showing available areas for assignment

Navigate to Point of Sale and select Dashboard. The point of sales will now be grouped by area.

POS dashboard showing point of sales organized by geographical areas

Point of sales that do not belong to any area will display as minimized. Click the <> arrows from the dashboard to expand the view. Click on Gear icon to collapse view.

POS dashboard with expand/collapse arrows and gear icon for view options

Starting point of sale in web view#

The POS application is viewable in either web view or mobile view. This section will be covering the web view, for mobile view, proceed to Starting point of sale in mobile view of this document.

The POS application can be operated by either an Administrator or a POS Operator role.

To start the point of sale, click on Point of Sale in the sidebar. You should be redirected to the Dashboard, where you can select the point of sale you wish to start.

POS dashboard displaying available point of sales with New Session buttons

Click on New Session to be redirected to the POS application, then click on Beneficiary to display the list of beneficiaries.

POS application interface with Beneficiary button highlighted on the main screen

Click on the beneficiary you wish to transact with.

Beneficiary selection dialog showing list of registered beneficiaries

Once selected, the beneficiary's name will be displayed in the POS application.

POS interface displaying selected beneficiary name in the transaction area

Click on the Entitlement button to display all the entitlements available for this beneficiary.

Entitlement selection dialog showing available entitlements for the selected beneficiary

Select the entitlement you wish to disburse by clicking on it. Then click Close button.

POS interface showing selected entitlement with Close button visible

Click on Payment button to proceed.

POS payment screen with payment method options and transaction details

Click on Validate button to complete.

POS validation screen with Validate button to complete the transaction

The transaction is now complete. If you wish to start a new transaction, click on New Order.

POS completion screen showing transaction success with New Order button

Starting point of sale in mobile view#

The POS application is viewable in either web view or mobile view. This section will cover the mobile view, for web view, proceed to Starting point of sale in web view of this document.

Click on the upper left box icon to bring up the menu, then click Point of Sale.

Mobile menu interface with hamburger icon and Point of Sale option

You will be taken to the Dashboard. Select a point of sale you wish to start by swiping horizontally and click on New Session.

Mobile POS dashboard with swipeable point of sale cards and New Session button

Click on Review.

Mobile POS Review screen with transaction overview and navigation options

Then click on Beneficiary to display a list of beneficiaries.

Mobile beneficiary selection screen with Beneficiary button highlighted

Click on the relevant beneficiary in the displayed list.

Mobile beneficiary list showing registered beneficiaries for selection

Once selected, the beneficiary's name is displayed in the POS application.

Mobile POS interface showing selected beneficiary name in the transaction area

Click on More and then Entitlement to display available entitlements for this beneficiary.

Mobile POS More menu with Entitlement option visible

Click on the entitlement you wish to disburse and click the Close button.

Mobile entitlement selection screen showing available entitlements with Close button

Optionally, you may add a note by clicking on More followed by Beneficiary note. Fill in the note and click on Add button. This note will be displayed on the receipt.

Mobile beneficiary note interface with text field and Add button

Click on the Payment button to proceed.

Mobile POS payment screen showing transaction details and payment options

Click on the Validate button to complete.

Mobile POS validation screen with Validate button to complete transaction

The order or transaction is now complete. Click on New Order to start a new transaction.

Mobile POS completion screen showing successful transaction with New Order button

Refunds#

When necessary, it is possible to do refunds for cash entitlements. To start a refund, click on a point of sale and select a beneficiary. Click on Refund.

Mobile POS refund interface with beneficiary selected and Refund button

The orders/transactions associated with the beneficiary will be displayed. Click on any transaction to view the details on the right side.

Mobile transaction history screen showing beneficiary's past transactions

Click on an item. You may only refund items that are disbursed, indicated by the negative (-) sign beside its amount.

Mobile transaction details showing refundable items with negative amounts

Note that if an item has been already refunded, it will display Refunded and you will be unable to click it anymore.

Mobile transaction details showing previously refunded item marked as Refunded

Upon clicking the item, click 1 from the number pad key and then click on the Refund button.

Mobile refund screen with number pad and Refund button for amount selection

The item to be refunded will be displayed on the menu. Click on Payment.

Mobile refund payment screen showing item to be refunded with Payment button

Select a payment method and click Validate. This completes the refund process.

Mobile refund validation screen with payment method selection and Validate button

To verify that the item was successfully refunded you can click on the burger menu on the top right corner of the screen.

Mobile POS interface with hamburger menu in top right corner

Click on Orders. You will be redirected to the screen below. Click on All active orders and select Paid.

Mobile orders screen with filter options showing All active orders and Paid status

Click on the transaction that involves the refund and notice that the amount is now a positive value indicating that the cash entitlement has been successfully refunded.

Mobile transaction details showing completed refund with positive amount value