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

# Realiza uma Cotação

> Este endpoint é responsável por realizar uma cotação dos planos de proteção vinculados ao parceiro logado.

O corpo da requisição deve contar o campo `model_id` que corresponde ao `ID` do modelo de dispositivo qu epode ser encontrado no recurso `/models` que dispõe este webservice.

Para realizar a contratação de um Plano Anual faz-necessário informar o plano de proteção que compreende este `endpoint`.

<ParamField query="model_id" type="string">
  Corresponde ao ID do modelo de dispositivo que pode ser encontrado no recurso `/models` que dispõe este webservice.
</ParamField>

<ParamField query="used" type="string">
  Informa se o dispositivo possui mais de três meses de uso. Valores possíveis: `true` ou `false`.
</ParamField>

<ParamField header="Authorization" type="string" required>
  Token de autenticação do tipo Bearer obtido através do endpoint de login.
</ParamField>

<ParamField header="Accept" type="string" required>
  Deve ser definido como `application/json`.
</ParamField>


## OpenAPI

````yaml GET /annual-plans/quote
openapi: 3.0.3
info:
  title: Clubfix Webservice de Parceiros
  description: >-
    Bem vido(a) à documentação do **Webservice de Parceiros** da **Clubfix.** Os
    recursos aqui dispostos são suplementados com exemplos de respostas
    esperadas, para nortear a implementação. Caso haja algum empecilho ou erro
    não esperado, fique à vontade para chamar o suporte em TI pelos canais que
    você já conhece.


    Observação: Utilize sempre os cabeçalhos `Content-Type` e `Accept` como
    `application/json`


    #### **URL Base**


    | **Ambiente** | **URL** |

    | --- | --- |

    | Homologação | [https://homolog.clubfix.com.br/webservice]() |

    | Produção | [https://clubfix.com.br/webservice]() |


    > NOTA: Para conseguir utilizar ambos ambientes, faz-se necessário solicitar
    pelo nosso time de suporte a geração das chaves de autenticação mencionadas
    na seção de **Autenticação**. 
      

    #### Paginação


    Para navegar nos recursos de listagem através de suas páginas, utilize as
    `parâmeros` dispostas na tabela abaixo


    | **Parâmetro** | **Descrição** |

    | --- | --- |

    | page | Corresponde à pagina que você deseja exibir os dados. |

    | per_page | Altera a quantidade de itens devolvidos em uma requisição. |

    | current_page | Identifica a pagina correspondente àquela requisição. |


    ### **Conhecendo os erros comuns**


    | **Status Code** | **Descrição** |

    | --- | --- |

    | 422 | Erro em algum parâmetro fornecido. O resultado deste erro será um
    objeto, onde a sua chave indicará o campo que não está em conformidade. |

    | 401 | Não autorizado. Significa que há ausência de um token válido na
    requisição, seja por expiração, não fornecimento, ou, no caso do login, as
    suas credenciais não estão corretas. |

    | 5** | Erro de servidor no endpoint requisitado. Quando isso ocorrer,
    contate o nosso suporte. |
  version: 1.0.0
servers: []
security: []
paths:
  /annual-plans/quote:
    get:
      summary: Realiza uma Cotação
      description: >-
        Este endpoint é responsável por realizar uma cotação dos planos de
        proteção vinculados ao parceiro logado.


        O corpo da requisição deve contar o campo `model_id` que corresponde ao
        `ID` do modelo de dispositivo qu epode ser encontrado no recurso
        `/models` que dispõe este webservice.


        Para realizar a contratação de um Plano Anual faz-necessário informar o
        plano de proteção que compreende este `endpoint`.
      parameters:
        - name: model_id
          in: query
          required: false
          schema:
            type: string
          example: '10'
        - name: used
          in: query
          required: false
          schema:
            type: string
          example: 'true'
      responses:
        '200':
          description: Success

````