> ## 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.

# Create a receiving report

> Create a new receiving report



## OpenAPI

````yaml /api-reference/build.yaml post /receiving-reports
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:
  /receiving-reports:
    post:
      tags:
        - Receiving Reports
      summary: Create a receiving report
      description: Create a new receiving report
      operationId: createReceivingReport
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - received_date
                - items
              properties:
                received_date:
                  type: string
                  format: date
                tracking_number:
                  type: string
                received_by:
                  type: string
                received_at:
                  type: string
                  format: date-time
                shipped_via:
                  type: string
                items:
                  type: array
                  items:
                    type: object
                    required:
                      - purchase_order_id
                      - purchase_order_item_id
                      - quantity
                      - received_unit_of_measure_id
                      - location_id
                      - warehouse_id
                    properties:
                      purchase_order_shipment_id:
                        type: integer
                      purchase_order_id:
                        type: integer
                      purchase_order_item_id:
                        type: integer
                      quantity:
                        type: number
                      unit_price:
                        type: number
                      remarks:
                        type: string
                      received_unit_of_measure_id:
                        type: integer
                      location_id:
                        type: integer
                      lot_id:
                        type: integer
                      lot_number:
                        type: string
                        nullable: true
                        description: >-
                          Lot number for the received item (used when the
                          product has lot tracking enabled).
                      lot_name:
                        type: string
                        nullable: true
                        description: Alias for `lot_number`.
                      production_date:
                        type: string
                        format: date
                        nullable: true
                        description: Lot production date (YYYY-MM-DD).
                      expiry_date:
                        type: string
                        format: date
                        nullable: true
                        description: Lot expiry date (YYYY-MM-DD).
                      manufacturer_code:
                        type: string
                        nullable: true
                        description: Manufacturer code for the lot.
                      warehouse_id:
                        type: integer
                extra_costs:
                  type: array
                  items:
                    type: object
                    required:
                      - name
                      - quantity
                      - unit_price
                    properties:
                      name:
                        type: string
                      quantity:
                        type: number
                      unit_price:
                        type: number
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  status:
                    type: string
                  received_date:
                    type: string
                    format: date-time
                  tracking_number:
                    type: string
                  received_by:
                    type: string
                  received_at:
                    type: string
                    format: date-time
                    nullable: true
                  shipped_via:
                    type: string
                  total_quantity:
                    type: number
                  total_tax:
                    type: number
                  total_cost:
                    type: number
                  shipping_cost:
                    type: number
                  purchase_orders:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Unique identifier for the purchase order
                        order_numbers:
                          type: array
                          description: List of purchase order numbers
                          items:
                            type: string
                        created_at:
                          type: string
                          format: date-time
                          description: Timestamp when the purchase order was created
                        updated_at:
                          type: string
                          format: date-time
                          description: Timestamp when the purchase order was last updated
                        order_status:
                          type: string
                          enum:
                            - active
                            - inactive
                            - deleted
                          description: Status of the purchase order
                        order_date:
                          type: string
                          format: date
                          description: Date when the purchase order was created
                        invoice_date:
                          type: string
                          format: date
                          description: Date when the purchase order was invoiced
                        arrival_due_date:
                          type: string
                          format: date
                          nullable: true
                          description: Expected arrival date for the order
                        requested_ship_date:
                          type: string
                          format: date
                          nullable: true
                          description: Requested shipping date
                        order_type:
                          type: integer
                          description: Type of the order
                        incoterm:
                          type: string
                          description: International Commercial Terms for the order
                        tracking_info:
                          type: string
                          nullable: true
                          description: Tracking information for the order
                        payment_terms:
                          type: string
                          description: Payment terms for the order
                        supplier_id:
                          type: integer
                          description: ID of the supplier
                        item_count:
                          type: integer
                          description: Number of unique items in the order
                        order_quantity:
                          type: integer
                          description: Total quantity of items
                        order_cost:
                          type: number
                          format: float
                          description: Cost of the order before tax and shipping
                        total_tax:
                          type: number
                          format: float
                          description: Total tax amount
                        total_shipping_cost:
                          type: number
                          format: float
                          description: Total shipping cost
                        total_cost:
                          type: number
                          format: float
                          description: Total cost including tax and shipping
                        total_paid:
                          type: number
                          format: float
                          description: Total amount paid
                        total_due:
                          type: number
                          format: float
                          description: Total amount due
                        down_payment:
                          type: number
                          format: float
                          description: Down payment amount
                        public_note:
                          type: string
                          nullable: true
                          description: Public notes
                        private_note:
                          type: string
                          nullable: true
                          description: Private notes
                        starred:
                          type: boolean
                          description: Whether the order is starred
                        supplier:
                          type: object
                          properties:
                            id:
                              type: integer
                            status:
                              type: integer
                            name:
                              type: string
                            description:
                              type: string
                            street_address:
                              type: string
                            city:
                              type: string
                            state:
                              type: string
                            zip:
                              type: string
                            country:
                              type: string
                            contact_name:
                              type: string
                            contact_email:
                              type: string
                            contact_phone:
                              type: string
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                        receiving_report_id:
                          type: integer
                        purchase_order_id:
                          type: integer
                        purchase_order_item_id:
                          type: integer
                        purchase_order_shipment_id:
                          type: integer
                          nullable: true
                        quantity:
                          type: number
                        unit:
                          type: string
                        unit_price:
                          type: number
                        tax:
                          type: number
                        discount_amount:
                          type: number
                        discount_percent:
                          type: number
                        line_total:
                          type: number
                        remarks:
                          type: string
                          nullable: true
                        stock_id:
                          type: integer
                        received_quantity:
                          type: number
                        base_unit_of_measure_id:
                          type: integer
                          nullable: true
                        received_unit_of_measure_id:
                          type: integer
                        location_id:
                          type: integer
                        lot_id:
                          type: integer
                          nullable: true
                  extra_costs:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                        receiving_report_id:
                          type: integer
                        name:
                          type: string
                        quantity:
                          type: number
                        unit_price:
                          type: number
                        line_total:
                          type: number
        '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.

````