Intro to Reporting

The Rackbeat Reporting API provides access to various business intelligence and analytics data within the Rackbeat inventory management platform. These endpoints enable developers to extract reports covering sales performance, inventory analysis, financial metrics, and operational insights.

Available Report Categories

Inventory Management Reports

Report	Request URL	Purpose
Batches Report	`/reports/batches`	Report containing batch transaction data and batch movement history.
Batch Checking Report	`/reports/batch-checking`	Report for batch-controlled inventory items, returning batch data and status information.
Checking Report	`/reports/checking`	Detailed inventory verification report including: Product and BoM (lot) information with stock quantities Supplier information and pricing data Stock availability and order quantities Cost prices and recommended prices Item groups and categorization
Ledger Reports	`/reports/ledger/{lineable}`	Transaction history report for specific items providing detailed movement records.
Reordering Report	`/reports/reordering`	Stock status and reordering information including: Current stock levels vs minimum thresholds Basic reorder flags (`should_reorder`, `reorder_soon`) Expected stock calculations Stock buffer analysis
Valuation Reports	`/reports/valuation`	Report providing inventory valuation data with location-based filtering capabilities.

Revenue & Financial Reports

Report	Request URL	Purpose
Sales Reports	`/reports/sales`	Sales data report (text format output).
Sales Budgeting	`/reports/sales-budgetting`	Sales budgeting data report.
Orders Report	`/reports/orders/download`	Order management data available as downloadable export.
Order Revenue Statistics	`/revenue-orders`	Revenue analytics for orders including: Total cost summaries (`sum_total_cost`) Revenue totals (`sum_total_total`) Profit calculations (`sum_total_profit`)

Specific Response Structure for Order Revenue Statistics (/revenue-orders)

{
  "orders": [...],                    // Detailed order data
  "sum_total_cost": 45000.00,        // Total cost across all orders
  "sum_total_total": 67500.00,       // Total revenue across all orders  
  "sum_total_profit": 22500.00,      // Total profit across all orders
  "base_currency": "DKK"             // Currency for the calculations
}

Report Formats & Downloads

Many reports support multiple output formats through dedicated download endpoints:

Excel/CSV Downloads: Most reports offer /download endpoints for exporting data
PDF Reports: Formatted reports suitable for printing and sharing
JSON Data: Structured data for programmatic consumption

Comprehensive Filtering

All reporting endpoints support extensive filtering options:

Date Range Filtering

date_from / date_to: General date range filtering
booked_at_from / booked_at_to: Filter by booking dates
order_date_from / order_date_to: Filter by order dates
delivery_date_from / delivery_date_to: Filter by delivery dates
updated_at_from / updated_at_to: Filter by modification dates

Entity-Based Filtering

Customer Filtering: customer_from, customer_to, customer_number
Employee Filtering: employee_from, employee_to, employee_number
Item Filtering: item_from, item_to, has_item
Customer Group Filtering: customer_group_from, customer_group_to

Status Filtering

is_cancelled: Filter cancelled orders
is_booked: Filter booked orders
is_shipped: Filter shipped orders
is_ready_for_shipping: Filter orders ready to ship
is_archived: Filter archived records

Advanced Search

search: Full-text search across relevant fields
other_reference: Filter by external reference numbers
address_email: Filter by customer email addresses

Simple Filters

Support for complex filtering using operators:

simple_filter[field_name]: Apply various operators (equals, contains, greater than, etc.)
Available for fields like number, created_at, updated_at

Inclusion/Exclusion Filters

in: Include specific IDs (comma-separated)
not_in: Exclude specific IDs (comma-separated)

Best Practices

Use Date Filters: Always apply appropriate date ranges to limit data volume
Leverage Download Endpoints: For large datasets, use dedicated download endpoints
Implement Pagination: Process large result sets in manageable chunks
Cache Results: Cache report data when appropriate to reduce API calls