> For the complete documentation index, see [llms.txt](https://ffdesenvolvedores.gitbook.io/ff-desenvolvedores/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ffdesenvolvedores.gitbook.io/ff-desenvolvedores/produtos/corretores/proposta.md).
# Criar Proposta
## Criar proposta
`POST` `{{url_ambiente}}/{{version}}/quotation/proposal`
Cria uma proposta (atualiza informações adicionais)
#### Headers
| Name | Type | Description |
| ------------------------------------------------------------ | ---- | ----------------------- |
| Ocp-Apim\_Subscription-Key\* | key | chave de acesso da api. |
{% tabs %}
{% tab title="200: OK Retorno sucesso " %}
[#response](#response "mention")
{% endtab %}
{% tab title="400: Bad Request Retorno com mensagem do local do erro" %}
```json
Neste caso não foi enviado o PAYMENT-INSTALLMENT-IDENTIFIER resultando nos outros
erros como aparece abaixo.
{
"success": false,
"executed": "2023-05-25T15:04:47.1182243Z",
"errors": [
{
"code": "ANSWERS-NOT-EVALUATED",
"message": "One or more answers could not be evaluated.",
"properties": [
"PAYMENT-INSTALLMENT-IDENTIFIER",
"NET-VALUE",
"INTEREST-VALUE",
"TAX-VALUE",
"TOTAL-VALUE",
"INSTALLMENT-NUMBER"
]
}
]
}
```
{% endtab %}
{% tab title="401: Unauthorized Caso não envie uma " %}
{% code overflow="wrap" %}
```json
{
"statusCode": 401,
"message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API."
}
```
{% endcode %}
{% endtab %}
{% tab title="500: Internal Server Error Erro de aplicação/servidor" %}
{% endtab %}
{% endtabs %}
## Request
```json
{
"identifier": "3a7d4d0f-905b-4abf-859d-8b1cebddb53a",
"registerNumber": "100000",
"operationCode": "INSURANCE-BROKER-CIVIL-LIABILITY-PARTNER",
"answers": [
{
"code": "DUE-DAY",
"answer": "1"
},
{
"code": "PAYMENT-METHOD",
"answer": "CREDIT-CARD"
},
{
"code": "INSURED-BIRTH-DATE",
"answer": "1990-09-08T03:00:00.000Z"
},
{
"code": "PAYMENT-INSTALLMENT-IDENTIFIER",
"answer": "fab2abd1-88f3-40fe-b37f-0db0ed5ba9b5"
},
{
"code": "PEP",
"answer": "NO"
},
{
"code": "PEP-NAME",
"answer": ""
},
{
"code": "PEP-PARENTING",
"answer": ""
}
]
}
```
### Detalhamento request de proposta
> **Code**: INSURED-BIRTH-DATE\
> **Type**: `date`\
> ❗ Obrigatório que esteja incluído no array (apenas se o segurado for Pessoa Fisica).
>
> Pergunta usada para definir a data de nascimento do segurado.
> **Field:** RegisterNumber
>
> **Tipo:** `text`
>
> ❗ Campo Obrigatório.
>
> Campo usado para definir qual o SusepNumber da corretora que está sendo cotada. Neste caso, o susep da corretora é "100000".
> **Code**: PAYMENT-METHOD\
> **Type**: `text`\
> ❗ Obrigatório que esteja incluído no array.
>
> Pergunta usada para definir o método de pagamento.\
> Os possíveis valores para esta pergunta são:
>
> * *CREDIT-CARD*
> * *Para o ambiente de homologação, é necessário que o valor do prêmio da cotação, campo "Total Value", seja um número par, para que seja possível obter sucesso no checkout.*
> * *TICKET*
> **Code**: DUE-DAY\
> **Type**: `integer`\
> ❗ Obrigatório que esteja incluído no array. (apenas quando o PAYMENT-METHOD for TICKET).
>
> Pergunta usada para definir o dia de vencimento quando o PAYMENT-METHOD for TICKET (boleto).\
> \
> Só é possivel envio do dia 1 ao dia 20.
> **Code**: PAYMENT-INSTALLMENT-IDENTIFIER\
> **Type**: `guid`\
> ❗ Obrigatório que esteja incluído no array.
>
> O guid que será enviado nesse campo é retornado no array de installments, no retorno do endpoint de criar cotação.
> **Code**: PEP\
> **Type**: `string`\
> ❗ Obrigatório que esteja incluído no array quando for **PESSOA FÍSICA**.
>
> Pergunta usada para definir se é uma **pessoa exposta publicamente.**
>
> \
> Respostas para PEP:\
> \
> **NO:** Não é publicamente exposta.
>
> **YES:** É publicamente exposta.
>
> **RELATION:** Relacionamento próximo.
Caso PEP for RELATION, é necessário o envio de mais três perguntas, sendo elas:
```markdown
ode: PEP-NAME
Type: string
❗ Obrigatório que esteja incluído no array se PEP for igual a RELATION.
Pergunta usada para definir o nome da pessoa com relação.
```
```markdown
Code: PEP-PARENTING
Type: string
❗ Obrigatório que esteja incluído no array se PEP for igual a RELATION.
Pergunta usada para definir a relação da pessoa.
Opções de Envio:
- FATHER/MOTHER = Pai/Mãe
- SON/DAUGHTER = Filho/Filha
- SPOUSE = Cônjugue
- PARTNER = Companheiro/Companheira
- STEPSON = Enteado/Enteada
- OTHER = Outros
```
```markdown
Code: PEP-IDENTITY
Type: string
❗ Obrigatório que esteja incluído no array se PEP for igual a RELATION.
Pergunta usada para informar o CPF do PEP.
```
## Response
```json
{
"item": {
"quotationIdentifier": "3a7d4d0f-905b-4abf-859d-8b1cebddb53a",
"status": "Draft",
"proposal": {
"number": "52848305630001",
"date": "0001-01-01T00:00:00Z",
"documentUrl":""
},
"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-20T00: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-20T00: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-20T00: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-20T00: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-20T00: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-20T00: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-20T00: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-20T00:00:00Z",
"2022-12-01T12:00:00Z",
"2023-01-01T12:00:00Z",
"2023-02-01T12:00:00Z"
]
}
]
}
]
}
}
]
},
"success": true,
"executed": "2022-11-23T13:45:40.6711499Z"
}
```
### Explicando campos de retorno
Diferente do Response de Cotação, o de proposta possui um campo a mais logo após o "Status", que seria o proposal:
```json
"proposal": {
"number": "34990940670001",
"date": "2023-05-23T19:09:27.6820058Z",
"documentUrl": ""
}
```
> **Field**: number\
> **Type**: `text`
>
> Número da proposta.
***
> **Field**: date\
> **Type**: `date`
>
> Data que a proposta foi criada.
***
> **Field**: documentUrl\
> **Type**: `text`
>
> Link do documento da proposta.