Reporting
Get Inventory Planning Report
Returns a paginated inventory planning report with replenishment data per product. Supports warehouse filtering via filter[warehouse_id], filter[warehouse_id][is], or base64-encoded filter_groups tree.
Get Inventory Planning Summary
Returns summary metrics for the inventory planning report header cards (counts of items at risk, overstocked, out of stock, etc.).
Export Inventory Planning Report
Exports the inventory planning report as CSV or XLSX. Supports column selection and warehouse filtering.
Refresh Velocity Data
Dispatches a tracked background job to recompute product velocity cache and supplier lead time reliability. Returns a tracked_job_log_id for monitoring via the job tray.
Refresh Sales Financials
Dispatches a tracked background job to refresh sales financials data used by the inventory planning report. Returns a tracked_job_log_id for monitoring via the job tray.
Create Draft PO from Planning
Creates a draft purchase order from reorder suggestions in the inventory planning report.
List Scheduled Reports
Returns all scheduled reports for the authenticated user for the inventory_planning report type.
Create Scheduled Report
Creates a new scheduled inventory planning report for the authenticated user.
Delete Scheduled Report
Deletes a scheduled report. Only the owner can delete their own scheduled reports.
Get Profitability Trend
Returns trend data (revenue, cost, profit) grouped by a dimension and time interval. Used for the profitability trend chart.
Get Profitability Cost Breakdown
Returns cost breakdown data with dimension rows and financial line type columns. Used for the profitability cost breakdown table.
Get Profitability Drilldown
Returns paginated order-level drilldown for a specific dimension value, showing revenue, COGS, total cost, profit, and margin per order. Includes financial line type column values when flt_ids[] is provided.
Get Order Breakdown
Returns a full financial breakdown for a single order, including all line items, COGS, allocated costs, and financial line type values.
Get Financial Line Types
Returns all financial line types configured for the current tenant. Used to populate the drilldown column selector.
Get Inventory Valuation
Returns the inventory valuation report summary grouped by warehouse/category.
Export Inventory Valuation
Exports the inventory valuation report as a file download.
Inventory Valuation Drilldown by Category
Returns inventory valuation broken down by category.
Inventory Valuation Drilldown by Source
Returns inventory valuation broken down by source (purchase order, initial inventory, etc.).
Inventory Valuation Drilldown by Transactions
Returns inventory valuation broken down by individual inventory transactions.
Get Realtime Inventory
Returns real-time inventory levels per product per warehouse. Supports both Vue 3 format (filter[search], filter[warehouse_id]) and legacy Vue 2 format (search, warehouse_id) — both are auto-normalized.
Get Realtime Inventory Summary
Returns aggregate summary totals for the realtime inventory report.
Export Realtime Inventory
Exports real-time inventory data as a CSV file. Columns: SKU, Product Name, Warehouse, Available, Allocated, On Hold, In Transit, Total, Inbound, Projected Total.
Financials by Brand
Returns financial summary data grouped by brand.
Financials by SKU
Returns financial summary data grouped by SKU/product.
Financials by Supplier
Returns financial summary data grouped by supplier.
Financials by Sales Channel
Returns financial summary data grouped by sales channel.
Financials by Sub-Sales Channel
Returns financial summary data grouped by sub-sales channel.
Financials by Product Type
Returns financial summary data grouped by product type (standard, blemished, kit).
Get Top Selling Products
Returns the top-selling products by revenue with quantities sold, total revenue, total cost, profit, and number of orders. Supports date range filters.
Get Most Profitable Products
Returns the most profitable products sorted by profit (descending). Supports date range filters.
Get Dashboard Orders
Returns daily order revenue and cost aggregates grouped by date. Used for the dashboard orders trend chart.
Get Dashboard Products
Returns product sales data grouped by the specified field. Used for dashboard analytics.
Get Monthly COGS
Returns monthly COGS (cost of goods sold) data for a specific year.
Get Purchase Summary by Period
Returns a summary of purchases grouped by period (month or year).
Get Accounting COGS
Returns accounting COGS report data including average cost, quantities sold/returned/adjusted, and COGS totals (gross, returned, adjusted, net).
Export Accounting COGS
Exports accounting COGS report as a CSV file. group_by[] determines which extra columns appear before the metric columns (Avg Cost, Qty Sold, Qty Returned, Qty Adjusted, Net Qty, Gross COGS, Returned COGS, Adjusted COGS, Net COGS).
Get Accounting Income Statement
Returns an income statement grouped by accounting nominal codes and period. Supports date filtering and period granularity.
Get GINR Report (Prepaid Inventory)
Returns the Goods In Not Received (GINR) / prepaid inventory report — purchase invoices paid but not yet received into inventory.
Get Ship By Schedule
Returns the ship-by schedule report showing which products need to ship by which dates, including quantity coverage status.
Get Sales Channel Coverage (Legacy)
Returns sales channel coverage data (legacy POST endpoint). Prefer the paginated GET endpoint for new implementations.
Get Sales Channel Coverage (Paginated)
Returns paginated sales channel coverage data per product using Spatie QueryBuilder. Shows which products are listed on which sales channels.