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

# Consulta a própria contratante

> Ficha da contratante dona da chave: dados cadastrais, contratos vigentes e os planos disponíveis nesses contratos (os que podem aparecer em `plans[]` dos clientes).



## OpenAPI

````yaml /referencia/openapi.json get /v1/company
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/company:
    get:
      tags:
        - company
      summary: Consulta a própria contratante
      description: >-
        Ficha da contratante dona da chave: dados cadastrais, contratos vigentes
        e os planos disponíveis nesses contratos (os que podem aparecer em
        `plans[]` dos clientes).
      operationId: PublicCompanyController_get
      parameters: []
      responses:
        '200':
          description: Contratante da chave
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                  - errors
                properties:
                  data:
                    $ref: '#/components/schemas/PublicCompany'
                  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:
                  id: 42
                  name: Eixo Assistência
                  legalName: Eixo Assistência Ltda.
                  document: '12345678000195'
                  status: ACTIVE
                  contracts:
                    - id: 11
                      code: CT-2026-0001
                      name: Contrato Frota 2026
                      closingType: CUSTOMER
                      startDate: '2026-01-01'
                      endDate: null
                  plans:
                    - contractPlanId: 73
                      contractId: 11
                      contractCode: CT-2026-0001
                      planName: Plano Proteção Total
                      appliesTo: CUSTOMER
                meta: {}
                errors: []
        '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
        '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:
    PublicCompany:
      type: object
      properties:
        id:
          type: integer
          format: int32
          description: Identificador da contratante.
        name:
          type: string
          description: Nome fantasia.
        legalName:
          type: string
          description: Razão social.
        document:
          type: string
          description: CNPJ, só dígitos.
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
          description: 'Situação da contratante: ACTIVE ou INACTIVE.'
        contracts:
          description: Contratos vigentes (ativos e dentro da vigência) da contratante.
          type: array
          items:
            $ref: '#/components/schemas/PublicCompanyContract'
        plans:
          description: >-
            Planos disponíveis nos contratos vigentes — os que podem cobrir
            clientes.
          type: array
          items:
            $ref: '#/components/schemas/PublicCompanyPlan'
      required:
        - id
        - name
        - legalName
        - document
        - status
        - contracts
        - plans
    PublicCompanyContract:
      type: object
      properties:
        id:
          type: integer
          format: int32
          description: Identificador do contrato.
        code:
          type: string
          description: Código do contrato.
        name:
          type: string
          description: Nome do contrato.
        closingType:
          type: string
          enum:
            - VEHICLE
            - CUSTOMER
          description: >-
            Base de fechamento do contrato: por CUSTOMER (cliente) ou por
            VEHICLE (veículo).
        startDate:
          type: string
          format: date
          description: Início da vigência (`YYYY-MM-DD`).
        endDate:
          type: string
          format: date
          nullable: true
          description: >-
            Fim da vigência (`YYYY-MM-DD`). Nulo quando o contrato não tem data
            de fim.
      required:
        - id
        - code
        - name
        - closingType
        - startDate
        - endDate
    PublicCompanyPlan:
      type: object
      properties:
        contractPlanId:
          type: integer
          format: int32
          description: >-
            Identificador do plano dentro do contrato — o `contractPlanId` dos
            vínculos.
        contractId:
          type: integer
          format: int32
          description: Contrato ao qual pertence.
        contractCode:
          type: string
          description: Código do contrato ao qual pertence.
        planName:
          type: string
          description: Nome comercial do plano.
        appliesTo:
          type: string
          enum:
            - CUSTOMER
            - VEHICLE
          description: >-
            A que o plano se aplica: CUSTOMER (todos os veículos do cliente) ou
            VEHICLE.
      required:
        - contractPlanId
        - contractId
        - contractCode
        - planName
        - appliesTo
  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.