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

# Email a Draft invoice

> Email a **Draft** invoice to the contact(s) on file for its account. Mirrors
the admin "send invoice" action: the invoice PDF is rendered from the tenant's
default template and the email is **queued** for delivery. The account's sales
reps are CC'd, exactly as the UI action does.

The endpoint accepts **no request body** — recipients are always the invoice's
contact(s) on file, and the template cannot be chosen per request.

Only invoices in `Draft` status can be emailed; any other status returns `422`.

The reported `status` describes **acceptance onto the send queue, not delivery** —
knowing whether mail landed, bounced, or was opened is out of scope. `send_reference`
is an opaque handle echoed back and written to the invoice's activity log so a send
can be correlated after the fact.

Requires the API token user to have the send-invoices permission
(`invoices.send`), granted to super-admin and admin roles only.

**Idempotency:** this endpoint has an irreversible side effect — once the customer
has the mail, no retry can unsend it — so it supports the optional `Idempotency-Key`
request header. Send the same key on a retry to replay the original response instead
of queueing a second email; replayed responses carry an `Idempotent-Replay: true`
header. Omitting the header passes straight through with no idempotency guard, so two
identical calls queue two emails (exactly as two clicks of the UI action would).




## OpenAPI

````yaml /api-reference/build.yaml post /invoices/{invoiceId}/send-email
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: Fulfillment Priority Lists
    description: Configure fulfillment routing priority lists
  - name: Purchase Orders
    description: Get and modify purchase orders
  - name: Supplier Portal
    description: >-
      Read a supplier's response to a purchase order and control the one-click
      portal link
  - 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:
  /invoices/{invoiceId}/send-email:
    post:
      tags:
        - Invoices
      summary: Email a Draft invoice
      description: >
        Email a **Draft** invoice to the contact(s) on file for its account.
        Mirrors

        the admin "send invoice" action: the invoice PDF is rendered from the
        tenant's

        default template and the email is **queued** for delivery. The account's
        sales

        reps are CC'd, exactly as the UI action does.


        The endpoint accepts **no request body** — recipients are always the
        invoice's

        contact(s) on file, and the template cannot be chosen per request.


        Only invoices in `Draft` status can be emailed; any other status returns
        `422`.


        The reported `status` describes **acceptance onto the send queue, not
        delivery** —

        knowing whether mail landed, bounced, or was opened is out of scope.
        `send_reference`

        is an opaque handle echoed back and written to the invoice's activity
        log so a send

        can be correlated after the fact.


        Requires the API token user to have the send-invoices permission

        (`invoices.send`), granted to super-admin and admin roles only.


        **Idempotency:** this endpoint has an irreversible side effect — once
        the customer

        has the mail, no retry can unsend it — so it supports the optional
        `Idempotency-Key`

        request header. Send the same key on a retry to replay the original
        response instead

        of queueing a second email; replayed responses carry an
        `Idempotent-Replay: true`

        header. Omitting the header passes straight through with no idempotency
        guard, so two

        identical calls queue two emails (exactly as two clicks of the UI action
        would).
      operationId: sendInvoiceEmail
      parameters:
        - in: path
          name: invoiceId
          required: true
          schema:
            type: integer
          description: ID of the Draft invoice to email
        - in: header
          name: Idempotency-Key
          required: false
          schema:
            type: string
          description: >
            Optional opt-in idempotency token. When supplied, a retry carrying
            the same key

            replays the original stored response (with an `Idempotent-Replay:
            true` header)

            instead of queueing another email. Omit it to disable the guard for
            this request.
      responses:
        '200':
          description: >
            The email was queued for at least one recipient. A `partial` status
            means some

            recipients were queued and some could not be; see the per-recipient
            `recipients`

            array for detail.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      invoice_id:
                        type: integer
                        description: ID of the invoice that was emailed
                      send_reference:
                        type: string
                        format: uuid
                        description: >-
                          Opaque handle for this send, echoed back and recorded
                          on the activity log
                      status:
                        type: string
                        enum:
                          - queued
                          - partial
                          - failed
                        description: >
                          Acceptance outcome (not delivery). `queued` — every
                          recipient accepted;

                          `partial` — some accepted; `failed` — nothing could be
                          queued.
                      accepted_at:
                        type: string
                        format: date-time
                        description: ISO-8601 timestamp when the send was accepted
                      recipients:
                        type: array
                        description: Per-recipient acceptance outcome
                        items:
                          type: object
                          properties:
                            email:
                              type: string
                              format: email
                            type:
                              type: string
                              enum:
                                - to
                                - cc
                              description: >-
                                Whether the recipient was a primary (`to`) or CC
                                address
                            status:
                              type: string
                              enum:
                                - queued
                                - failed
                            error:
                              type: string
                              description: >-
                                Present only when this recipient could not be
                                queued
        '401':
          description: Unauthorized — no authenticated user resolved from the token
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '403':
          description: Token user lacks the send-invoices permission (`invoices.send`)
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: Invoice not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '422':
          description: >
            Cannot send — the invoice is not in `Draft` status, has no contact
            on file, or

            the tenant has no default invoice template configured.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '502':
          description: >
            The email could not be queued (e.g. the queue backend was
            unreachable). The body

            includes a `data` object with the `failed` status and per-recipient
            detail.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    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.

````