feat: add detailed item sales report by enricodelarosa · Pull Request #4538 · opensourcepos/opensourcepos

enricodelarosa · 2026-05-09T13:58:32Z

The current detailed transaction sales report doesn't show the item sold per row and it's not included in the report export. The items summary report doesn't classify by sale as well. The detatailed item sales report is added to show all items sold in an exportable manner while keeping the sale transaction informationi as well.

Summary by CodeRabbit

New Features
- Added a Detailed Item Sales Report with item-level sales, pricing, discounts, totals, profitability, and transaction details.
- Added filters for date range, sale type, location, and discount type.
- Added access through the reports listing and dedicated report navigation.
Improvements
- Date and filter selections are now preserved when revisiting report inputs.
- Added report labels across supported locales.

coderabbitai · 2026-05-09T13:58:46Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
✅ Review completed - (🔄 Check again to review again)

📝 Walkthrough

Walkthrough

This PR adds a complete "Detailed Item Sales" report feature: a new report model that stages and queries sales-items with pricing/cost/profit metrics, two controller endpoints (form + report), two routes, language translations, and small view updates to list and preserve selected form values.

Changes

Detailed Item Sales Report

Layer / File(s)	Summary
Report Model Definition `app/Models/Reports/Detailed_item_sales.php`	New `Detailed_item_sales` model extends `Report` and implements `create()` to populate `sales_items_temp`, `getDataColumns()` for column defs and numeric sorters, `getData()` for item-level rows (quantity/price/discount/subtotal/tax/total/cost/profit and metadata), `getSummaryData()` to aggregate totals, and `applyFilters()` for sale_type/location/discount predicates.
Controller Integration `app/Controllers/Reports.php`	Import and wire `Detailed_item_sales` model (import, private property, constructor). Add `date_input_item_sales()` to load allowed sales locations and render the date input form (lines ~704–718). Add `detailed_item_sales(start_date,end_date,sale_type,location_id,discount_type)` to normalize inputs, call model create/getData/getSummaryData, transform rows into tabular output, and render `reports/tabular` (lines ~1906–1960).
Route Registration `app/Config/Routes.php`	Register two routes: `reports/detailed_item_sales` → `Reports::date_input_item_sales` and `reports/detailed_item_sales/(:segment)/(:segment)/(:segment)/(:segment)/(:segment)` → `Reports::detailed_item_sales/$1/$2/$3/$4/$5`.
View Listing `app/Views/reports/listing.php`	Render an additional "Detailed Item Sales" link within the detailed reports loop for the sales reports category.
Date Input View `app/Views/reports/date_input.php`	Preserve previously selected `sale_type` and `discount_type` by preferring passed-in selections with fallbacks to existing defaults.
Translations `app/Language/*/Reports.php`	Add `detailed_item_sales_report` key with label `"Detailed Item Sales Report"` across locale files (en-GB, en, and many others).

Sequence Diagram(s)

sequenceDiagram
  participant Route
  participant Controller
  participant Model
  participant View
  Route->>Controller: date_input_item_sales()
  Controller->>View: render date input
  Route->>Controller: detailed_item_sales(start,end,sale,loc,discount)
  Controller->>Model: create(inputs)
  Controller->>Model: getData(inputs)
  Controller->>Model: getSummaryData(inputs)
  Controller->>View: render tabular

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested reviewers

objecttothis

Poem

🐰 A new report hops into view,
Rows of sales with price and cost,
Discounts, taxes, profit too—
Each item captured through and through.
Hooray for numbers, neat and glossed!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 20.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'feat: add detailed item sales report' clearly and specifically describes the main change—adding a new detailed item sales report feature. It is concise, accurate, and directly summarizes the primary addition across all modified files.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@app/Config/Routes.php`:
- Line 35: The route declaration defines five segments but only supplies four
parameters to Reports::detailed_item_sales; update the route pattern to four
segments so it matches the method signature (start_date, end_date, sale_type,
location_id) — change the route in Routes.php from
'reports/detailed_item_sales/(:segment)/(:segment)/(:segment)/(:segment)/(:segment)'
to a four-segment pattern (four (:segment) placeholders) so the controller
method receives the correct $1/$2/$3/$4 parameters.

In `@app/Controllers/Reports.php`:
- Around line 704-713: The view expects $mode and $sale_type_options but
date_input_item_sales() doesn't set them; update date_input_item_sales() to
mirror date_input_sales()/date_input() by assigning $data['mode'] = 'sale' and
$data['sale_type_options'] = (the same sale type options array used in
date_input_sales()/date_input()), then pass $data into
view('reports/date_input', $data) so the sale_type dropdown and mode checks in
the view work without undefined variable warnings.
- Around line 1901-1910: The method detailed_item_sales declares an unused
parameter $sale_type while hardcoding 'sale_type' => 'sales' in the $inputs
array; remove $sale_type from the method signature of detailed_item_sales and
delete any internal references if present, and update the $inputs array to keep
'sale_type' => 'sales' as-is; also update any caller/route that passed four
parameters (e.g. the route in app/Config/Routes.php) to pass only three
parameters to match the new signature.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 844656ca-b8af-4f09-8946-e37c5df200bd

📥 Commits

Reviewing files that changed from the base of the PR and between 144e73e and 4610035.

📒 Files selected for processing (6)

app/Config/Routes.php
app/Controllers/Reports.php
app/Language/en-GB/Reports.php
app/Language/en/Reports.php
app/Models/Reports/Detailed_item_sales.php
app/Views/reports/listing.php

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@app/Controllers/Reports.php`:
- Around line 1906-1916: In detailed_item_sales, sanitize and validate the route
params before putting them into $inputs: validate $sale_type against an
allowlist (e.g., 'sales','returns', etc.) and default to 'sales' if invalid;
validate $discount_type against its allowlist (e.g., 'all','percentage','fixed')
and default to 'all' if invalid; normalize/cast $location_id to either 'all' or
an integer (use intval and reject/convert non-numeric to 'all'); then populate
$inputs with the validated values so downstream filtering uses only allowed,
well-typed values.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d0cbf1aa-ac1c-4907-8798-b32d2ffbeec7

