Consulta de cotação
Consulta cotação
GET
{{url_ambiente}}/v1/quotation/{registerNumber}/{identifier}
Retorna informações da cotação com base no identifier
Path Parameters
identifier*
string
identifier da cotação
registerNumber
String
Número Susep
Headers
Ocp-Apim-Subscription-Key*
md5
Chave de acesso
Explicando campos de response de cotação pelo identifier
Field: item.type Type:
string
Tipo da cotação.
Field: item.quotationIdentifier Type:
guid
Identifier da cotação.
Field: item.quotationNumber Type:
string
Numero da cotação.
Field: item.operationCode Type:
string
Código da operação usada para fazer a cotação.
Field: item.status Type:
string
status da cotação.
Field: item.expiredAt Type: date
Data de expiração da cotação.
Field: item.insuredName Type:
string
Nome do segurado.
Field: item.insuredIdentity Type:
string
Identificação do segurado.
Field: item.insuredEmail Type:
string
Email do segurado.
Field: item.insuredPhoneNumber Type:
string
Telefone do segurado.
Field: item.answers[].code Type:
string
Código da pergunta.
Field: item.answers[].answer Type: dynamic
Resposta da pergunta.
Dependendo do produto cotado, a answer pode ser um array de array contendo objetos compostos por code e answer ou apenas ser uma string, segue um exemplo abaixo:
OU
Field: item.proposal.date Type:
date
Data da proposta.
Field: item.proposal.number Type:
string
Número da proposta.
Field: item.proposal.DocumentUrl Type:
string
Documento da proposta.
Field: item.proposal.AcceptanceUrl Type:
string
Link para para envio de fotos e checkout.
Field: item.pricing Type:
array
Retorna as propriedades do item, taxas, valores, tipos de pagamentos. Array de items cotados. Ele pode retornar mais de 1 item também.
Field: item.pricing[].variantIdentifier Type:
guid
Identificador do item cotado.
Field: item.pricing[].underwriting.approved Type:
boolean
Retorna true ou false referente as regras de subscrição do produto.
Field: item.pricing[].underwriting.evaluations Type:
array
Retorna aviso referente as questões do questionário de risco do produto.
Field: item.pricing[].price.commission Type:
decimal
Comissão de corretagem.
Field: item.pricing[].price.grievanceDiscount Type:
decimal
Porcentagem de agravo adicionada ao valor da cotação, onde os valores permitidos vão de 0% até 500%.
Field: item.pricing[].price.itemValue Type:
decimal
Valor do item.
Field: item.pricing[].price.netValue Type:
decimal
Valor de prêmio líquido sem o IOF.
Field: item.pricing[].price.interestValue Type:
decimal
Valor de juros (Por enquanto nenhum produto possui juros, nem para boleto e nem para cartão, mas futuramente terá para boleto).
Field: item.pricing[].price.taxValue Type:
decimal
Valor de IOF.
Field: item.pricing[].price.totalValue Type:
decimal
Valor de Prêmio Total, composto pelo prêmio líquido somado ao IOF.
Field: item.pricing[].price.policyLimit Type:
decimal
Valor de Limite da apólice (no caso de Bikes, o valor do limite da apólice é igual ao valor informado para a bike).
Field: item.pricing[].price.rates Type:
array
Trata-se de um array, que retornará todas as coberturas contratadas para o produto.
Field: item.pricing[].payment.financialType Type:
text
Trata-se do tipo de financeiro que no caso é "Cobrança".
Field: item.pricing[].payment.paymentOptions Type:
array
Retorna as opções de pagamento disponíveis que são: Boleto e Cartão de crédito.
Field: item.pricing[].price.rates[].code Type:
text
Exibe o código que identifica a ou as coberturas contratadas. Ex: DAMAGE-COVERAGE, trata-se da cobertura de Danos à Bike.
Field: item.pricing[].price.rates[].description Type:
text
Trata-se do nome da cobertura em português. Ex: "Danos à Bike".
Field: item.pricing[].price.rates[].limit Type:
decimal
Trata-se do valor do limite da cobertura.
Field: item.pricing[].price.rates[].netValue Type:
decimal
Valor do prêmio específico de cada cobertura contratada.
Field: item.pricing[].price.rates[].deductible.code Type:
text
Trata-se do código identificador de cada franquia.
Field: item.pricing[].price.rates[].deductible.text Type:
text
Nome da franquia selecionada em português - Ex: "Padrão".
Field: item.pricing[].price.rates[].deductible.description Type:
text
Descrição da franquia.
Field: item.pricing[].payment.paymentOptions[].paymentMethod Type:
text
Retorna o nome da forma de pagamento que pode ser: Ticket (Boleto) ou CreditCard (Cartão de Crédito).
Field: item.pricing[].payment.paymentOptions[].paymentType Type:
text
Forma de pagamento que pode ser escolhida: Boleto ou Cartão de crédito.
Field: item.pricing[].payment.paymentOptions[].installments Type:
array
Retorna a quantidade de parcelas disponíveis para realizar o pagamento referente ao tipo de pagamento.
Field: item.pricing[].payment.paymentOptions[].installments[].identifier Type:
guid
Código identificador da parcela. Este é o código necessário enviar ao selecionar o método de pagamento. Exemplo: Se foi selecionado cartão de crédito, enviar o identificador daquele meio de pagamento.
Field: item.pricing[].payment.paymentOptions[].installments[].number Type:
integer
Número da respectiva parcela (2 parcela, número 2).
Field: item.pricing[].payment.paymentOptions[].installments[].commissionValue Type:
decimal
Valor de comissão de cada parcela.
Field: item.pricing[].payment.paymentOptions[].installments[].netValue Type:
decimal
Valor de prêmio líquido de cada parcela, ou seja, sem o IOF.
Field: item.pricing[].payment.paymentOptions[].installments[].interestValue Type:
decimal
Valor de juros de cada parcela.
Field: item.pricing[].payment.paymentOptions[].installments[].taxValue Type:
decimal
IOF que implica em cada parcela.
Field: item.pricing[].payment.paymentOptions[].installments[].totalValue Type:
decimal
Valor total de cada parcela que é composto do valor líquido + IOF.
Field: item.pricing[].payment.paymentOptions[].installments[].installmentValue Type:
decimal
Valor total da parcela.
Field: item.pricing[].payment.paymentOptions[].installments[].installmentInterest Type:
decimal
Valor de juros da parcela.
Field: item.pricing[].payment.paymentOptions[].installments[].installmentTax Type:
decimal
Valor de IOF de cada parcela.
Field: item.pricing[].payment.paymentOptions[].installments[].dueDates Type:
array<string>
Datas de vencimento da parcela caso a forma de pagamento seja boleto.
Field: item.modality.name Type:
string
Nome da modalidade.
Field: item.modality.text Type:
string
Nome da modalidade.
Field: item.modality.registerNumber Type:
string
Numero de registro da modalidade.
Field: item.modality.product.name Type:
string
Nome do produto.
Field: item.modality.product.text Type:
string
Nome do produto.
Field: item.modality.product.branch Type:
string
Ramo do seguro.
Field: item.modality.product.segment.name Type:
string
Nome do segmento.
Field: item.modality.product.segment.text Type:
string
Nome do segmento.
Field: item.brokerage.name Type:
string
Nome da corretora.
Field: item.brokerage.identity Type:
string
Identificação da corretora.
Field: item.brokerage.registerNumber Type:
string
Susep da corretora.
Field: item.brokerage.broker.phoneNumber Type:
string
Telefone do corretor.
Field: item.brokerage.broker.email Type:
string
Email do corretor.
Listagem de cotações
GET
{{url_ambiente}}/v1/quotation/{registerNumber}/all
Retorna lista de cotações
Path Parameters
registerNumber
String
Número Susep
Query Parameters
page
Passar o número da chave
sort
Possível ordernar pelo campo desejado. Os valores possíveis para esta query parameter são:
Caso queira definir se a ordem sera crescente ou não, basta passar o operador -
quando for decrescente.
Caso queria passar mais de um campo para ordenação, tambem é possivel, basta colocar os campos separados por ,
Exemplo:
{{url_ambiente}}/v1/policy/all?sort=-status,insuredname
No exemplo acima é passado dois campos para a ordenação, onde o status sera em ordem decrescente e o insuredName será em ordem crescente.
Search
Campo para buscar pelo nome do segurado ou CPF/CNPJ.
Modality
Campo para buscar pela modalidade.
Product
Campo para buscar pelo produto.
startDate
String
Data de inicio de cração da cotação.
endDate
String
Data limite de criação da cotação.
status
String
Campo para buscar pelo status. Os valores possíveis para esta query parameter são:
Draft= Rascunho.
Quoted = Cotada.
Saved = Salva.
Choosed = Proposta do corretor.
Proposal = Proposta enviada.
Confirmed = Confirmada.
Received = Recebido documentos do segurado.
Accepted = Aceita.
Finished = Finalizada.
Expired = Expirada.
type
String
Buscar pelo tipo da cotação.
Os valores possíveis para esta query parameter são:
Contracting = Contratação.
Renewal = Renovação.
Endorsement = Endosso.
Cancellation = Cancelamento.
Simulation = Simulação.
Headers
Ocp-Apim-Subscription-Key*
md5
Chave de acesso
Explicando campos de response da listagem de cotação
Field: totalItems Type:
integer
Numero total de cotações.
Field: itemsPerPage Type:
integer
Items exibidos por pagina .
Field: list[].quotationIdentifier Type: guid
Identifier da cotação .
Field: list[].expiredAt Type: date
Data de expiração da cotação .
Field: list[].createdAt Type: date
Data de criação da cotação .
Field: list[].type Type:
string
Tipo da cotação.
Field: list[].typeText Type:
string
Tipo da cotação.
Field: list[].status Type:
string
Status da cotação.
Field: list[].statusText Type:
string
Status da cotação.
Field: list[].insuredName Type:
string
Nome do segurado.
Field: list[].insuredEmail Type:
string
Email do segurado.
Field: list[].insuredPhoneNumber Type:
string
Telefone do segurado.
Field: list[].insuredIdentity Type:
string
Identificação do segurado.
Field: list[].modalityCode Type:
string
Modalidade da cotação.
Field: list[].modalityText Type:
string
Modalidade da cotação.
Field: list[].productCode Type:
string
Produto da cotação.
Field: list[].productText Type:
string
Produto da cotação.
Field: list[].personType Type:
string
Tipo de entidade, Fisica ou Juridica
Field: list[].quotationDocumentUrl Type:
string
Url do pdf de cotação.
Field: list[].previousPolicyNumber Type:
string
Numero da apólice anterior.
Last updated