Criar Cotação
Para equipamentos de contrução civil, possuimos algumas diferenças sobre os outros produtos. Para motivo de alerta, é necessário selecionar o método de pagamento que vem a partir do VariantIdentifier "000...000" pois é onde é agrupado o valor de todos equipamentos.
Criar Cotação
POST {{url_ambiente}}/{{version}}/quotation/contracting
Cria ou edita uma cotação.
Headers
Ocp-Apim-Subscription-Key*
key
chave de acesso da api.
Para editar uma cotação, basta enviar o identifier antes de answers, exemplo:
Request
Explicando campos de envio.
Field: OperationCode Tipo:
text❗ Campo Obrigatório.Campo usado para definir qual produto está sendo cotado.
Field: RegisterNumber
Tipo:
text❗ Campo Obrigatório.
Campo usado para definir qual o SusepNumber da corretora está sendo cotada. Neste caso, o susep da corretora é "100000".
Field: Answers Tipo:
array<answer>❗ Campo Obrigatório.Campo usado para enviar perguntas gerais de uma cotação.
Field: PERSON-TYPE Tipo:
string❗ Campo Obrigatório.Campo usado para definir o tipo de pessoa, sendo possivel enviar:
NATURAL = Pessoa Fisíca
LEGAL = Pessoa Jurídica
Field: INSURED-SOCIAL-NAME Tipo:
stringPergunta usada para informar o nome social do segurado, caso o mesmo possua.
* Pergunta apenas permitida quando PERSON-TYPE for NATURAL.
Field: INSURED-SOCIAL-NAME-AGREEMENT Tipo:
string❗ Obrigatório caso segurado possuir nome social.Pergunta usada para definir "Permitir a utilização de nome social do segurado na cotação". Caso segurado possuir nome social, então este campo deverá obrigatoriamente receber a resposta "true".
Code: INSURED-ADDRESS-COMPLEMENT Tipo:
text\Pergunta usada para definir o número da moradia do segurado.
Code: INSURED-ADDRESS-NEIGHBORHOOD Tipo:
text❗ Obrigatório que esteja incluído no array.Pergunta usada para definir o bairro do segurado.
Code: INSURED-ADDRESS-CITY Tipo:
text❗ Obrigatório que esteja incluído no array.Pergunta usada para definir a cidade do segurado.
Code: INSURED-ADDRESS-STATE Tipo:
text❗Obrigatório que esteja incluído no array.Pergunta usada para definir o estado do segurado.
Code: BROKERAGE-COMMISSION Tipo:
decimal❗Obrigatório que esteja incluído Pergunta usada para definir a comissão.Pode ser enviado valores entre 1 e 30. Valor padrão é 20.00.
Code: GRIEVANCE-DISCOUNT Tipo:
decimalPergunta usada para definir Agravo (aumento de preço sobre o netValue* da cotação). O Padrão é 0. * Preço líquido do produto sem IOF.
Code: ITEM-IDENTIFIER Type:
guid❗ Obrigatório que esteja incluído no array em cada equipamento com um novo. Pergunta para separar cada equipamento por um identificador.
Code: ITEM-TYPE Type:
text❗ Obrigatório que esteja incluído no array. Qual o tipo do equipamento.
Code: EQUIPMENT-NEW Type:
boolean❗ Obrigatório que esteja incluído no array. Para sabermos se o equipamento é novo.Para este item, sempre que for TRUE, a pergunta de MANUFACTURE-YEAR terá uma regra especifica.
Code: BRAND Type:
text❗ Obrigatório que esteja incluído no array. Qual a marca do equipamento.
Code: SERIAL-NUMBER Type:
text❗ Obrigatório que esteja incluído no array. Usada para definir o número de série do equipamento.
Code: ORIGIN Type:
text❗ Obrigatório que esteja incluído no array. Usada para saber se o equipamento foi produzido em território nacional ou no exterior. Os possíveis valores para serem enviados são:
NATIONAL = Nacional
IMPORTED = Importado
Code: BENEFIT-CLAUSE Type:
boolean❗ Obrigatório que esteja incluído no array.
Usada para definir responsável que sera indenizado em caso de sinistro no equipamentos.
Code: MANUFACTURE-YEAR Type:
int❗ Obrigatório que esteja incluído no array.Usada para informar o ano que o equipamento foi feito.
Code: ITEM-VALUE Type:
text❗ Obrigatório que esteja incluído no array. Pergunta usada para definir o valor do equipamento. ❗São aceitos equipamentos com valor máximo de ate RS 1.000.000,00 (um milhão).
Code: TYPE-USE Type:
text❗ Obrigatório que esteja incluído no array. Pergunta usada para definir o uso do equipamento.\Os possíveis valores para serem enviados são:
PERSONAL = Uso pessoal
LOCATIONS = Locação para terceiros
Code: COVERAGES Type:
array<array<answer>>❗ Obrigatório que esteja incluído no array. Campo para definir as coberturas para o equipamento (cada equipamento tem suas proprias coberturas).
Segue um exemplo como fica o array de items com o coverages (algumas perguntas/respostas foram apagadas para ficar mais limpo o exemplo com os coverages). Abaixo do json de exemplo, vai ter explicando as perguntas dentro do coverages.
Como podemos perceber, dentro do array de coverages, temos um outro array com duas perguntas que se repetem por cobertura adicionada.
Code: COVERAGE-TYPE Type:
text❗ Obrigatório que esteja incluído no array. (Cobertura básica é obrigatoria para qualquer equipamento)\Tipo de coberturas permitidos:
Code: COVERAGE-LIMIT-VALUE Type:
text❗ Obrigatório que esteja incluído no array.Pergunta usada para o valor da cobertura selecionada.\
Para cada cobertura temos um limite de valor, segue limite para as respectivas cobeturas.
Response
Explicando campos de retorno
Field: success Type:
booleanIndica se a requisição foi feita com sucesso.
Field: executed Type:
dateData em que a requisição foi feita.
Field: errors Type:
arrayArray de erros ao fazer a requisição.
Field: item.quotationIdentifier Type:
guidIdentificador da cotação.
Field: item.status Type:
integerStatus da cotação.
Field: item.expiredAt Type:
dateData de expiração da cotação.
Field: item.quotationDocumentUrl Type:
textUrl do documento de cotação.
Field: item.pricing Type:
arrayRetorna 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:
guidIdentificador do item cotado.
Field: item.pricing[].underwriting.approved Type:
booleanRetorna true ou false referente as regras de subscrição do produto.
Field: item.pricing[].underwriting.evaluations Type:
arrayRetorna aviso referente as questões do questionário de risco do produto.
Field: item.pricing[].price.commission Type:
decimalComissão de corretagem.
Field: item.pricing[].price.grievanceDiscount Type:
decimalPorcentagem de agravo adicionada ao valor da cotação, onde os valores permitidos vão de 0% até 500%.
Field: item.pricing[].price.itemValue Type:
decimalValor do item.
Field: item.pricing[].price.netValue Type:
decimalValor de prêmio líquido sem o IOF.
Field: item.pricing[].price.interestValue Type:
decimalValor 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:
decimalValor de IOF.
Field: item.pricing[].price.totalValue Type:
decimalValor de Prêmio Total, composto pelo prêmio líquido somado ao IOF.
Field: item.pricing[].price.policyLimit Type:
decimalValor de Limite da apólice.
Field: item.pricing[].price.rates Type:
arrayTrata-se de um array, que retornará todas as coberturas contratadas para o produto.
Field: item.pricing[].payment.financialType Type:
textTrata-se do tipo de financeiro que no caso é "Cobrança".
Field: item.pricing[].payment.paymentOptions Type:
arrayRetorna as opções de pagamento disponíveis que são: Boleto e Cartão de crédito.
Field: item.pricing[].price.rates[].code Type:
textExibe o código que identifica a ou as coberturas contratadas.
Field: item.pricing[].price.rates[].description Type:
textTrata-se do nome da cobertura em português.
Field: item.pricing[].price.rates[].limit Type:
decimalTrata-se do valor do limite da cobertura.
Field: item.pricing[].price.rates[].netValue Type:
decimalValor do prêmio específico de cada cobertura contratada.
Field: item.pricing[].price.rates[].deductible.code Type:
textTrata-se do código identificador de cada franquia.
Field: item.pricing[].price.rates[].deductible.text Type:
textNome da franquia atrelada a cobertura (para RD so existem a franquia de "Default" para as coberturas).
Field: item.pricing[].price.rates[].deductible.description Type:
textDescrição da franquia.
Field: item.pricing[].payment.paymentOptions[].paymentMethod Type:
textRetorna 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:
textForma de pagamento que pode ser escolhida: Boleto ou Cartão de crédito.
Field: item.pricing[].payment.paymentOptions[].installments Type:
arrayRetorna a quantidade de parcelas disponíveis para realizar o pagamento referente ao tipo de pagamento.
Field: item.pricing[].payment.paymentOptions[].installments[].identifier Type:
guidCódigo identificador da parcela. Esté é 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:
integerNúmero da respectiva parcela (2 parcela, número 2).
Field: item.pricing[].payment.paymentOptions[].installments[].commissionValue Type:
decimalValor de comissão de cada parcela.
Field: item.pricing[].payment.paymentOptions[].installments[].netValue Type:
decimalValor de prêmio líquido de cada parcela, ou seja, sem o IOF.
Field: item.pricing[].payment.paymentOptions[].installments[].interestValue Type:
decimalValor de juros de cada parcela.
Field: item.pricing[].payment.paymentOptions[].installments[].taxValue Type:
decimalIOF que implica em cada parcela.
Field: item.pricing[].payment.paymentOptions[].installments[].totalValue Type:
decimalValor total de cada parcela que é composto do valor líquido + IOF.
Field: item.pricing[].payment.paymentOptions[].installments[].installmentValue Type:
decimalValor total da parcela.
Field: item.pricing[].payment.paymentOptions[].installments[].installmentInterest Type:
decimalValor de juros da parcela.
Field: item.pricing[].payment.paymentOptions[].installments[].installmentTax Type:
decimalValor 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.
Last updated