Criar Cotação

Criar Cotação

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

Cria ou edita uma cotação.

Headers

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

{
    "operationCode": "INSURANCE-BROKER-CIVIL-LIABILITY-PARTNER",
    "quotationIdentifier": "ea0da0ea-1623-47b7-bbbe-75e8eee15ee0", 
    "registerNumber": "100000",
    "answers": [
    ...
    ...
    ]
}

Request

{
    "operationCode": "INSURANCE-BROKER-CIVIL-LIABILITY-PARTNER",
    "registerNumber": "100000",
    "answers": [
        {
          "code": "MODALITY",
          "answer": "INSURANCE-BROKER-CIVIL-LIABILITY"
        },
        {
          "code": "PERSON-TYPE",
          "answer": "NATURAL"
        },
        {
          "code": "CONGENER",
          "answer": "RENEWAL"
        },
        {
          "code": "PREVIOUS-INSURER",
          "answer": "0"
        },
        {
          "code": "PREVIOUS-INSURER-NAME",
          "answer": "Seguradora anterior"
        },
        {
          "code": "START-VIGENCY-DATE",
          "answer": "2023-05-25T03:00:00.000Z"
        },
        {
          "code": "IDENTITY",
          "answer": "000.111.222-33"
        },
        {
          "code": "INSURED-NAME",
          "answer": "Nome segurado"
        },
        {
            "code": "INSURED-SOCIAL-NAME",
            "answer": "nome teste"
        },
        {
            "code": "INSURED-SOCIAL-NAME-AGREEMENT",
            "answer": true
        },
        {
          "code": "INSURED-EMAIL",
          "answer": "email@segurado.com"
        },
        {
          "code": "INSURED-CELLPHONE",
          "answer": "(11) 91111-2222"
        },
        {
          "code": "INSURED-ADDRESS-ZIPCODE",
          "answer": "12345-123"
        },
        {
          "code": "INSURED-ADDRESS-STREET",
          "answer": "Nome da rua"
        },
        {
          "code": "INSURED-ADDRESS-NUMBER",
          "answer": "Número"
        },
        {
          "code": "INSURED-ADDRESS-COMPLEMENT",
          "answer": ""
        },
        {
          "code": "INSURED-ADDRESS-NEIGHBORHOOD",
          "answer": "Bairro"
        },
        {
          "code": "INSURED-ADDRESS-CITY",
          "answer": "São Paulo"
        },
        {
          "code": "INSURED-ADDRESS-STATE",
          "answer": "SP"
        },
        {
          "code": "BROKERAGE-COMMISSION",
          "answer": 20
        },
        {
          "code": "GRIEVANCE-DISCOUNT",
          "answer": 0
        },
        {
            "code": "PROFESSIONAL-REGISTER",
            "answer": "123456"
        },
        {
            "code": "REGISTER-NUMBER-TYPE",
            "answer": "FULL"
        },
        {
            "code": "CATEGORIES",
            "answer": [
                "CAR",
                "AERONAUTICAL",
                "CONSORTIUM"
            ]
        },
        {
            "code": "DIGITAL-CERTIFICATION-COVERAGE"
        },
        {
            "code": "RETROACTIVITY",
            "answer": 3
        },
        {
            "code": "RETROACTIVITY-AGREEMENT"
        },
        {
            "code": "VIGENCY-RETROACTIVITY-AGREEMENT"
        },
        {
            "code": "CLAIMS",
            "answer": "0"
        },
        {
            "code": "CLAIM-EXPECTATION",
            "answer": false
        },
        {
            "code": "CLAIM-EXPECTATION-THIRD-PARTY"
        },
        {
            "code": "CLAIM-EXPECTATION-AGREEMENT"
        },
        {
            "code": "TERRITORIALITY",
            "answer": "BR"
        },
        {
            "code": "SCOPE",
            "answer": "NATIONAL"
        },
        {
            "code": "LIMIT-DEDUCTIBLE",
            "answer": [
                [
                    {
                        "code": "LIMIT",
                        "answer": 100000
                    },
                    {
                        "code": "DEDUCTIBLE",
                        "answer": "INCREASED"
                    }
                ]
            ]
        },
    ]
}

Explicando campos de envio.

{
	"operationCode": "DIRECTOR-OFFICERS-CIVIL-LIABILITY-PARTNER",
	"registerNumber": "100000",
	"answers":[],
}

