Run report
phppos_run_reportRun one of the store's reports and return it (title, summary, detail rows); paging.next_offset is set when more detail rows remain. Report keys and their inputs come from phppos_list_reports (for example summary_sales, top_sellers, inventory_low, summary_profit_and_loss, summary_taxes, closeout). Typical inputs go in params: start_date, end_date, sale_type, location_ids (array), category_id, supplier_id, customer_id, employee_id. A scoped key needs the Reports module plus that report's view permission. GET /reports/{report_key}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Rows per page, 1-500 (default 100). | |
| offset | No | Rows to skip (default 0). Pass the previous reply's next_offset (paging.next_offset for a report). | |
| params | No | The report's inputs as listed by phppos_list_reports, e.g. {"start_date":"2026-10-01","end_date":"2026-10-31","location_ids":[1]}. Do not put limit/offset here. | |
| report_key | Yes | Report key from phppos_list_reports (for example summary_sales or inventory_low). |