# Detalhes Planos
Bem-vindo à documentação de Detalhes do Plano! Nossa API foi desenvolvida com o objetivo de fornecer informações detalhadas sobre os planos de saúde com base nas informações de uma proposta de simulação. Esta documentação abrangente irá guiá-lo na utilização efetiva do endpoint dedicado a obter os detalhes específicos do plano.
Esta API fornece detalhes do plano de saúde com base nas informações de uma proposta de simulação. O endpoint `/api/Comparador/Saude` é responsável por receber uma solicitação com os parâmetros adequados e retornar os detalhes do plano de saúde correspondente. Abaixo estão os exemplos de payload e resposta para ajudar você a entender a estrutura das requisições e respostas.
{% openapi src="/files/CYgp1yCW0yA5TUPLdou7" path="/api/Comparador/Saude" method="post" %}
[swagger.yaml](https://4021307994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbESNcRpuaRuojz5s6M0k%2Fuploads%2FpC88ex7BdNsARpw16AOm%2Fswagger.yaml?alt=media)
{% endopenapi %}
Example POST BODY
{% code title="body.json" overflow="wrap" %}
```json
[
{
"copay": false,
"idAdministradora": 1,
"idPlano": 965,
"idOperadora": 1,
"id_tipo_modalidade": 1,
"municipio": "São Paulo",
"uf": "São Paulo",
"usuarios": 2,
"perfil": {
"cargo": 1,
"conjulgadoBradesco": false,
"contratacao": 1,
"copay": false,
"desagruparPerfil": true,
"faixaetaria1": 0,
"faixaetaria2": 1,
"faixaetaria3": 0,
"faixaetaria4": 1,
"faixaetaria5": 0,
"faixaetaria6": 0,
"faixaetaria7": 0,
"faixaetaria8": 0,
"faixaetaria9": 0,
"faixaetaria10": 0,
"faixaetaria11": 0,
"faixaetaria12": 0,
"faixaetaria13": 0,
"faixaetaria14": 0,
"id_regiao": 1,
"limitador": 0,
"oferta": 0,
"operadoraAnterior": 0,
"planoAnterior": 0,
"perfilCliente": [
1,
2,
3,
4,
5
],
"produto": 4,
"precificacao": 1,
"tipoEmpresa": 8,
"titulares": 1,
"codigoFaixa": 0,
"faixasAdicionais": []
}
}
]
```
{% endcode %}
Example RESPONSE BODY
{% code title="body.json" overflow="wrap" %}
```json
{
"sucesso": true,
"mensagem": null,
"resposta": [
{
"rowguid": "00000000-0000-0000-0000-000000000000",
"idOperadora": 0,
"operadora": "OPERADORA NOME",
"logo": "https://example-url.com/dev/operadoras/00000000-0000-0000-0000-000000000000.svg",
"idPlano": 0,
"plano": "PLANO",
"idAdministradora": 0,
"administradora": "",
"valorTotal": 0.0000,
"percentualCopay": "Sem coparticipação (SEM remissão)",
"valorFaixaEtaria": [
{
"faixaEtaria": "00 a 18",
"usuarios": 0,
"valorUnitario": 0.0000,
"valorTotal": 0.0000
},
{
"faixaEtaria": "19 a 23",
"usuarios": 2,
"valorUnitario": 0,
"valorTotal": 0
},
// mais detalhes de faixas etárias
],
"perfil": {
"regiao": "",
"tipoEmpresa": "Contrato Social",
"coparticipacao": "Não",
"acomodacao": "Enfermaria",
// mais detalhes do perfil
},
"idCargo": 1,
"id_tipo_modalidade": 1,
"ordemPlano": 7,
"ordemOperadora": 1,
"id_regiao": 3,
"regiao": "SP3",
// mais detalhes do plano
}
]
}
```
{% endcode %}
Biblioteca
| Parametro | Descrição |
| --------------------- | --------------------------------------------------------------------------------------------- |
| perfilCliente | Array 1 a 5 ex: \[1,2,3,4,5] |
| produto | id\_produto |
| id\_regiao | Não obrigatório |
| id\_estado | CEP => /cep codMunicipioIBGE => Tarifa/UfMunicipioPrecificacao/ return id\_estado |
| id\_cidade | CEP => /cep codMunicipioIBGE => Tarifa/UfMunicipioPrecificacao/{cod\_ibge}/ return id\_cidade |
| tipoEmpresa | 1 a 8 |
| precificacao | 1 = Compulsoria, 2 = Flex |
| copay | true ou false |
| titulares | Número Titulares |
| profissao | => end point GET Entidade/Profissao/ |
| limitador | Limitador de valor R$ ex: 1000 |
| operadoraAnterior | Não obrigatório |
| planoAnterior | Não obrigatório |
| acomodacao | 0 = Ambos, 1 = Emfermaria, 2 = Privativo |
| oferta | Não obrigatório |
| operadoraPreferencial | Não obrigatório |
| bradescoCompulsorio | true ou false |
| desagruparPerfil | true ou false |
| contratacao | 0 = Ambulatorial/Hospitalar, 1 = Hospitalar, 2 = Ambulatorial |
| id\_cliente | Seu id de Cliente |
| faixaetaria (1 a 10) | 0 ou Quantidade |
| faixasAdicionais | Array ex: \[{"faixa": 79, "vidas": 3}] |
| idAdministradora | ID Administradora do Plano |
| idPlano | ID do Plano |
| id\_tipo\_modalidade | Id do Tipo de Modalidade |
| municipio | Nome do Municipio ex: "São Paulo" |
| uf | Nome do Estado ex: "São Paulo" |
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://doc.pro.gnesys.com.br/gnesysapi-documentation/documentos/detalhes-planos.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.