search

Criar Cotação

circle-info

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.

hashtag
Criar Cotação

POST {{url_ambiente}}/{{version}}/quotation/contracting

Cria ou edita uma cotação.

hashtag
Headers

Name
Type
Description

Ocp-Apim-Subscription-Key*

key

chave de acesso da api.

Response

circle-info

Para editar uma cotação, basta enviar o identifier antes de answers, exemplo:

{
    "operationCode": "CONSTRUCTION-EQUIPMENT-MULTIPLE-PERIL-PARTNER",
    "quotationIdentifier": "ea0da0ea-1623-47b7-bbbe-75e8eee15ee0", 
    "registerNumber": "100000",
    "answers": [
    ...
    ...
    ]
}

hashtag
Request

hashtag
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: string

Pergunta 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: decimal

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

chevron-rightTipos de equipamentos (os codigos estão da maneira que devem ser enviados)hashtag

PILE-DRIVER = Bate estaca

CONCRETE-MIXERS = Betoneiras

BOMB-SPEAR = Bomba Lança

SUCTION-BOOSTER-PUMPS = Bombas de Sucção ou Recalque

CRUSHER = Britador

BULLDOZERS = Bulldozers

WHEEL-LOADER = Carregadeira Sobre Rodas

SOIL-COMPACTOR = Compactador de Solo

AIR-COMPRESSOR = Compressor de Ar

EARTHMOVER = Earthmover

CONSTRUCTION-ELEVATOR = Elevador de Obras

SCISSOR-LIFT-WITH-WHEELS = Elevador de Tesoura (com rodas)

PANTOGRAPHIC-HYDRAULIC-ELEVATOR = Elevador Hidráulico Pantográfico

FORK-LIFT = Empilhadeira

EXCAVATOR-MACHINE = Escavadeira

GENERATOR = Gerador

WINCHES-EXCLUSIVELY-CONSTRUCTION = Guinchos (exclusivamente em canteiros de obras)

TELESCOPIC-MANIPULATOR = Manipulador de Telescópio

HYDRAULIC-HAMMER = Martelo Hidráulico

VIBRATING-HAMMER = Martelo Vibratório

SMALL-LOADER = Mini Carregadeira

SMALL-EXCAVATOR = Mini Escavadeira

SMALL-BACKHOE-LOADER = Mini Retroescavedeira

GRADER = Motoniveladora

WHEEL-SHOVER = Pá Carregadeira

SHEEP-FEET = Pés de Carneiro

AERIAL-WORK-PLATFORM = Plataforma Aérea de Trabalho

LIFTING-PLATFORM = Plataforma Elevatória

BACKHOE = Retroescavadeira

ROAD-ROLLER = Rolo Compactador

BREAKER = Rompedor

SCRAPERS = Scrapers

LIGHTING-TOWER = Torre de Iluminação

FIXED-CONVEYORS = Transportadores Fixos (de correia, esteira, rosca sem fim o caçambas)

TRACTOR = Trator

ASPHALT-PLANT = Usina de Asfalto

VIBRATORS-CONCRETE = Vibradores para Concreto

ASPHALT-PAVER = Vibroacabadora de Asfalto

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.

chevron-rightCaso a pergunta de equipamento novo seja TRUE:hashtag

Se a pergunta de equipamento novo for TRUE, será necessário enviar as duas perguntas abaixo:

Code: EMISSION-DATE Type: date

❗ Obrigatório que esteja incluído no array.

Usada para sabermos a data de emissão da nota fiscal. ❗ Só é aceito equipamentos com nota fiscal emitida em até 60 dias.

Code: INVOICE-NUMBER Type: text

❗ Obrigatório que esteja incluído no array.

Usada para sabermos o número da nota fiscal.

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.

chevron-rightCaso BENEFIT-CLAUSE seja enviado TRUEhashtag

Se for TRUE, é necessário enviar as duas perguntas abaixo: Code: DOCUMENT-NUMBER Type: string

❗ Obrigatório que esteja incluído no array.

Usada para definir número de CNPJ que sera indenizado.

Code: INSTITUTION-NAME Type: string

❗ Obrigatório que esteja incluído no array.

Usada para definir o nome da instituição financeira que sera indenizado.

Code: MANUFACTURE-YEAR Type: int ❗ Obrigatório que esteja incluído no array.

Usada para informar o ano que o equipamento foi feito.

chevron-rightDetalhamento de regra para MANUFACTURE-YEARhashtag

Caso TRUE: Se a a pergunta de EQUIPMENT-NEW for TRUE:

Será permitidos equipamentos com fabricação do ano atual ou anterior. Caso FALSE:

Será permitidos equipamentos com fabricação de até 6 anos a partir do ano atual.

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

circle-info

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.

circle-info

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:

chevron-rightCoberturashashtag

  • DAMAGE-COVERAGE - Cobertura Básica

  • THEFT-COVERAGE - Roubo e/ou furto qualificado

  • OPERATIONS-WATER-COVERAGE - Operações em Proximidade de Água

  • ELECTRICAL-DAMAGE-COVERAGE - Danos Elétricos

  • CIVIL-LIABILITY-COVERAGE - Responsabilidade Civil Equipamentos

  • LOSS-RENT-COVERAGE - Perda de Aluguel

  • PAYMENT-THIRD-PARTIES-COVERAGE - Pagamento de Aluguel a Terceiros

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.

chevron-rightLimites de valores das coberturas selecionadashashtag

  • DAMAGE-COVERAGE - Sempre cobre 100% do valor do equipamento

  • THEFT-COVERAGE - Sempre cobre 100% do valor do equipamento

  • OPERATIONS-WATER-COVERAGE - Sempre cobre 100% do valor do equipamento

  • ELECTRICAL-DAMAGE-COVERAGE - Cobre no máximo 70% do valor do equipamento

  • CIVIL-LIABILITY-COVERAGE - Cobre no máximo 50% do valor do equipamento

  • LOSS-RENT-COVERAGE - Cobre 30% do valor do equipamento, se os 30% passar dos 100mil, cobre o limite de 100mil

  • PAYMENT-THIRD-PARTIES-COVERAGE - Cobre 30% do valor do equipamento, se os 30% passar dos 100mil, cobre o limite de 100mil

hashtag
Response

hashtag
Explicando campos de retorno

Field: success Type: boolean

Indica se a requisição foi feita com sucesso.

Field: executed Type: date

Data em que a requisição foi feita.

Field: errors Type: array

Array de erros ao fazer a requisição.

Field: item.quotationIdentifier Type: guid

Identificador da cotação.

Field: item.status Type: integer

Status da cotação.

Field: item.expiredAt Type: date

Data de expiração da cotação.

Field: item.quotationDocumentUrl Type: text

Url do documento de cotação.

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.

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.

Field: item.pricing[].price.rates[].description Type: text

Trata-se do nome da cobertura em português.

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 atrelada a cobertura (para RD so existem a franquia de "Default" para as coberturas).

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

PreviousEquipamentos para Construção CivilNextCriar Proposta

Last updated