Report Digest

Admin

The Report Digest sends an automated sales summary email to one or more recipients on a daily or weekly schedule. It is a lightweight way to keep owners and managers informed of store performance without needing to log in and run a report manually.

Feature flag required

Report Digest is disabled by default. Enable it under Settings > Edit Settings > Notifications tab, in the Scheduled Report Digests section.

---

What the Digest Contains

Each digest email includes the following for the covered period:

Section	Details
Total Sales	Number of completed transactions
Total Revenue	Sum of all completed sale totals
Total Tax	Total tax collected
Total Discounts	Sum of all discount types (campaign, loyalty tier, manual, promo)
Average Sale	Revenue divided by transaction count
Payment Breakdown	Revenue and count per payment method (cash, debit, e-transfer, store credit, gift card, etc.)
Top 10 Products	Products ranked by revenue for the period, with quantity sold
Prior Period Comparison	Revenue and transaction count for the equivalent prior period

---

Configuring the Digest

1. Log in to the Admin Panel.
2. Navigate to Settings > Edit Settings.
3. Click the Notifications tab.
4. Scroll to the Scheduled Report Digests section.
5. Configure the fields below, then click Save Settings.

Settings

Setting	Options	Description
Enable Report Digest	On / Off	Master toggle. Must be on for emails to send.
Frequency	Daily, Weekly (Mondays)	How often the digest is sent.
Recipient Emails	Comma-separated list	One or more email addresses to receive the digest.
Send Time	Time picker	The time of day the digest job runs. Defaults to 06:00.

---

Frequency Details

Daily: The digest covers the previous calendar day. It is sent each morning at the configured send time.

Weekly: The digest covers the previous Monday through Sunday week. It is sent on Monday mornings only. If the digest is set to weekly, no email is sent on other days of the week.

---

How It Works

A background job (ReportDigestJob) runs on the configured schedule. For each store with the digest enabled and at least one recipient email configured, it:

1. Determines the period (yesterday for daily; prior Mon-Sun for weekly).
2. Calls ReportDigestService to query completed sales for the period.
3. Sends the appropriate mailer (ReportDigestMailer#daily_digest or #weekly_digest).

If no recipient emails are configured, the job skips the store silently. If the feature flag is disabled, the store is also skipped.

---

Notes

• All metrics are scoped to completed sales only. Voided or pending sales are excluded.
• Discount totals include campaign discounts, loyalty tier discounts, qualifying (quality tier) discounts, and manual discounts — matching the breakdown used in the full Sales Report.
• The prior period comparison uses the same duration as the report period. For a daily digest, it compares yesterday to the day before; for weekly, last week to the week before.
• The digest is sent using the store's local timezone as configured in General Settings.
• Each store sends its own independent digest. Recipients only receive data for their store.