> ## Documentation Index
> Fetch the complete documentation index at: https://www.commercengine.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List seller payout invoices

> Retrieves a paginated list of seller invoices tracked by the payout pipeline. Each `SellerPayoutInvoice` carries the order and shipment it settles, the `SellerPayoutCharge` deductions applied to it, and its `payout_batch_id` once batched. Read `status` to tell where an invoice sits: `eligible` invoices are awaiting a batch, `on_hold` ones are excluded from batching until released. Call `/orders/filter-options` with a `listing_type` of `payout-invoice` for the fields and values accepted by `filters`.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json get /orders/payouts/invoices
openapi: 3.1.0
info:
  title: CE Admin APIs
  version: '1.0'
  summary: Comprehensive admin interface for managing your e-commerce platform
  description: >-
    Complete administrative API suite for Commerce Engine, providing powerful
    tools to manage products, orders, customers, inventory, analytics, and
    system configuration. Designed for administrators and backend integrations
    requiring full platform control.
  license:
    name: All Rights Reserved
    url: https://www.commercengine.io/contact-us
  contact:
    email: support@commercengine.io
    url: https://www.commercengine.io/contact-us
    name: Support
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/admin
    description: Staging Server
    variables:
      store_id:
        default: store_id
        description: Store ID
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/admin
    description: Prod Server
    variables:
      store_id:
        default: store_id
        description: Store ID
security:
  - Authorization: []
tags:
  - name: Analytics
    description: Analytics
  - name: Catalog
    description: Catalog
  - name: Coupons & promotions
    description: Coupons & promotions
  - name: Customers
    description: Customers
  - name: Filter Options
    description: Filter Options
  - name: Inventories
    description: Inventories
  - name: Marketplace
    description: Marketplace
  - name: Marketplace Catalog
    description: Marketplace Catalog
  - name: Media Gallery
    description: Media Gallery
  - name: Metrics
    description: Metrics
  - name: Orders
    description: Orders
  - name: Payments
    description: Payments
  - name: Payouts
    description: Payouts
  - name: POS
    description: POS
  - name: Segments
    description: Segments
  - name: Shipping
    description: Shipping
  - name: SSE
    description: SSE
  - name: Store
    description: Store
  - name: Webhooks
    description: Webhooks