Field: OperationCode Tipo: text ❗ Campo Obrigatório.

Campo usado para definir qual produto está sendo cotado. Neste caso, o produto é "Médicos", representado pelo operation code "MEDICAL-CIVIL-LIABILITY-PARTNER".

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: CONGENER Tipo: string ❗ Campo Obrigatório.

Campo usado para definir o tipo de cotação, sendo possivel enviar:

  • NEW = Cotação Nova.

  • RENEWAL = Renovação vinda de outra corretora (renovação congênere).

Field: PREVIOUS-INSURER Tipo: string ❗ Campo Obrigatório caso CONGENER = RENEWAL.

Campo usado para definir o cnpj que vem a cotação marcada com renovação congênere.

Field: PREVIOUS-INSURER-NAME Tipo: string ❗ Campo Obrigatório caso CONGENER = RENEWAL.

Campo usado para definir o nome que vem a cotação marcada com renovação congênere.

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: PROFESSIONAL-REGISTER Type: text ❗ Obrigatório que esteja incluído no array. Pergunta para definir o número de registro do corretor/corretora.


Code: REGISTER-NUMBER-TYPE Type: text ❗ Obrigatório que esteja incluído no array.

Pergunta usada para definir o tipo de susep.

Os possíveis valores para esta pergunta são:

  • FULL = Plena

  • BASIC = Susep Vida, Previdência e Capitalização


Code: CATEGORIES Type: array<string> ❗ Obrigatório que esteja incluído no array. Pergunta usada para definir as especialidades comercializados pelo corretor Pode-se enviar mais de uma resposta e depende do "REGISTER-NUMBER-TYPE" escolhido:

Categorias para tipo de Susep Plena (REGISTER-NUMBER-TYPE = FULL)
  • CAR = Automóvel

  • HEALTH-INSURANCE = Planos de Saúde

  • AERONAUTICAL = Aeronáutico

  • CONSORTIUM = Consórcio

  • OTHERS = Demais seguros não listados

  • BENEFITS-HEALTH-LIFE-PENSION = Seguro Saúde, Seguro de Vida e/ou Previdência Privada

  • GUARANTEE = Garantia

  • GENERAL-PROFESSIONAL-CIVIL-LIABILITY = RC Geral e RC Profissional

  • ENGINEERING-RISKS = Riscos de Engenharia

  • TRANSPORT = Transportes

Categorias para tipo de Susep Susep Vida, Previdência e Capitalização (REGISTER-NUMBER-TYPE = BASIC)
  • BENEFITS-HEALTH-LIFE-PENSION = Seguro Saúde, Seguro de Vida e/ou Previdência Privada

  • HEALTH-INSURANCE = Planos de Saúde


Code: DIGITAL-CERTIFICATION-COVERAGE Type: boolean ❗ Obrigatório que esteja incluído no array se for pessoa jurídica (PERSON-TYPE for LEGAL).\

Pergunta usada para definir se corretora é Certificadora Digital e deseja cobertura para esse serviço.


Code: RETROACTIVITY Type: integer

Pergunta usada para definir a retroatividade. Os possíveis valores para esta pergunta são:

Retroatividade
  • 0 = Sem retroatividade

  • 1 = 1 ano

  • 2 = 2 anos

  • 3 = 3 anos

  • 4 = 4 anos

  • 5 = 5 anos


Code: RETROACTIVITY-DATE Type: date (aaaa-mm-dd)

Pergunta usada para definir a data de retroatividade para renovação congênere. Para esta pergunta é possivel enviar qualquer data, e pode enviar 'RETROACTIVITY' como 0 (a data de RETROACTIVITY vai ser sobreescrita caso envie algum valor, mas ainda sera necessário enviar retroactivity e a resposta para renovação congênere).

Exemplo de json
.
.
.
{
    "code": "CONGENER",
    "answer": "RENEWAL"
},
.
.
.
{
    "code": "RETROACTIVITY",
    "answer": 0
},
{
    "code": "RETROACTIVITY-DATE",
    "answer": "2010-08-31"
},

Code: RETROACTIVITY-AGREEMENT Type: boolean ❗ Obrigatório que esteja incluído no array.

