Criar Cotação
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.
Request
{
"operationCode": "MEDICAL-CIVIL-LIABILITY-PARTNER",
"registerNumber": "100000",
"answers": [
{
"code": "MODALITY",
"answer": "MEDICAL-CIVIL-LIABILITY"
},
{
"code": "MEDICAL-EXPERT",
"answer": true
}
{
"code": "PERSON-TYPE",
"answer": "NATURAL"
},
{
"code": "CONGENER",
"answer": "NEW"
},
{
"code": "START-VIGENCY-DATE",
"answer": "2023-05-04T03:00:00.000Z"
},
{
"code": "IDENTITY",
"answer": "000.111.222-33"
},
{
"code": "INSURED-NAME",
"answer": "Teste Sistema Sul"
},
{
"code": "INSURED-SOCIAL-NAME",
"answer": "nome teste"
},
{
"code": "INSURED-SOCIAL-NAME-AGREEMENT",
"answer": true
},
{
"code": "INSURED-EMAIL",
"answer": "teste@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": "568568567"
},
{
"code": "CATEGORIES",
"answer": [
"OBSTETRICIAN"
]
},
{
"code": "RESIDENT",
"answer": false
},
{
"code": "PROCEDURES-ACTIVITIES",
"answer": [
"AESTHETIC-PROCEDURES",
"ENDOSCOPY-COLONOSCOPY",
"RADIOTHERAPY-CHEMOTHERAPY-IMMUNOTHERAPY",
"AESTHETIC-PROCEDURES-MEDICAL-SPECIALTY",
"HAIR-IMPLANT-TRANSPLANT"
]
},
{
"code": "RETROACTIVITY",
"answer": 0
},
{
"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": "DEFAULT"
}
]
]
}
]
}Explicando campos de envio.
{
"operationCode": "MEDICAL-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: MEDICAL-EXPERT Tipo:
trueCampo usado para definir se é perito médico.
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 seguradora (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:
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: PROFESSIONAL-REGISTER Type:
text❗ Obrigatório que esteja incluído no array.Pergunta usada para definir o registro do profissional.
Code: CATEGORIES Type:
array<string>❗ Obrigatório que esteja incluído no array.Pergunta usada para definir a especialidade médica.
Pode-se enviar mais de uma resposta dentro desse array de string, sendo elas:
Code: RESIDENT Type:
text❗ Obrigatório que esteja incluído no array para pessoa física ou especialidade não for Cirurgião(ã) Plástico(a) (se o PERSON-TYPE for NATURAL ou se CATEGORIES for diferente de PLASTIC-SURGERY).Pergunta usada para definir se o profissional é residente ou não.
Code: PROCEDURES-ACTIVITIES Type:
array<string>Se atua com alguns desses procedimentos e/ou atividades. Pode-se enviar mais de uma resposta dentro desse array de string, sendo elas:
Code: RETROACTIVITY Type:
integerPergunta usada para definir a retroatividade. Os possíveis valores para esta pergunta são:
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).
Code: RETROACTIVITY-AGREEMENT Type:
boolean❗ Obrigatório que esteja incluído no array caso tenha retroatividade (RETROACTIVITY for MAIOR que 0).Pergunta usada para definir "Entendimento e concordância de retroatividade". Se definida 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 pode 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 (PERSON-TYPE for LEGAL).Pergunta usada para definir o Faturamento nos últimos 12 meses. Os possíveis valores para esta pergunta são:
Code: CLAIMS Type:
text❗ Obrigatório que esteja incluído no array.Pergunta usada para definir se houve sinistros nos últimos 24 meses Os valores possíveis para esta pergunta são:
0 = nenhum.
1 = 1 reclamação.
2 = 2 reclamações.
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 definida 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. Abordaremos mais detalhadamente a seguir.
{
"identifier": "7dfac165-a63e-40d8-b6bb-23431e057982",
"operationCode": "MEDICAL-CIVIL-LIABILITY-PARTNER",
"answers": [
{
"code": "MODALITY",
"answer": "MEDICAL-CIVIL-LIABILITY"
},
{
"code": "LIMIT-DEDUCTIBLE",
"answer": [
[
{
"code": "LIMIT",
"answer": 30000
},
{
"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:
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:
Response
{
"item": {
"quotationIdentifier": "606af046-2a40-4688-af2c-148d65f73aef",
"quotationDocumentUrl":"",
"status": "Draft",
"pricing": [
{
"variantIdentifier": "96abb261-b6a1-418a-bcca-bc9b1b51cda3",
"underwriting": {
"approved": true,
"evaluations": []
},
"price": {
"commission": 334.29,
"grievanceDiscount": 0.0,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"limitDeductible": {
"deductible": {
"answer": [
"DEFAULT"
],
"questionText": "Franquia",
"answerText": [
"Padrão - 10% dos prejuízos indenizáveis com o mínimo de R$ 1.000,00"
]
},
"limits": {
"answer": [
100000.0
],
"questionText": "Limite de cobertura",
"answerText": [
"R$ 100.000"
]
}
}
},
"payment": {
"financialType": "Charge",
"paymentOptions": [
{
"paymentMethod": "All",
"paymentType": "CreditCard",
"installments": [
{
"identifier": "5b232a16-50a9-4cf2-8af8-df5c16368b28",
"number": 1,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 1794.78,
"installmentInterest": 0.0,
"installmentTax": 123.35,
"dueDates": [
"2022-11-30T00:00:00Z"
]
},
{
"identifier": "efc3ad52-5ed5-4441-88e1-99b40846b2b7",
"number": 2,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 897.39,
"installmentInterest": 0.0,
"installmentTax": 61.68,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z"
]
},
{
"identifier": "7b34f592-5836-43a3-aaba-cd1995eecdd3",
"number": 3,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 598.26,
"installmentInterest": 0.0,
"installmentTax": 41.12,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z"
]
},
{
"identifier": "6dafcbac-ff8c-4556-99d3-c6cabf33b32b",
"number": 4,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 448.7,
"installmentInterest": 0.0,
"installmentTax": 30.84,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z"
]
},
{
"identifier": "7bbf4da8-7bba-45ac-b8a9-da4f1a5df9b5",
"number": 5,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 358.96,
"installmentInterest": 0.0,
"installmentTax": 24.67,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z",
"2023-03-01T12:00:00Z"
]
},
{
"identifier": "e5bbab51-272f-446c-9dc1-86f0c5ccc025",
"number": 6,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 299.13,
"installmentInterest": 0.0,
"installmentTax": 20.56,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z",
"2023-03-01T12:00:00Z",
"2023-04-01T12:00:00Z"
]
},
{
"identifier": "34da341c-6ad6-4f54-a232-e03d957d0d21",
"number": 7,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 256.4,
"installmentInterest": 0.0,
"installmentTax": 17.62,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z",
"2023-03-01T12:00:00Z",
"2023-04-01T12:00:00Z",
"2023-05-01T12:00:00Z"
]
},
{
"identifier": "f39c436b-a240-4513-b53d-88318f2b726b",
"number": 8,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 224.35,
"installmentInterest": 0.0,
"installmentTax": 15.42,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z",
"2023-03-01T12:00:00Z",
"2023-04-01T12:00:00Z",
"2023-05-01T12:00:00Z",
"2023-06-01T12:00:00Z"
]
},
{
"identifier": "b5f63422-c096-4148-aa46-93b578218df6",
"number": 9,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 199.42,
"installmentInterest": 0.0,
"installmentTax": 13.71,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z",
"2023-03-01T12:00:00Z",
"2023-04-01T12:00:00Z",
"2023-05-01T12:00:00Z",
"2023-06-01T12:00:00Z",
"2023-07-01T12:00:00Z"
]
},
{
"identifier": "fad8e350-57fb-4033-8dbd-3b0de5b2a374",
"number": 10,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 179.48,
"installmentInterest": 0.0,
"installmentTax": 12.34,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z",
"2023-03-01T12:00:00Z",
"2023-04-01T12:00:00Z",
"2023-05-01T12:00:00Z",
"2023-06-01T12:00:00Z",
"2023-07-01T12:00:00Z",
"2023-08-01T12:00:00Z"
]
},
{
"identifier": "cc6a7f8d-b33d-4db1-9c6a-790015285ca5",
"number": 11,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 163.16,
"installmentInterest": 0.0,
"installmentTax": 11.21,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z",
"2023-03-01T12:00:00Z",
"2023-04-01T12:00:00Z",
"2023-05-01T12:00:00Z",
"2023-06-01T12:00:00Z",
"2023-07-01T12:00:00Z",
"2023-08-01T12:00:00Z",
"2023-09-01T12:00:00Z"
]
}
]
},
{
"paymentMethod": "Ticket",
"paymentType": "Ticket",
"installments": [
{
"identifier": "8f130cbd-7b0c-4155-b980-9e714497bdba",
"number": 1,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 1794.78,
"installmentInterest": 0.0,
"installmentTax": 123.35,
"dueDates": [
"2022-11-30T00:00:00Z"
]
},
{
"identifier": "e8e192f2-f096-4e2c-b09a-2b1699927162",
"number": 2,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 897.39,
"installmentInterest": 0.0,
"installmentTax": 61.68,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z"
]
},
{
"identifier": "566dded8-5abc-4458-a49f-02a980fcb9c0",
"number": 3,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 598.26,
"installmentInterest": 0.0,
"installmentTax": 41.12,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z"
]
},
{
"identifier": "1fbf5bf8-63da-4d15-8608-a6b3ddd0c1e3",
"number": 4,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 448.7,
"installmentInterest": 0.0,
"installmentTax": 30.84,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z"
]
},
{
"identifier": "eea96962-5ab5-4e85-9912-c86070725ac1",
"number": 5,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 358.96,
"installmentInterest": 0.0,
"installmentTax": 24.67,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z",
"2023-03-01T12:00:00Z"
]
},
{
"identifier": "b8cf254a-e608-4fd6-9cce-abced40cc88a",
"number": 6,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 299.13,
"installmentInterest": 0.0,
"installmentTax": 20.56,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z",
"2023-03-01T12:00:00Z",
"2023-04-01T12:00:00Z"
]
},
{
"identifier": "c844e005-006f-4293-a2c9-ffa09b0b19ae",
"number": 7,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 256.4,
"installmentInterest": 0.0,
"installmentTax": 17.62,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z",
"2023-03-01T12:00:00Z",
"2023-04-01T12:00:00Z",
"2023-05-01T12:00:00Z"
]
},
{
"identifier": "0349b356-5c80-4b63-ae0a-0c772f38e4cb",
"number": 8,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 224.35,
"installmentInterest": 0.0,
"installmentTax": 15.42,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z",
"2023-03-01T12:00:00Z",
"2023-04-01T12:00:00Z",
"2023-05-01T12:00:00Z",
"2023-06-01T12:00:00Z"
]
},
{
"identifier": "c76867c1-c504-457b-9e30-03b9f7a103c1",
"number": 9,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 199.42,
"installmentInterest": 0.0,
"installmentTax": 13.71,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z",
"2023-03-01T12:00:00Z",
"2023-04-01T12:00:00Z",
"2023-05-01T12:00:00Z",
"2023-06-01T12:00:00Z",
"2023-07-01T12:00:00Z"
]
},
{
"identifier": "c6ca222d-819d-4c75-bcd1-257729eff756",
"number": 10,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 179.48,
"installmentInterest": 0.0,
"installmentTax": 12.34,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z",
"2023-03-01T12:00:00Z",
"2023-04-01T12:00:00Z",
"2023-05-01T12:00:00Z",
"2023-06-01T12:00:00Z",
"2023-07-01T12:00:00Z",
"2023-08-01T12:00:00Z"
]
},
{
"identifier": "7c2f0686-0b8b-448c-8d41-5a620526fd4a",
"number": 11,
"commissionValue": 334.29,
"netValue": 1671.43,
"interestValue": 0.0,
"taxValue": 123.35,
"totalValue": 1794.78,
"installmentValue": 163.16,
"installmentInterest": 0.0,
"installmentTax": 11.21,
"dueDates": [
"2022-11-30T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z",
"2023-03-01T12:00:00Z",
"2023-04-01T12:00:00Z",
"2023-05-01T12:00:00Z",
"2023-06-01T12:00:00Z",
"2023-07-01T12:00:00Z",
"2023-08-01T12:00:00Z",
"2023-09-01T12:00:00Z"
]
}
]
}
]
}
}
]
},
"success": true,
"executed": "2022-11-23T20:55:03.0612167Z"
}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.limitDeductible Type:
objectLimites e franquias selecionadas.
Field: item.pricing[].price.limitDeductible.deductible.answer Type:
textTipo de franquia selecionada.
Field: item.pricing[].price.limitDeductible.deductible.answerText Type:
textTexto da franquia selecionada
Field: item.pricing[].price.limitDeductible.limits.answer Type:
decimalValor do limite selecionado.
Field: item.pricing[].price.limitDeductible.limits.answerText Type:
textTexto do limite selecionado.
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 selecionada em português - Ex: "Padrão".
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