docs: Loyalty program

docs/.vitepress/sidebar.ts

@@ -32,6 +32,7 @@ export default function sidebar() {
           text: 'Discount Accounting',
           link: '/transactions/discount-accounting',
         },
+        { text: 'Loyalty Program', link: '/transactions/loyalty-program' },
         {
           text: 'Multi Currency Invoicing',
           link: '/transactions/multi-currency-invoicing',
@@ -48,6 +49,7 @@ export default function sidebar() {
         { text: 'Entries', link: '/entries/entries' },
         { text: 'Items', link: '/entries/items' },
         { text: 'Party', link: '/entries/party' },
+        { text: 'Lead', link: '/entries/lead' },
         { text: 'Taxes', link: '/entries/taxes' },
         { text: 'Price List', link: '/entries/price-list' },
       ],

docs/transactions/loyalty-program.md

@@ -0,0 +1,87 @@
+# Loyalty Program
+
+Loyalty Program is used to reward customers with points for their purchases,
+which can then be redeemed on future purchases.
+
+## Enabling Loyalty Program
+
+To enable Loyalty Program you will have to first check the Enable Loyalty
+Program. To
+navigate: `Setup > Settings > General Tab`.
+
+![Enable Inventory](./images//enable-loyalty-program.png)
+
+Once that is done you will have to restart Frappe Books to see the Loyalty
+Program in the sidebar.
+
+::: warning
+
+Loyalty Program cannot be disabled once it has been enabled.
+:::
+
+## Creating Loyalty Program
+
+To create a Loyalty Program first navigate to the Loyalty Program page
+
+`Sales > Loyalty Program`
+
+Then click on the blue `+` button to open the Loyalty Program form.
+
+![Sales Invoice Form](./images/loyalty-program.png)
+
+1. Enter a unique name for the Loyalty Program.
+2. Add the From and To Date for program's validity period.
+3. Ensure the **IsEnabled** checkbox is checked. This will mark the program
+   active.
+4. Collection Rules:
+
+   - **Tier name:** To differentiate between different levels of rewards.
+   - **Collection Factor:** How much amount needs to be spent to gain 1 Loyalty
+     Point.
+   - **Minimum Amount:** Minimum amount to be spent to qualify into a tier.
+
+5. Set an **Expense Account** from where you'll offer the benefits. This is
+   useful to track the benefits offered separately.
+6. Set the number of days in the Expiry Duration field after which the loyalty
+   points will expire.
+
+## Loyalty Program in Customer
+
+Set a Loyalty Program in the Customer to assign a Loyalty Program.
+
+![Sales Invoice Form](./images/choose-loyalty-program.png)
+
+Loyalty points earned can be viewed in the Customer.
+
+![Sales Invoice Form](./images/loyalty-points.png)
+
+## Loyalty Program Functionality
+
+### Earning Points
+
+1. Assign this Loyalty Program to a Customer.
+2. Create a new Sales Invoice for the Customer to whom you have assigned
+   Loyalty Program.
+3. For this example, an invoice is created with a grand total of 3,000 INR.
+   According to the Loyalty Program, if a customer spends a minimum of
+   2,000 INR, they are eligible to earn loyalty points. For every 300 INR
+   spent, the customer will receive 1 loyalty point. Therefore, with a total
+   spend of 3,000 INR, the customer earns 10 loyalty points.
+4. Upon submission of the invoice, a Loyalty Point Entry will be created for
+   this invoice. This acts as a log to give an overview of which Customer
+   earned how many points against which Sales Invoice.
+
+![Sales Invoice Form](./images/loyalty-point-entry.png)
+
+### Redeeming Points
+
+1. When creating an invoice for a Customer who has loyalty points, go to the
+   Loyalty Point Redemption section and enable the checkbox
+   **Redeem Loyalty Points**.
+2. The fields for **Loyalty Points** will become visible under this section.
+   You can fill in the points to redeem.
+3. The total amount of the invoice will be adjusted based on the redeemed
+   points, and you will only need to pay the remaining balance after the points
+   have been applied.
+
+![Sales Invoice Form](./images/redeem-loyalty-points.png)