Pergunta usada para definir "Entendimento e concordância de retroatividade" se defida como true, indica que "Estou ciente e de acordo que a confirmação da data de retroatividade ocorrerá apenas num eventual sinistro, sendo obrigatório apresentar as apólices anteriores para comprovação. A apólice anterior não ode ter sido cancelada ou ter tido interrupção de vigência."


Code: REVENUES Type: text ❕ Obrigatório que esteja incluído no array para pessoa jurídica (se o PERSON-TYPE = LEGAL).\

Pergunta usada para definir o Faturamento nos últimos 12 meses.

Os possíveis valores para esta pergunta são:

Faturamento
  • 0.00-100000.00= Entre R$ 0,00 e R$ 100.000,00.

  • 100000.01-300000.00= Entre R$ 100.000,01 e R$ 300.000,00.

  • 300000.01-500000.00= Entre R$ 300.000,01 e R$ 500.000,00.

  • 500000.01-1000000.00= Entre R$ 500.000,01 e R$ 1.000.000,00.

  • 1000000.01-1500000.00= Entre R$ 1.000.000,01 e R$ 1.500.000,00.

  • 1500000.01-2000000.00= Entre R$ 1.500.000,01 e R$ 2.000.000,00.

  • 2000000.01-3000000.00= Entre R$ 2.000.000,01 e R$ 3.000.000,00.

  • 3000000.01-5000000.00= Entre R$ 3.000.000,01 e R$ 5.000.000,00.

  • 5000000.01-7500000.00= Entre R$ 5.000.000,01 e R$ 7.500.000,00.

  • 7500000.01-10000000.00= Entre R$ 7.500.000,01 e R$ 10.000.000,00.

  • 10000000.01-12500000.00 = Entre R$ 10.000.000,01 e R$ 12.500.000,00.

  • 12500000.01-15000000.00 = Entre R$ 12.500.000,01 e R$ 15.000.000,00.

Code: CLAIMS Type: text ❗ Obrigatório que esteja incluído no array. Pergunta usada para definir se ha Sinistro nos últimos 24 meses.\

Um sinistro é qualquer tipo de reclamação extrajudicial, processo judicial civil, criminal ou ético administrativo ou de qualquer tipo similar de pedido de reparação de dano(s) causados(s) pela prestação de seus serviços.\

Os possíveis valores para esta pergunta são:

  • 0 = nenhum

  • 1 = 1 reclamação

  • 2 = 2 reclamação

  • 3 ou mais não é possível


Code: CLAIM-EXPECTATION Type: boolean ❗ Obrigatório que esteja incluído no array.

Pergunta usada para definir se o segurado tem conhecimento ou Expectativas de Sinistro (alguma circunstância que possa gerar um sinistro).


Code: CLAIM-EXPECTATION-THIRD-PARTY Type: text ❗ Obrigatório que esteja incluído no array (se CLAIM-EXPECTATION for TRUE).

Pergunta usada para definir Possíveis terceiros reclamantes de expectativas de sinistro.


Code: CLAIM-EXPECTATION-AGREEMENT Type: boolean ❗ Obrigatório que esteja incluído no array (se CLAIM-EXPECTATION for TRUE).

Pergunta usada para definir "Entendimento e concordância de expectativas de sinistro" se defida como true, indica que "Entendido e acordado que não haverá cobertura securitária para qualquer tipo de fato já conhecido pelo segurado."


Code: TERRITORIALITY Type: text ❗ Obrigatório que esteja incluído no array. Atualmente so atendemos corretores/corretoras que atendem no Brasil Pergunta usada para definir a Territorialidade.\

Os possíveis valores para esta pergunta são:

  • BR = Brasil


Code: SCOPE Type: text ❗ Obrigatório que esteja incluído no array. Atualmente só atender corretoras/corretores com trabalhos nacionais. Pergunta usada para definir o Âmbito de trabalho do corretor/corretora.\

Os possíveis valores para esta pergunta são:

  • NATIONAL = nacional


Code: LIMIT-DEDUCTIBLE Type: array<array<answer>> ❗ Obrigatório que esteja incluído no array. Campo para definir Limite e Franquia, veremos mais detalhadamente a seguir.

