> ## Documentation Index > Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt > Use this file to discover all available pages before exploring further. # Sales by company report > Aggregated sales totals per company over a date range, with a per-item breakdown grouped by SKU or product. Results are paginated by company. The date range is required and is matched against each invoice's order date. ## OpenAPI ````yaml /api-reference/build.yaml get /reports/sales-by-company openapi: 3.0.0 info: title: Luminous API version: 1.0.0 description: API documentation for Luminous servers: - url: https://{companyName}.api.joinluminous.com/external/api/v1 variables: companyName: default: companyName description: Your company-specific subdomain security: [] tags: - name: Products description: Get and manage products - name: Pricing description: Manage price schedules, levels, and customizations - name: BOMs description: Manage Bills of Materials (BOMs) - name: Labels description: Label rendering via Labelary ZPL service - name: Companies description: Manage business accounts and their associated data - name: Contacts description: Manage contact information for individuals - name: Suppliers description: Manage suppliers (factories) — vendors used on purchase orders - name: Supplier SKUs description: Manage per-supplier SKU and unit-cost overrides for products - name: Locations description: Manage warehouses and locations - name: Inventory description: Get and adjust product stock levels - name: Lots description: Create, update, and delete product lots (batches) - name: Transfer Orders description: Manage transfer orders - name: Fulfillment Orders description: Manage fulfillment orders and picklists - name: Purchase Orders description: Get and modify purchase orders - name: Receiving Reports description: Manage receiving reports - name: Payment Obligations description: Manage payment obligations for purchase orders - name: Sales Orders description: Manage sales orders and sales order shipments - name: Purgatory description: >- Inspect and resolve non-posted sales orders in the purgatory staging workflow - name: PickFlow Shipping description: >- Provider-agnostic shipping rates, services, packages, and label purchase for PickFlow - name: Cycle Counts description: >- Create, drive, and post PickFlow cycle counts — batches, per-warehouse sessions, and CSV import/export - name: Print Stations description: List paired print stations and enqueue print jobs to them - name: Invoices description: Get and manage invoices - name: Work Orders description: >- Manage work orders — production lifecycle, steps, materials, links, shipments, and comments - name: Production Batches description: Group and manage work orders as production batches - name: Bills description: >- Accounts payable bill management, payments, attachments, allocations, and variance - name: Prepayments description: Manage vendor prepayments and applications - name: Vendor Credits description: Manage vendor credits and applications - name: Vendor Returns description: Manage vendor returns and credit generation - name: Customer Returns description: Manage customer returns (sales returns), receiving, and restock behavior - name: Stock Snapshot description: Point-in-time stock snapshots with export support - name: Consumption description: Consumption reports and exports - name: Inventory Aging description: Cost-layer-based inventory aging reports - name: Bills Reports description: Accounts payable bills aging reports - name: Forecast description: Materialized forecast data - name: Reports description: Close the books, inventory discrepancy, transaction COGS, and EDI reports - name: Tags description: Add/remove tags across various resources - name: Custom Fields description: Get and set custom fields across various resources - name: Currency description: Currency configuration, exchange rates, and conversion - name: Integration Mappings description: Manage integration mappings for external systems - name: Integration Field Mappings description: Manage field-level mappings between Luminous and external systems paths: /reports/sales-by-company: get: tags: - Reports summary: Sales by company report description: >- Aggregated sales totals per company over a date range, with a per-item breakdown grouped by SKU or product. Results are paginated by company. The date range is required and is matched against each invoice's order date. operationId: getSalesByCompanyReport parameters: - in: query name: order_date[gte] required: true schema: type: string format: date description: Start of the order-date range (inclusive, YYYY-MM-DD). - in: query name: order_date[lte] required: true schema: type: string format: date description: >- End of the order-date range (inclusive, YYYY-MM-DD). Must be on or after `order_date[gte]`. - in: query name: group_by schema: type: string enum: - sku - product default: sku description: >- How to group the per-company item breakdown. `sku` includes a `sku` field on each item; `product` aggregates by product. - in: query name: company_id[eq] schema: type: integer description: Restrict the report to a single company. - in: query name: company_id[in] schema: type: string description: >- Restrict the report to a comma-separated list of company IDs (e.g. `1,2,3`). - in: query name: page schema: type: integer default: 1 minimum: 1 description: Page number for pagination. - in: query name: per_page schema: type: integer default: 10 minimum: 1 maximum: 100 description: Number of companies per page (max 100). responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: type: object properties: company_id: type: integer company_name: type: string nullable: true total_quantity: type: number description: Total quantity sold to the company over the range. total_amount: type: number description: >- Total net sales amount for the company over the range. items: type: array description: Per-item breakdown for the company. items: type: object properties: product_id: type: integer product_name: type: string nullable: true sku: type: string nullable: true description: Present only when `group_by=sku`. quantity: type: number amount: type: number meta: type: object properties: current_page: type: integer description: The current page number example: 1 from: type: integer description: The starting index of the paginated results example: 1 last_page: type: integer description: The last page number example: 5 per_page: type: integer description: Number of items per page example: 10 to: type: integer description: The ending index of the paginated results example: 10 total: type: integer description: Total number of items across all pages example: 50 links: type: object properties: first: type: string nullable: true last: type: string nullable: true prev: type: string nullable: true next: type: string nullable: true '401': description: Authentication credentials were missing or invalid content: application/json: schema: type: object properties: error: type: string example: Unauthorized message: type: string example: Authentication credentials are missing or invalid status_code: type: integer example: 401 '422': description: Validation error content: application/json: schema: type: object properties: message: type: string errors: type: object additionalProperties: type: array items: type: string security: - BearerAuth: [] components: securitySchemes: BearerAuth: type: http scheme: bearer description: >- Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token. ````