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

# Define Transport Operator Quota

> Defines a transport operator quota.



## OpenAPI

````yaml /api-reference/bko/openapi.json post /api/v1/bko/transport-operator-quotas
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-quotas:
    post:
      tags:
        - Transport Operator Quota
      summary: Define Transport Operator Quota
      description: Defines a transport operator quota.
      operationId: defineBkoTransportOperatorQuota
      parameters:
        - 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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DefineTransportOperatorQuotaRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransportOperatorQuota'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '409':
          $ref: '#/components/responses/ConflictError'
        '422':
          $ref: '#/components/responses/UnprocessableEntityError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - bearer: []
components:
  schemas:
    DefineTransportOperatorQuotaRequest:
      type: object
      description: Define transport operator quota payload
      properties:
        transportOperatorId:
          type: string
          format: uuid
          description: Transport operator identifier
        routeId:
          type: string
          format: uuid
          description: Route identifier
        periodType:
          type: string
          enum:
            - DAILY
            - WEEKLY
            - MONTHLY
            - CUSTOM
          description: Period type
        periodStart:
          type: string
          format: date-time
          description: Period start
        periodEnd:
          type: string
          format: date-time
          description: Period end
        maxTrips:
          type: integer
          description: Maximum trips
          minimum: 1
      required:
        - transportOperatorId
        - routeId
        - periodType
        - periodStart
        - periodEnd
        - maxTrips
    TransportOperatorQuota:
      type: object
      description: Cota máxima de viagens por permissionário, rota e período
      properties:
        transportOperatorQuotaId:
          type: string
          format: uuid
          description: Identificador único
        cooperativeId:
          type: string
          format: uuid
          description: Cooperativa da regra
        transportOperatorId:
          type: string
          format: uuid
          description: Permissionário controlado
        routeId:
          type: string
          format: uuid
          description: Rota controlada
        periodType:
          type: string
          enum:
            - DAILY
            - WEEKLY
            - MONTHLY
            - CUSTOM
          description: Tipo do período
        periodStart:
          type: string
          format: date-time
          description: Início do período
        periodEnd:
          type: string
          format: date-time
          description: Fim do período
        maxTrips:
          type: integer
          description: Quantidade máxima de viagens permitidas
        reservedTrips:
          type: integer
          description: Viagens em andamento ou reservadas
        consumedTrips:
          type: integer
          description: Viagens concluídas que consumiram cota
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
            - EXHAUSTED
          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:
        - transportOperatorQuotaId
        - cooperativeId
        - transportOperatorId
        - routeId
        - periodType
        - periodStart
        - periodEnd
        - maxTrips
        - reservedTrips
        - consumedTrips
        - status
        - createdBy
        - createdAt
        - updatedBy
        - updatedAt
        - deletedBy
        - deletedAt
    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'
    ConflictError:
      description: State conflict.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    UnprocessableEntityError:
      description: Business rule failed.
      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

````