{
   "identifier":"2942faa1-09b8-4345-9bdd-6764c4f1ad35",
   "operationCode":"INSURANCE-BROKER-CIVIL-LIABILITY-PARTNER",
   "answers":[
      {
         "code":"MODALITY",
         "answer":"INSURANCE-BROKER-CIVIL-LIABILITY"
      },
      {
         "code":"LIMIT-DEDUCTIBLE",
         "answer":[
            [
               {
                  "code":"LIMIT",
                  "answer":100000
               },
               {
                  "code":"DEDUCTIBLE",
                  "answer":"DEFAULT"
               }
            ]
         ]
      }
   ]
}

Code: LIMIT Type: decimal ❗ Obrigatório que esteja incluído no array.\

Os valores possíveis para esta pergunta são:

Limites
  • 30000.0 = R$ 30.000.

  • 50000.0 = R$ 50.000.

  • 100000.0 = R$ 100.000.

  • 150000.0 = R$ 150.000.

  • 200000.0 = R$ 200.000.

  • 250000.0 = R$ 250.000.

  • 300000.0 = R$ 300.000.

  • 400000.0 = R$ 400.000.

  • 500000.0 = R$ 500.000.

  • 600000.0 = R$ 600.000.

  • 700000.0 = R$ 700.000.

  • 800000.0 = R$ 800.000.

  • 900000.0 = R$ 900.000.

  • 1000000.0 = R$ 1.000.000.

  • 1100000.0 = R$ 1.100.000.

  • 1200000.0 = R$ 1.200.000.

  • 1300000.0 = R$ 1.300.000.\

  • 1400000.0 = R$ 1.400.000.\

  • 1500000.0 = R$ 1.500.000.\

  • 1600000.0 = R$ 1.600.000.\

  • 1700000.0 = R$ 1.700.000.\

  • 1800000.0 = R$ 1.800.000.\

  • 1900000.0 = R$ 1.900.000.\

  • 2000000.0 = R$ 2.000.000.


Code: DEDUCTIBLE Type: text ❗ Obrigatório que esteja incluído no array. Essa é uma parte um pouco mais complicada\

Pergunta usada para definir o tipo da franquia. Verifique abaixo como funciona a regra de franquias:\

Dependendo do tipo de categoria definido no campo CATEGORIES e o tipo de PESSOA (física ou jurídica), a resposta será diferente. Abaixo, você pode ver detalhadamente:

Franquias para pessoa física ( PERSON-TYPE = NATURAL )

Se for AERONAUTICAL

  • DEFAULT = Padrão - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.000,00 e o máximo de R$ 7.000,00

  • INCREASED = Majorada - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.500,00 e o máximo de R$ 8.000,00

  • REDUCED = Reduzida - 10% dos Prejuízos com Mínimo de R$ 1.500,00 e o Máximo de R$ 6.000,00

Se for CAR

  • DEFAULT = Padrão - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.000,00 e o máximo de R$ 7.000,00

  • INCREASED = Majorada - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.500,00 e o máximo de R$ 8.000,00

  • REDUCED = Reduzida - 10% dos Prejuízos com Mínimo de R$ 1.500,00 e o Máximo de R$ 6.000,00

Se for GUARANTEE

  • DEFAULT = Padrão - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.000,00 e o máximo de R$ 7.000,00

  • INCREASED = Majorada - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.500,00 e o máximo de R$ 8.000,00

  • REDUCED = Reduzida - 10% dos Prejuízos com Mínimo de R$ 1.500,00 e o Máximo de R$ 6.000,00

Se for GENERAL-PROFESSIONAL-CIVIL-LIABILITY

  • DEFAULT = Padrão - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.000,00 e o máximo de R$ 7.000,00

  • INCREASED = Majorada - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.500,00 e o máximo de R$ 8.000,00

  • REDUCED = Reduzida - 10% dos Prejuízos com Mínimo de R$ 1.500,00 e o Máximo de R$ 6.000,00

Se for ENGINEERING-RISKS

  • DEFAULT = Padrão - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.000,00 e o máximo de R$ 7.000,00

  • INCREASED = Majorada - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.500,00 e o máximo de R$ 8.000,00

  • REDUCED = Reduzida - 10% dos Prejuízos com Mínimo de R$ 1.500,00 e o Máximo de R$ 6.000,00

Se for TRANSPORT

  • DEFAULT = Padrão - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.000,00 e o máximo de R$ 7.000,00

  • INCREASED = Majorada - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.500,00 e o máximo de R$ 8.000,00

  • REDUCED = Reduzida - 10% dos Prejuízos com Mínimo de R$ 1.500,00 e o Máximo de R$ 6.000,00

