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

# Lists all settlement reports



## OpenAPI

````yaml /products/commerce/v1/openapi.yaml get /settlements/reports
openapi: 3.1.0
info:
  license:
    name: Hellgate® API License
    url: https://starfish.team
  title: Commerce
  version: '0.1'
servers:
  - url: https://commerce1.on-hellgate.dev
    variables: {}
security:
  - mtls: []
  - api_key: []
tags: []
paths:
  /settlements/reports:
    get:
      tags:
        - settlements
      summary: Lists all settlement reports
      operationId: CommerceWeb.Settlements.SettlementReportController.index
      parameters:
        - description: >-
            Identifies the account. Required when authenticating via mTLS — omit
            when using an API key (account is inferred from the key).
          in: header
          name: X-Account-ID
          required: false
          schema:
            type: string
            x-struct: null
            x-validate: null
        - description: filter for reporting period start
          in: query
          name: from
          required: false
          schema:
            format: date-time
            type: string
            x-struct: null
            x-validate: null
        - description: ffilter for reporting period end
          in: query
          name: to
          required: false
          schema:
            format: date-time
            type: string
            x-struct: null
            x-validate: null
        - description: Page cursor for pagination
          in: query
          name: page
          required: false
          schema:
            type: integer
            x-struct: null
            x-validate: null
        - description: Maximum items per page
          in: query
          name: limit
          required: false
          schema:
            type: integer
            x-struct: null
            x-validate: null
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettlementReportsIndexResponse'
          description: Success
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Error
      callbacks: {}
components:
  schemas:
    SettlementReportsIndexResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/SettlementReportResponse'
          type: array
          x-struct: null
          x-validate: null
        next_page:
          nullable: true
          type: integer
          x-struct: null
          x-validate: null
      title: SettlementReportsIndexResponse
      type: object
      x-struct: >-
        Elixir.CommerceWeb.Schemas.SettlementsSchema.SettlementReportsIndexResponse
      x-validate: null
    ErrorResponse:
      properties:
        classifier:
          type: string
          x-struct: null
          x-validate: null
        code:
          type: integer
          x-struct: null
          x-validate: null
        message:
          type: string
          x-struct: null
          x-validate: null
      required:
        - code
        - classifier
        - message
      title: ErrorResponse
      type: object
      x-struct: Elixir.CommerceWeb.Schemas.ErrorsSchema.ErrorResponse
      x-validate: null
    SettlementReportResponse:
      properties:
        currency_code:
          type: string
          x-struct: null
          x-validate: null
        id:
          format: uuid
          type: string
          x-struct: null
          x-validate: null
        items:
          items:
            $ref: '#/components/schemas/SettlementItemSchema'
          type: array
          x-struct: null
          x-validate: null
        reporting_period_end:
          format: date-time
          type: string
          x-struct: null
          x-validate: null
        reporting_period_start:
          format: date-time
          type: string
          x-struct: null
          x-validate: null
      required:
        - id
        - items
        - currency_code
      title: SettlementReportResponse
      type: object
      x-struct: Elixir.CommerceWeb.Schemas.SettlementsSchema.SettlementReportResponse
      x-validate: null
    SettlementItemSchema:
      properties:
        account_id:
          format: uuid
          type: string
          x-struct: null
          x-validate: null
        commission:
          type: integer
          x-struct: null
          x-validate: null
        date:
          format: date-time
          type: string
          x-struct: null
          x-validate: null
        fee_type:
          type: string
          x-struct: null
          x-validate: null
        gross_credit_amount:
          type: integer
          x-struct: null
          x-validate: null
        gross_debit_amount:
          type: integer
          x-struct: null
          x-validate: null
        id:
          format: uuid
          type: string
          x-struct: null
          x-validate: null
        net_credit_amount:
          type: integer
          x-struct: null
          x-validate: null
        net_debit_amount:
          type: integer
          x-struct: null
          x-validate: null
        payment_id:
          format: uuid
          type: string
          x-struct: null
          x-validate: null
        settlement_report_id:
          format: uuid
          type: string
          x-struct: null
          x-validate: null
        type:
          enum:
            - OPENING_BALANCE
            - PAYMENT
            - REFUND
            - CHARGEBACK
            - COMMISSION
            - FEE
            - OTHER
            - REJECT
            - PAYOUT
            - CLOSING_BALANCE
          type: string
          x-struct: null
          x-validate: null
      required:
        - id
        - date
        - settlement_report_id
        - type
      title: SettlementItemSchema
      type: object
      x-struct: Elixir.CommerceWeb.Schemas.SettlementsSchema.SettlementItemSchema
      x-validate: null
  securitySchemes:
    mtls:
      description: >-
        Client certificate authentication via mTLS. Account-scoped routes
        additionally require the X-Account-ID header to identify the account.
      type: mutualTLS
    api_key:
      in: header
      name: X-API-Key
      type: apiKey

````