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

# List supplier extra-cost requests

> Get a paginated list of costs a supplier asked to add to a purchase order,
and what was decided about each.

> **A pending request is not money.** It has not touched the order total,
> proration, the additional-fee mirror, a cost layer or a bill. Requests live
> in their own table for exactly that reason — approving one is what creates a
> real extra cost through the ordinary service.

`line_total` is always computed from `quantity × unit_price` at submission,
so a supplier cannot send a total that disagrees with its own parts.
`created_extra_cost_id` is `null` until approval and then holds the extra
cost the approval produced — the only link between a request and the money it
became.

Approving and rejecting are decisions rather than integrations, so they are
not exposed here; they live on the admin API.




## OpenAPI

````yaml /api-reference/build.yaml get /purchase-orders/{purchaseOrderId}/supplier-extra-cost-requests
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:
  /purchase-orders/{purchaseOrderId}/supplier-extra-cost-requests:
    get:
      tags:
        - Supplier Portal
      summary: List supplier extra-cost requests
      description: >
        Get a paginated list of costs a supplier asked to add to a purchase
        order,

        and what was decided about each.


        > **A pending request is not money.** It has not touched the order
        total,

        > proration, the additional-fee mirror, a cost layer or a bill. Requests
        live

        > in their own table for exactly that reason — approving one is what
        creates a

        > real extra cost through the ordinary service.


        `line_total` is always computed from `quantity × unit_price` at
        submission,

        so a supplier cannot send a total that disagrees with its own parts.

        `created_extra_cost_id` is `null` until approval and then holds the
        extra

        cost the approval produced — the only link between a request and the
        money it

        became.


        Approving and rejecting are decisions rather than integrations, so they
        are

        not exposed here; they live on the admin API.
      operationId: getSupplierExtraCostRequests
      parameters:
        - in: path
          name: purchaseOrderId
          required: true
          schema:
            type: integer
          description: Purchase order ID
        - in: query
          name: page
          schema:
            type: integer
            default: 1
          description: Page number for pagination
        - in: query
          name: per_page
          schema:
            type: integer
            default: 10
            maximum: 100
          description: Number of items per page (max 100)
      responses:
        '200':
          description: Paginated cost requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      description: >
                        A cost a supplier asked to add to a purchase order, and
                        what was decided about it. A **pending** request is not
                        money: it has not touched the order total, proration,
                        the additional-fee mirror, a cost layer or a bill.
                        Requests live in their own table for exactly that reason
                        — approving one is what creates a real extra cost
                        through the ordinary service.
                      properties:
                        id:
                          type: integer
                          example: 1
                        purchase_order_id:
                          type: integer
                          example: 7
                        supplier_purchase_order_shipment_id:
                          type: integer
                          nullable: true
                          description: >-
                            Set when the supplier attached the cost to one
                            shipment.
                          example: null
                        name:
                          type: string
                          example: Air freight surcharge
                        quantity:
                          type: string
                          example: '1.000000'
                        unit_price:
                          type: string
                          example: '450.000000'
                        line_total:
                          type: string
                          description: >
                            Always computed from `quantity × unit_price` at
                            submission — a supplier cannot send a total that
                            disagrees with its own parts.
                          example: '450.000000'
                        reference_number:
                          type: string
                          nullable: true
                          example: INV-8891
                        note:
                          type: string
                          nullable: true
                          example: Fuel surcharge for the air shipment
                        status:
                          type: string
                          enum:
                            - pending
                            - approved
                            - rejected
                          example: approved
                        requested_at:
                          type: string
                          format: date-time
                          example: '2026-08-28T16:44:25.000000Z'
                        reviewed_at:
                          type: string
                          format: date-time
                          nullable: true
                          example: '2026-08-28T16:44:37.000000Z'
                        review_note:
                          type: string
                          nullable: true
                          example: Agreed, air was our call.
                        created_extra_cost_id:
                          type: integer
                          nullable: true
                          description: >
                            `null` until approval, and then the id of the extra
                            cost the approval produced — the only link between a
                            request and the money it became. A pending request
                            has created nothing.
                          example: 1
                  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
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: Purchase order not found
          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.

````