Se for CONSORTIUM

  • DEFAULT = Padrão - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.000,00 e o máximo de R$ 7.000,00

  • INCREASED = Majorada - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.500,00 e o máximo de R$ 8.000,00

  • REDUCED = Reduzida - 10% dos Prejuízos com Mínimo de R$ 1.500,00 e o Máximo de R$ 6.000,00

Se for BENEFITS-HEALTH-LIFE-PENSION

  • DEFAULT = Padrão - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.000,00 e o máximo de R$ 7.000,00

  • INCREASED = Majorada - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.500,00 e o máximo de R$ 8.000,00

  • REDUCED = Reduzida - 10% dos Prejuízos com Mínimo de R$ 1.500,00 e o Máximo de R$ 6.000,00

Se for HEALTH-INSURANCE

  • DEFAULT = Padrão - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.000,00 e o máximo de R$ 7.000,00

  • INCREASED = Majorada - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.500,00 e o máximo de R$ 8.000,00

  • REDUCED = Reduzida - 10% dos Prejuízos com Mínimo de R$ 1.500,00 e o Máximo de R$ 6.000,00

Se for OTHERS

  • DEFAULT = Padrão - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.000,00 e o máximo de R$ 7.000,00

  • INCREASED = Majorada - 10% dos prejuízos indenizáveis com o mínimo de R$ 2.500,00 e o máximo de R$ 8.000,00

  • REDUCED = Reduzida - 10% dos Prejuízos com Mínimo de R$ 1.500,00 e o Máximo de R$ 6.000,00

Response