paths:
  /orders/payouts/invoices:
    parameters: []
    get:
      tags:
        - Payouts
      summary: List seller payout invoices
      description: >-
        Retrieves a paginated list of seller invoices tracked by the payout
        pipeline. Each `SellerPayoutInvoice` carries the order and shipment it
        settles, the `SellerPayoutCharge` deductions applied to it, and its
        `payout_batch_id` once batched. Read `status` to tell where an invoice
        sits: `eligible` invoices are awaiting a batch, `on_hold` ones are
        excluded from batching until released. Call `/orders/filter-options`
        with a `listing_type` of `payout-invoice` for the fields and values
        accepted by `filters`.
      operationId: list-seller-payout-invoices
      parameters:
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/columnBasedFilters'
        - $ref: '#/components/parameters/sortByOptions'
        - $ref: '#/components/parameters/searchKeyword'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                  content:
                    properties:
                      payout_invoices:
                        type: array
                        items:
                          $ref: '#/components/schemas/SellerPayoutInvoice'
                      pagination:
                        $ref: '#/components/schemas/Pagination'
                    type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    pageNumber:
      name: page
      in: query
      required: false
      schema:
        type: integer
        default: 1
        minimum: 1
      description: page number of pagination list
    pageLimit:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        default: 25
        minimum: 1
      description: no of rows per page
    columnBasedFilters:
      name: filters
      in: query
      required: false
      schema:
        type: string
        example: >-
          {"condition":"AND","filters":[{"type":"data","field":"status","operator":"equals","value":"success"}]}
      description: JSON object
    sortByOptions:
      name: sort_by
      in: query
      required: false
      schema:
        description: >-
          json string in format {'field_name':'asc', 'other_field_name':'desc',
          ...}
        type: string
      description: 'JSON string format: {"field1":"asc", "field2":"desc"}'
    searchKeyword:
      name: search
      in: query
      required: false
      schema:
        type: string
      description: search keyword
  schemas:
    SellerPayoutInvoice:
      title: SellerPayoutInvoice
      description: >-
        A seller invoice tracked through the payout pipeline, from eligibility
        to settlement in a payout batch.
      type: object
      properties:
        batch_assigned_at:
          description: When the invoice was pulled into a payout batch. `null` until then.
          type:
            - string
            - 'null'
          format: date-time
        charges:
          description: >-
            `SellerPayoutCharge` records deducted from this invoice, such as
            `commission`, `tcs`, and `tds`. Their total is
            `marketplace_charges`.
          type: array
          items:
            $ref: '#/components/schemas/SellerPayoutCharge'
        coupon_discount_amount:
          description: Coupon discount deducted from the invoice total.
          type: number
        created_at:
          type: string
          format: date-time
        grand_total:
          description: >-
            Invoice total payable by the customer, after discounts, tax, and
            shipping. Basis for the payable amount.
          type: number
        id:
          description: Payout invoice ULID.
          type: string
        invoice_date:
          type: string
          format: date-time
        invoice_id:
          description: Underlying invoice database identifier.
          type: integer
        invoice_number:
          type: string
        loyalty_point_redeemed:
          description: Value of loyalty points redeemed against the invoice.
          type: number
        marketplace_charges:
          description: Commission and other marketplace charges deducted from this invoice.
          type: number
        marketplace_charges_tax_amount:
          description: Tax levied on `marketplace_charges`.
          type: number
        modified_at:
          type: string
          format: date-time
        order_id:
          type: integer
        order_number:
          type: string
        payout_batch_id:
          description: Linked payout batch ULID. `null` while the invoice is unbatched.
          type:
            - string
            - 'null'
        payout_eligible_at:
          description: >-
            Date the invoice becomes payable, derived from the seller's
            configured `hold_period_days`.
          type: string
          format: date
        promotion_discount_amount:
          description: Promotion discount deducted from the invoice total.
          type: number
        seller_id:
          type: string
        seller_name:
          type: string
          readOnly: true
        shipment_id:
          type:
            - integer
            - 'null'
        shipment_reference_no:
          type:
            - string
            - 'null'
        shipping_amount:
          description: Shipping charged on the invoice, excluding tax.
          type: number
        shipping_amount_including_tax:
          description: >-
            Shipping charged on the invoice, including tax. Counted towards the
            payout only when the seller's `include_shipping_in_payout` is
            `true`.
          type: number
        status:
          $ref: '#/components/schemas/SellerPayoutInvoiceStatus'
        sub_total:
          description: Item total before tax, discounts, and shipping.
          type: number
        sub_total_including_tax:
          description: >-
            Item total including tax. Counted towards the payout without tax
            when the seller's `include_tax_in_payout` is `false`.
          type: number
      x-tags:
        - Payouts
    Pagination:
      title: Pagination
      description: pagination metadata structure
      type: object
      properties:
        total_records:
          type: integer
        total_pages:
          type: integer
        previous_page:
          description: Previous page number
          type:
            - integer
            - 'null'
        limit:
          type: integer
          default: 25
        next_page:
          description: Next page number
          type:
            - integer
            - 'null'
    SellerPayoutCharge:
      title: SellerPayoutCharge
      type: object
      properties:
        base_amount:
          type: number
        charge_amount:
          type: number
        charge_basis:
          type: string
          enum:
            - percent
            - fixed
            - percent_plus_fixed
        charge_fixed_amount:
          type: number
        charge_percent:
          type: number
        charge_type:
          description: >-
            Nature of the deduction. `commission` is the marketplace fee, `tcs`
            and `tds` are statutory withholdings derived from the seller payout
            config, and `other` covers manually created charges.
          type: string
          enum:
            - commission
            - tcs
            - tds
            - other
        created_at:
          type: string
          format: date-time
        invoice_number:
          type: string
        modified_at:
          type: string
          format: date-time
        remarks:
          type:
            - string
            - 'null'
        tax_amount:
          type: number
        tax_rate:
          type: number
      x-tags:
        - Payouts
    SellerPayoutInvoiceStatus:
      title: SellerPayoutInvoiceStatus
      description: >-
        Payout state of an invoice. Invoices move `pending` → `eligible` →
        `batched` → `paid`. `on_hold` invoices are skipped by batching until
        released.
      type: string
      enum:
        - pending
        - eligible
        - batched
        - paid
        - on_hold
        - cancelled
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              success:
                type: boolean
              code:
                type: string
              error:
                type: object
                properties:
                  fieldname:
                    type: array
                    items:
                      type: string
    Unauthorized:
      description: Not authorized for given operation on the Resource
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Not authorized for given operation on the Resource.
              success:
                type: boolean
                default: false
              code:
                type: string
                example: unauthorized
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````