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

# Vincula um plano ao veículo

> Vincula um plano do contrato (o `contractPlanId` de `GET /v1/company`) ao veículo informado. Só planos com `appliesTo: VEHICLE` — um plano de cliente devolve 422 PLAN_TARGET_MISMATCH (use `POST /v1/customers/{id}/plans`). Plano inativo ou contrato fora de vigência devolve 422 PLAN_NOT_AVAILABLE; o mesmo plano já vigente no veículo devolve 409 PLAN_ALREADY_LINKED com `details.beneficiaryPlanId` apontando o vínculo existente. Veículo ou plano de outra contratante devolve 404.



## OpenAPI

````yaml /referencia/openapi.json post /v1/vehicles/{id}/plans
openapi: 3.0.0
info:
  title: Koolisys — API Pública
  description: >-
    Contrato da API pública de integração da Koolisys: atendimentos, catálogo de
    serviços, elegibilidade, cadastro e consulta de clientes e veículos e a
    própria contratante. Gerada a partir do código — rotas, DTOs de entrada,
    projeções de resposta e escopos declarados —, nunca mantida à mão.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api-koolisys.eixoassistencia.com.br
    description: API pública da Koolisys
security: []
tags:
  - name: auth
    description: Emissão do token de curta duração a partir da chave de API
  - name: attendances
    description: Abertura, consulta e listagem de atendimentos
  - name: services
    description: Catálogo de serviços disponíveis
  - name: eligibility
    description: Consulta de elegibilidade de cliente e veículo
  - name: customers
    description: Cadastro, consulta, busca e listagem de clientes da contratante
  - name: vehicles
    description: Consulta e listagem de veículos da contratante
  - name: company
    description: 'A própria contratante: contratos vigentes e planos disponíveis'
  - name: meta
    description: A própria especificação
paths:
  /v1/vehicles/{id}/plans:
    post:
      tags:
        - vehicles
      summary: Vincula um plano ao veículo
      description: >-
        Vincula um plano do contrato (o `contractPlanId` de `GET /v1/company`)
        ao veículo informado. Só planos com `appliesTo: VEHICLE` — um plano de
        cliente devolve 422 PLAN_TARGET_MISMATCH (use `POST
        /v1/customers/{id}/plans`). Plano inativo ou contrato fora de vigência
        devolve 422 PLAN_NOT_AVAILABLE; o mesmo plano já vigente no veículo
        devolve 409 PLAN_ALREADY_LINKED com `details.beneficiaryPlanId`
        apontando o vínculo existente. Veículo ou plano de outra contratante
        devolve 404.
      operationId: PublicVehiclesController_linkPlanToVehicle
      parameters:
        - name: id
          required: true
          in: path
          schema:
            format: int64
            example: 9001
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkPublicPlanRequestDto'
            examples:
              default:
                value:
                  contractPlanId: 73
      responses:
        '201':
          description: Plano vinculado
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                  - errors
                properties:
                  data:
                    $ref: '#/components/schemas/PublicPlanLink'
                  meta:
                    type: object
                    description: Metadados da resposta — vazio nesta operação.
                    properties: {}
                  errors:
                    type: array
                    description: Sempre vazio numa resposta de sucesso.
                    items:
                      type: object
                    maxItems: 0
              example:
                data:
                  contractPlanId: 73
                  contractCode: CT-2026-0001
                  planName: Plano Proteção Total
                  appliesTo: VEHICLE
                  linkedTo: VEHICLE
                  vehicleId: 9001
                  startedAt: '2026-08-20T13:05:00.000Z'
                meta: {}
                errors: []
        '400':
          description: VALIDATION_ERROR
          content:
            application/json:
              example:
                data: null
                errors:
                  - code: VALIDATION_ERROR
                    message: 'customerDocument: Documento do cliente é obrigatório'
                    field: customerDocument
        '401':
          description: INVALID_TOKEN
          content:
            application/json:
              example:
                data: null
                errors:
                  - code: INVALID_TOKEN
                    message: Token inválido.
        '403':
          description: INSUFFICIENT_SCOPE
          content:
            application/json:
              example:
                data: null
                errors:
                  - code: INSUFFICIENT_SCOPE
                    message: Escopo insuficiente para este endpoint.
                    details:
                      requiredScope: attendances.read
        '404':
          description: NOT_FOUND
          content:
            application/json:
              example:
                data: null
                errors:
                  - code: NOT_FOUND
                    message: Attendance not found
        '409':
          description: PLAN_ALREADY_LINKED
          content:
            application/json:
              example:
                data: null
                errors:
                  - code: PLAN_ALREADY_LINKED
                    message: Este plano já está vigente para este beneficiário
                    details:
                      beneficiaryPlanId: 3101
        '422':
          description: PLAN_NOT_AVAILABLE
          content:
            application/json:
              example:
                data: null
                errors:
                  - code: PLAN_NOT_AVAILABLE
                    message: Plano inativo neste contrato
        '429':
          description: RATE_LIMITED
          content:
            application/json:
              example:
                data: null
                errors:
                  - code: RATE_LIMITED
                    message: Limite de requisições excedido.
                    details:
                      retryAfterSeconds: 42
        '503':
          description: FEATURE_DISABLED
          content:
            application/json:
              example:
                data: null
                errors:
                  - code: FEATURE_DISABLED
                    message: 'Feature is disabled: public_api.enabled'
      security:
        - apiToken: []
components:
  schemas:
    LinkPublicPlanRequestDto:
      type: object
      properties:
        contractPlanId:
          type: integer
          format: int32
          example: 73
          description: >-
            Identificador do plano dentro do contrato — o mesmo `contractPlanId`
            devolvido por `GET /v1/company`.
      required:
        - contractPlanId
    PublicPlanLink:
      type: object
      properties:
        contractPlanId:
          type: integer
          format: int32
          description: >-
            Identificador do plano dentro do contrato (o mesmo de `GET
            /v1/company`).
        contractCode:
          type: string
          description: Código do contrato ao qual o plano pertence.
        planName:
          type: string
          description: Nome comercial do plano.
        appliesTo:
          type: string
          enum:
            - CUSTOMER
            - VEHICLE
          description: >-
            A que o plano se aplica: CUSTOMER (cobre todos os veículos do
            cliente) ou VEHICLE (cobre um veículo por vínculo).
        linkedTo:
          type: string
          enum:
            - CUSTOMER
            - VEHICLE
          description: >-
            Onde o vínculo foi feito: no cliente (CUSTOMER) ou num veículo dele
            (VEHICLE).
        vehicleId:
          type: integer
          format: int32
          nullable: true
          description: >-
            Veículo do vínculo quando `linkedTo` é VEHICLE. Nulo quando é no
            cliente.
        startedAt:
          type: string
          format: date-time
          description: Início da vigência do vínculo (ISO 8601, UTC).
      required:
        - contractPlanId
        - contractCode
        - planName
        - appliesTo
        - linkedTo
        - vehicleId
        - startedAt
  securitySchemes:
    apiToken:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: >-
        Token de curta duração devolvido por POST /v1/auth/token, carregando os
        escopos concedidos à chave — exigido por todo endpoint de dados.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.