POST Simular Oferta

Introdução

Retorna as opções disponíveis de quantidade de parcelas e valor das respectivas parcelas, com base no valor solicitado.

Rota

/Proposta/simulacao-valor/:propostaId

Authorization

Token

eyJ...

Headers Request

Accept	application/json
Content-Type	application/json

Detalhes da API

Campos obrigatórios e seus respectivos tipos

Campos

Campo	Tipo	Obrigatório	Descrição
`produtoId`	string \| inteiro	Sim	É obtido através da rota, [GET] /Proposta/oferta-produto/:propostaId
`convenioId`	string \| inteiro	Apenas para o ENERGIA	É obtido através da rota, [GET] /Proposta/oferta-produto/:propostaId
`tabelaJurosId`	string \| inteiro	Sim	É obtido através da rota, [GET] /Proposta/oferta-produto/:propostaId
`valor`	string \| inteiro	Sim	É obtido através da rota, [POST] /Proposta/consulta-valor-limite. No campo valorLimiteSolicitado
`tipoCalculo`	string \| inteiro	Sim	É obtido através da rota, [GET] /Contexto/proposta
`vencimento`	string	Sim	É obtido através da rota, [POST]/Proposta/calculo-vencimento.
`renda`	inteiro\| number	Sim	É obtido através da rota, [GET] /Proposta/oferta-produto/:propostaId. No campo valorRendaPresumida
`recalculo`	inteiro\| null	Não	Gerado pelo sistema
`contrato`	inteiro\| null	Apenas para o REFIN	É envia quando tem refin

O atributo valor pode assumir dois tipos de dados: Valor Solicitado ou Valor por Parcela.
Esses valores são retornados pela rota Proposta/ConsultaValorLimite, e a definição de qual será utilizado depende do parâmetro TipoCalculo:

TipoCalculo = 0 → retorna o Valor Solicitado
TipoCalculo = 1 → retorna o Valor por Parcela

Exemplo de Requisição e Resposta

Exemplo de Request

curl

curl --location 'https://app-crefaz-api-external-stag.azurewebsites.net/api/Proposta/simulacao-valor/:propostaId' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "produtoId": 6,
  "convenioId": 1,
  "tabelaJurosId": 318,
  "valor": 1000.00,
  "tipoCalculo": 0,
  "vencimento": "2023-03-20",
  "renda": 1412.00,
  "recalculo": null
}'

Body da Requisição

body

{
  "produtoId": 6,
  "convenioId": 1,
  "tabelaJurosId": 303,
  "valor": 1000.00,
  "tipoCalculo": 0,
  "vencimento": 2025-01-18,
  "renda": 1412.00,
  "recalculo": null,
  "contrato": null
}

Exemplo de Response

sucesso

{
  "success": true,
  "data": {
    "produtoId": 6,
    "tipoCalculo": 0,
    "tabelaJurosId": 2,
    "valorLimite": 1200,
    "prazoValor": [
      {
        "prazo": 18,
        "valor": 184
      },
      {
        "prazo": 16,
        "valor": 188.94
      },
      {
        "prazo": 15,
        "valor": 192.09
      }
    ]
  },
  "errors": null
}

erro

{
  "success": false,
  "data": null,
  "errors": [
    "O valor solicitado excede o valor limite de R$ xxxx"
  ]
}

Headers de Response (5)

Type	Value
Content-Type	application/json; charset=utf-8
Date	Fri, 04 Oct 2024 18:03:20 GMT
Server	Kestrel
Transfer-Encoding	chunked
Request-Context	appId=cid-v1:d0033e30-cc70-4961-9727-b7389fb39348