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

# List findings

> Returns a cursor-paginated list of findings — discrepancies detected between the carrier invoice and the contract. See `AuditFinding.type` for the catalog of finding types.



## OpenAPI

````yaml GET /v1/invoice-audits/{audit_id}/findings
openapi: 3.1.0
info:
  title: Opereit Invoice Auditing API
  description: >-
    Public API for the Opereit Invoice Auditing product. Upload carrier
    contracts, run audits against incoming carrier invoices, and retrieve line
    items and findings.
  version: 1.0.0
servers:
  - url: https://api.opereit.com
    description: Production
security:
  - apiKey: []
paths:
  /v1/invoice-audits/{audit_id}/findings:
    get:
      summary: List invoice audit findings
      description: >-
        Returns a cursor-paginated list of findings — discrepancies detected
        between the carrier invoice and the contract. See `AuditFinding.type`
        for the catalog of finding types.
      operationId: listInvoiceAuditFindings
      parameters:
        - $ref: '#/components/parameters/AuditId'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Cursor'
        - name: type
          in: query
          description: Filter by finding type.
          schema:
            type: string
            enum:
              - RATE_MISMATCH
              - RATE_NOT_FOUND
              - SURCHARGE_MISMATCH
              - SURCHARGE_NOT_FOUND
              - WAIVED_SURCHARGE_BILLED
              - DUPLICATE_CHARGE
        - name: tracking_number
          in: query
          description: Return only findings tied to this tracking number.
          schema:
            type: string
        - name: excluded
          in: query
          description: >-
            If `false`, return only active (non-excluded) findings. If `true`,
            return only excluded findings. Omit to return both.
          schema:
            type: boolean
      responses:
        '200':
          description: Cursor-paginated list of findings.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - pagination
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AuditFinding'
                  pagination:
                    $ref: '#/components/schemas/CursorPagination'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    AuditId:
      name: audit_id
      in: path
      required: true
      description: ID of the invoice audit.
      schema:
        type: string
    Limit:
      name: limit
      in: query
      description: Number of items to return per request.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
    Cursor:
      name: cursor
      in: query
      description: Opaque cursor from a previous response. Omit on the first request.
      schema:
        type: string
  schemas:
    AuditFinding:
      type: object
      description: >-
        A discrepancy detected during the audit between what the carrier billed
        and what the contract specifies.
      required:
        - id
        - audit_id
        - line_item_id
        - tracking_number
        - type
        - description
        - charge_type
        - amount
        - excluded
        - created_at
      properties:
        id:
          type: string
        audit_id:
          type: string
        line_item_id:
          type: string
          description: Line item this finding is attached to.
        tracking_number:
          type: string
          description: Tracking number of the shipment the finding relates to.
        type:
          type: string
          enum:
            - RATE_MISMATCH
            - RATE_NOT_FOUND
            - SURCHARGE_MISMATCH
            - SURCHARGE_NOT_FOUND
            - WAIVED_SURCHARGE_BILLED
            - DUPLICATE_CHARGE
          description: >-
            The kind of discrepancy.


            - `RATE_MISMATCH`: billed rate ≠ contracted rate.

            - `RATE_NOT_FOUND`: no rate in the contract matches the shipment.

            - `SURCHARGE_MISMATCH`: billed surcharge ≠ contracted surcharge.

            - `SURCHARGE_NOT_FOUND`: surcharge billed but not present in the
            contract.

            - `WAIVED_SURCHARGE_BILLED`: a surcharge marked as waived in the
            contract was charged anyway.

            - `DUPLICATE_CHARGE`: the same charge appears more than once for the
            same shipment.
        expected_value:
          description: >-
            The value the contract specifies. Shape depends on `type` (e.g. `{
            "rate": "10.00", "currency": "EUR" }` for `RATE_MISMATCH`).
        actual_value:
          description: The value the carrier billed. Shape depends on `type`.
        description:
          type: string
          description: Human-readable explanation of the finding.
        charge_type:
          type: string
          enum:
            - RATE
            - SURCHARGE
            - ADJUSTMENT
          description: >-
            Kind of charge the finding is about (denormalized from the line
            item).
        charge_description:
          type:
            - string
            - 'null'
          description: >-
            Charge description from the invoice (denormalized from the line
            item).
        amount:
          type: string
          description: Amount billed for the line item, as a decimal string.
        service_type:
          type:
            - string
            - 'null'
          description: Carrier service code (denormalized from the line item).
        auditor:
          type: string
          description: Name of the audit rule that produced this finding.
        confidence:
          type: string
          description: >-
            Confidence level reported by the auditor (e.g. `HIGH`, `MEDIUM`,
            `LOW`).
        excluded:
          type: boolean
          description: >-
            Whether this finding has been marked as known/expected by the
            customer and should be excluded from active findings.
        created_at:
          type: string
          format: date-time
    CursorPagination:
      type: object
      required:
        - cursor
        - has_more
      properties:
        cursor:
          type:
            - string
            - 'null'
          description: >-
            Opaque cursor to use in the next request to fetch the next page.
            `null` if there are no more items.
        has_more:
          type: boolean
          description: Whether there are more items to fetch beyond the current page.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable error message.
  responses:
    Unauthorized:
      description: Authentication is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: basic
      description: >-
        HTTP Basic Auth using your API key. Send `Authorization: Basic
        base64(key_id:key_secret)`.

````