{
    "item": {
        "quotationIdentifier": "3a7d4d0f-905b-4abf-859d-8b1cebddb53a",
        "quotationDocumentUrl":"",
        "status": "Draft",
        "pricing": [
            {
                "variantIdentifier": "01d46264-70d5-4f44-aba5-805fedba0d7a",
                "underwriting": {
                    "approved": true,
                    "evaluations": []
                },
                "price": {
                    "commission": 82.09,
                    "grievanceDiscount": 0.0,
                    "netValue": 410.47,
                    "interestValue": 0.0,
                    "taxValue": 30.29,
                    "totalValue": 440.76,
                    "limitDeductible": {
                        "deductible": {
                            "answer": [
                                "DEFAULT"
                            ],
                            "questionText": "Franquia",
                            "answerText": [
                                "Padrão - 10% dos prejuízos indenizáveis com o mínimo de R$ 3.000,00"
                            ]
                        },
                        "limits": {
                            "answer": [
                                100000.0
                            ],
                            "questionText": "Limite de cobertura",
                            "answerText": [
                                "R$ 100.000"
                            ]
                        }
                    }
                },
                "payment": {
                    "financialType": "Charge",
                    "paymentOptions": [
                        {
                            "paymentMethod": "All",
                            "paymentType": "CreditCard",
                            "installments": [
                                {
                                    "identifier": "fab2abd1-88f3-40fe-b37f-0db0ed5ba9b5",
                                    "number": 1,
                                    "commissionValue": 82.09,
                                    "netValue": 410.47,
                                    "interestValue": 0.0,
                                    "taxValue": 30.29,
                                    "totalValue": 440.76,
                                    "installmentValue": 440.76,
                                    "installmentInterest": 0.0,
                                    "installmentTax": 30.29,
                                    "dueDates": [
                                        "2022-11-30T00:00:00Z"
                                    ]
                                },
                                {
                                    "identifier": "e33971fa-fc12-41ab-afbb-bc7e769c888f",
                                    "number": 2,
                                    "commissionValue": 82.09,
                                    "netValue": 410.47,
                                    "interestValue": 0.0,
                                    "taxValue": 30.29,
                                    "totalValue": 440.76,
                                    "installmentValue": 220.38,
                                    "installmentInterest": 0.0,
                                    "installmentTax": 15.14,
                                    "dueDates": [
                                        "2022-11-30T00:00:00Z",
                                        "2022-12-01T12:00:00Z"
                                    ]
                                },
                                {
                                    "identifier": "64dce913-cede-41d4-ac09-72c6b2baa969",
                                    "number": 3,
                                    "commissionValue": 82.09,
                                    "netValue": 410.47,
                                    "interestValue": 0.0,
                                    "taxValue": 30.29,
                                    "totalValue": 440.76,
                                    "installmentValue": 146.92,
                                    "installmentInterest": 0.0,
                                    "installmentTax": 10.1,
                                    "dueDates": [
                                        "2022-11-30T00:00:00Z",
                                        "2022-12-01T12:00:00Z",
                                        "2023-01-01T12:00:00Z"
                                    ]
                                },
                                {
                                    "identifier": "b16095f5-ace5-48bf-a75a-4d1a1823841b",
                                    "number": 4,
                                    "commissionValue": 82.09,
                                    "netValue": 410.47,
                                    "interestValue": 0.0,
                                    "taxValue": 30.29,
                                    "totalValue": 440.76,
                                    "installmentValue": 110.19,
                                    "installmentInterest": 0.0,
                                    "installmentTax": 7.57,
                                    "dueDates": [
                                        "2022-11-30T00:00:00Z",
                                        "2022-12-01T12:00:00Z",
                                        "2023-01-01T12:00:00Z",
                                        "2023-02-01T12:00:00Z"
                                    ]
                                }
                            ]
                        },
                        {
                            "paymentMethod": "Ticket",
                            "paymentType": "Ticket",
                            "installments": [
                                {
                                    "identifier": "547f2446-4248-4b9b-8431-1485e04bdee4",
                                    "number": 1,
                                    "commissionValue": 82.09,
                                    "netValue": 410.47,
                                    "interestValue": 0.0,
                                    "taxValue": 30.29,
                                    "totalValue": 440.76,
                                    "installmentValue": 440.76,
                                    "installmentInterest": 0.0,
                                    "installmentTax": 30.29,
                                    "dueDates": [
                                        "2022-11-30T00:00:00Z"
                                    ]
                                },
                                {
                                    "identifier": "3c901abc-8519-4eab-84ea-3d0d987e855d",
                                    "number": 2,
                                    "commissionValue": 82.09,
                                    "netValue": 410.47,
                                    "interestValue": 0.0,
                                    "taxValue": 30.29,
                                    "totalValue": 440.76,
                                    "installmentValue": 220.38,
                                    "installmentInterest": 0.0,
                                    "installmentTax": 15.14,
                                    "dueDates": [
                                        "2022-11-30T00:00:00Z",
                                        "2022-12-01T12:00:00Z"
                                    ]
                                },
                                {
                                    "identifier": "56b20baa-a04b-4b36-8fe8-bf704cc85279",
                                    "number": 3,
                                    "commissionValue": 82.09,
                                    "netValue": 410.47,
                                    "interestValue": 0.0,
                                    "taxValue": 30.29,
                                    "totalValue": 440.76,
                                    "installmentValue": 146.92,
                                    "installmentInterest": 0.0,
                                    "installmentTax": 10.1,
                                    "dueDates": [
                                        "2022-11-30T00:00:00Z",
                                        "2022-12-01T12:00:00Z",
                                        "2023-01-01T12:00:00Z"
                                    ]
                                },
                                {
                                    "identifier": "15df082d-643c-4ba7-8171-fe1eddd7e9d4",
                                    "number": 4,
                                    "commissionValue": 82.09,
                                    "netValue": 410.47,
                                    "interestValue": 0.0,
                                    "taxValue": 30.29,
                                    "totalValue": 440.76,
                                    "installmentValue": 110.19,
                                    "installmentInterest": 0.0,
                                    "installmentTax": 7.57,
                                    "dueDates": [
                                        "2022-11-30T00:00:00Z",
                                        "2022-12-01T12:00:00Z",
                                        "2023-01-01T12:00:00Z",
                                        "2023-02-01T12:00:00Z"
                                    ]
                                }
                            ]
                        }
                    ]
                }
            }
        ]
    },
    "success": true,
    "executed": "2022-11-23T13:41:44.798028Z"
}

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.limitDeductible Type: object

Limites e franquias selecionadas.


Field: item.pricing[].price.limitDeductible.deductible.answer Type: text

Tipo de franquia selecionada.


Field: item.pricing[].price.limitDeductible.deductible.answerText Type: text

Texto da franquia selecionada


Field: item.pricing[].price.limitDeductible.limits.answer Type: decimal

Valor do limite selecionado.


Field: item.pricing[].price.limitDeductible.limits.answerText Type: text

Texto do limite selecionado.


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

Last updated