Lightning Rod Point of Sale Community Edition Readme

Overview
This custom module for Odoo 16+ adds BTCpay server as a payment method to the Point-of-Sale application. A BTCpay server connected to a lightning node is queried by API calls from Odoo. BTCpay server API access is provided to Odoo and a Create Invoice button is added to the POS action pad. A created invoice for an order is printed on the bill receipt for scanning by customers on paper or the screen. A customer can choose to pay in Lightning or a traditional payment method. The POS Validate payment button will check the status of the invoice and mark the order as paid if the invoice is settled. Conversion rate and invoiced satoshis are stored for each order.

Prerequisites (versions)
Compatible with Odoo 16
Postgres 14+
BTCpay server connected to Lightning node

Installation (see this video for tutorial on Odoo module installation)

1. Download repository and place extracted folder in the Odoo addons folder.
2. Login to Odoo database to upgrade and enable developer mode under settings.
3. Under apps Update the App list.
4. Search for the module (MLR) and install.

Setup

1. In Odoo navigate to Point of Sale-> Configuration -> BTCpay server instance.
2. Click New to create a new record.
3. Enter a Name for the Instance and Company Name to display on the receipt. Enter the time until invoice expiration.
4. Login into the BTCpay server to be used and navigate to Account -> API Key. Create a key with full priviledges.
5. From BTCpay server copy the following information and paste in the Odoo BTCpay server Instance record: the server base URL, API key, and enter the password to BTCpay server.
6. Click Test Connection to verify the information is correct. If it is correct a green popup will affirm so, if it is incorrect a red popup will appear.
7. Click Activate to make BTCpay instance a current method (the first time a new Accounting Journal BTCpay will be created and used for recording transactions).
8. In Configuration -> PoS Interface enable Is Bar/Restaurant, in Configuration -> Bar & Restaurant enable Early Receipt Printing, and Configuration -> Payment Methods add BTCpay and in Configuration.

Operation

1. From the Point of Sale Dashboard open a New Session.
2. After creating an order click Create Invoice to generate Lightning Invoice. The generated invoice ID from BTCpay server will appear on a popup, acknowledge by clicking Ok.
3. To view the invoice QR code click Bill. The QR code can be presented to the customer on the screen or with a printed receipt.
4. From the order navigate to the Payment screen. If the the customer paid with Lightning click Validate to confirm and close the order, if the invoice is unpaid a message will alert the user and an alternative payment method can be used. If the customer wishes to use another payment method, exe out the BTCpay server payment line and use the other payment method.
5. Lightning payment information, satoshi amount and conversion rate, will be stored on the payment model. To view after closing the session navigate to Orders-> Payments and open a specific record.