📥 Commits

Reviewing files that changed from the base of the PR and between 4610035 and 9abcd74.

📒 Files selected for processing (4)

app/Config/Routes.php
app/Controllers/Reports.php
app/Models/Reports/Detailed_item_sales.php
app/Views/reports/date_input.php

🚧 Files skipped from review as they are similar to previous changes (2)

app/Config/Routes.php
app/Models/Reports/Detailed_item_sales.php

coderabbitai · 2026-08-06T07:48:28Z

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

enricodelarosa · 2026-08-07T06:49:13Z

@objecttothis good for review since updated branch already

objecttothis · 2026-08-07T07:18:54Z

@coderabbitai review

coderabbitai · 2026-08-07T07:19:00Z

⚠️ Action not completed

No files to review.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

The current detailed transaction sales report doesn't show the item sold per row and it's not included in the report export. The items summary report doesn't classify by sale as well. The detatailed item sales report is added to show all items sold in an exportable manner while keeping the sale transaction informationi as well.

… for other languages

objecttothis

This will be merged after 3.4.2 is released since 3.4.2 is now locked to security updates and bugfixes.

coderabbitai Bot reviewed May 9, 2026

View reviewed changes

Comment thread app/Config/Routes.php Outdated

Comment thread app/Controllers/Reports.php Outdated

Comment thread app/Controllers/Reports.php Outdated

enricodelarosa changed the title ~~feat: add detailed item sales report~~ feat: add detailed item sales report Enhancement May 9, 2026

enricodelarosa changed the title ~~feat: add detailed item sales report Enhancement~~ feat: add detailed item sales report May 9, 2026

coderabbitai Bot reviewed May 9, 2026

View reviewed changes

Comment thread app/Controllers/Reports.php Outdated

jekkos reviewed May 10, 2026

View reviewed changes

Comment thread app/Language/en-GB/Reports.php Outdated

This comment was marked as resolved.

Sign in to view

enricodelarosa requested a review from jekkos May 11, 2026 17:03

enricodelarosa force-pushed the feat/detailed-sales-report branch 3 times, most recently from 650ef6e to cffb634 Compare May 14, 2026 13:26

objecttothis assigned enricodelarosa Aug 6, 2026

objecttothis added the enhancement label Aug 6, 2026

objecttothis added this to the 3.4.3 milestone Aug 6, 2026

objecttothis requested changes Aug 7, 2026

View reviewed changes

Comment thread app/Controllers/Reports.php Outdated

Comment thread app/Controllers/Reports.php Outdated

Comment thread app/Controllers/Reports.php Outdated

enricodelarosa added 7 commits August 11, 2026 23:28

Wire item sales report sale and discount filters

1a6d93d

Validate detailed item sales route filters

4471553

fix: add English fallback translations for detailed item sales report…

d3a9464

… for other languages

fix: use blank quotes for other languages for detailed item sales report

b51fe3b

fix: normalize detailed item sales language key placement

531aeb2

fix(reports): use PSR-style names for detailed item sales report

f68dd0f

enricodelarosa force-pushed the feat/detailed-sales-report branch from a7485f3 to f68dd0f Compare August 11, 2026 15:28

enricodelarosa requested a review from objecttothis August 12, 2026 12:26

objecttothis approved these changes Aug 13, 2026

View reviewed changes

Uh oh!

Uh oh!

Conversation

enricodelarosa commented May 9, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented May 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Suggested reviewers

Poem

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

coderabbitai Bot commented Aug 6, 2026

Uh oh!

enricodelarosa commented Aug 7, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

objecttothis commented Aug 7, 2026

Uh oh!

coderabbitai Bot commented Aug 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

objecttothis left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

enricodelarosa commented May 9, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented May 9, 2026 •

edited

Loading

coderabbitai Bot commented Aug 7, 2026 •

edited

Loading