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

# List Transport Operator Subsidy Rules

> Lists transport operator subsidy rules.



## OpenAPI

````yaml /api-reference/bko/openapi.json get /api/v1/bko/transport-operator-subsidy-rules
openapi: 3.0.0
info:
  title: DEVMOB BKO API
  version: '1.0'
servers: []
security: []
tags:
  - name: Auth
    description: Authentication endpoints.
  - name: Benefit Category
    description: Global fare benefit category endpoints.
  - name: Benefit Program
    description: Platform fare benefit program endpoints.
  - name: Invite
    description: Invitation endpoints.
  - name: Member
    description: BKO internal member endpoints.
  - name: Notification
    description: BKO inbox notifications
  - name: Order
    description: Order query endpoints.
  - name: Organization
    description: Organization management endpoints.
  - name: Organization Address
    description: Organization address endpoints.
  - name: Payment
    description: Payment query endpoints.
  - name: Permission
    description: Permission catalog endpoints.
  - name: Place
    description: Place lookup endpoints.
  - name: Point
    description: Global point catalog endpoints.
  - name: Profile
    description: Authenticated BKO profile endpoints.
  - name: Receivable
    description: Receivable query endpoints.
  - name: Report
    description: Platform report endpoints.
  - name: Role
    description: Internal and reusable role endpoints.
  - name: Storage
    description: Storage upload signing endpoints.
  - name: Transfer
    description: Transfer query endpoints.
  - name: Transport Operator
    description: Transport operators
  - name: Transport Operator Quota
    description: Transport operator quotas
  - name: Transport Operator Route
    description: Transport operator route authorizations
  - name: Transport Operator Subsidy Rule
    description: Transport operator subsidy rules
  - name: Transport Operator Subsidy Settlement
    description: Transport operator subsidy settlements
  - name: User
    description: Platform user administration endpoints.
paths:
  /api/v1/bko/transport-operator-subsidy-rules:
    get:
      tags:
        - Transport Operator Subsidy Rule
      summary: List Transport Operator Subsidy Rules
      description: Lists transport operator subsidy rules.
      operationId: listBkoTransportOperatorSubsidyRules
      parameters:
        - name: limit
          required: false
          in: query
          schema:
            default: 10
            description: Items per page
            example: 10
            type: number
            minimum: 1
            maximum: 100
        - name: page
          required: false
          in: query
          schema:
            default: 1
            description: Page number
            example: 1
            type: number
            minimum: 1
        - name: cooperativeId
          required: false
          in: query
          description: Cooperative identifier
          schema:
            type: string
            format: uuid
            description: Cooperative identifier
        - name: transportOperatorId
          required: false
          in: query
          description: Transport operator identifier
          schema:
            type: string
            format: uuid
            description: Transport operator identifier
        - name: routeId
          required: false
          in: query
          description: Route identifier
          schema:
            type: string
            format: uuid
            description: Route identifier
        - name: status
          required: false
          in: query
          description: Rule status
          schema:
            description: Rule status
            type: string
            enum:
              - ACTIVE
              - INACTIVE
              - EXPIRED
        - name: sortBy
          required: false
          in: query
          schema:
            type: string
            enum:
              - startsAt
              - createdAt
            default: startsAt
            description: Field to sort by
            example: startsAt
        - name: sortOrder
          required: false
          in: query
          schema:
            default: desc
            description: Sort order
            example: desc
            type: string
            enum:
              - asc
              - desc
        - name: fields
          required: false
          in: query
          description: >-
            Comma-separated list of fields to include in the response. Supports
            dot notation for nested projection (e.g.
            `id,name,user.email,trips.route.id`). Unknown fields are silently
            dropped.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TransportOperatorSubsidyRule'
                  meta:
                    $ref: '#/components/schemas/PageMeta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - bearer: []
components:
  schemas:
    TransportOperatorSubsidyRule:
      type: object
      description: Regra de subsídio por quilômetro para permissionário
      properties:
        transportOperatorSubsidyRuleId:
          type: string
          format: uuid
          description: Identificador único
        cooperativeId:
          type: string
          format: uuid
          description: Cooperativa da regra
        transportOperatorId:
          type: string
          format: uuid
          description: Permissionário contemplado
        routeId:
          type: string
          format: uuid
          nullable: true
          description: Rota específica, quando a regra for por rota
        amountPerKm:
          type: integer
          description: Valor por quilômetro em centavos
        distanceSource:
          type: string
          enum:
            - PLANNED_ROUTE
            - GPS_AUDITED
            - ODOMETER_AUDITED
            - COMBINED_AUDIT
          description: Fonte usada para calcular a distância subsidiada
        startsAt:
          type: string
          format: date-time
          description: Início da vigência
        endsAt:
          type: string
          format: date-time
          nullable: true
          description: Fim da vigência
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
            - EXPIRED
          description: Status da regra
        createdBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que criou o registro, quando aplicável
        createdAt:
          type: string
          format: date-time
          description: Data de criação
        updatedBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que fez a última atualização, quando aplicável
        updatedAt:
          type: string
          format: date-time
          description: Data da última atualização
        deletedBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que removeu o registro, quando aplicável
        deletedAt:
          type: string
          format: date-time
          nullable: true
          description: Data de remoção
      required:
        - transportOperatorSubsidyRuleId
        - cooperativeId
        - transportOperatorId
        - routeId
        - amountPerKm
        - distanceSource
        - startsAt
        - endsAt
        - status
        - createdBy
        - createdAt
        - updatedBy
        - updatedAt
        - deletedBy
        - deletedAt
    PageMeta:
      type: object
      properties:
        limit:
          type: integer
          description: Items per page.
          example: 10
        page:
          type: integer
          description: Current page.
          example: 1
        totalItems:
          type: integer
          description: Total items.
          example: 142
        totalPages:
          type: integer
          description: Total pages.
          example: 15
      required:
        - limit
        - page
        - totalItems
        - totalPages
      description: Page-based pagination metadata.
    ValidationError:
      type: object
      properties:
        statusCode:
          type: integer
          description: HTTP status code.
          example: 400
        message:
          type: string
          description: Error message.
          example: Bad Request Error
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                description: Validation code.
                example: invalid_type
              message:
                type: string
                description: Validation message.
                example: Required
              path:
                type: string
                description: Invalid field path.
                example: name
            required:
              - code
              - message
              - path
      required:
        - statusCode
        - message
        - errors
      description: Validation error response.
    ApiError:
      type: object
      properties:
        statusCode:
          type: integer
          description: HTTP status code.
          example: 404
        error:
          type: string
          description: HTTP error name.
          example: Not Found
        message:
          type: string
          description: Machine-readable error code.
          example: resource.not_found
      required:
        - statusCode
        - error
        - message
      description: Domain error response.
  responses:
    BadRequestError:
      description: Validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
    UnauthorizedError:
      description: Authentication required.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ForbiddenError:
      description: Forbidden.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````