Skip to main content

PUT Selecionar Oferta

Introdução

Seleciona a oferta de acordo com os parâmetros fornecidos.

Rota
/Proposta/oferta-produto/:propostaId
Authorization
Token eyJ...
Headers Request
Accept application/json
Content-Type application/json

Detalhes da API

Campos obrigatórios e seus respectivos tipos

Campos Obrigatórios
obtido através atravésobtido obtidoobtido
Campo Tipo
Descrição
id string | inteiro ÉSim Id da rota,proposta [POST]que /Propostaesta sendo enviada ==  propostaId
convenioId
 string | inteiroApenas pro ENERGIA É obtido através da rota, [GET] /Proposta/oferta-produto/:propostaId
tabelaJurosId
 string | inteiroSim É obtido através da rota, [GET] /Proposta/oferta-produto/:propostaId
produtoId
 string | inteiro SimÉ obtido através da rota, [GET] /Proposta/oferta-produto/:propostaId
plano

string | inteiro

ÉSim

obtido		 da

Prazo, rota,quantidade [POST]de /Proposta/simulacao-valor/:propostaIdvezes que vai ser as parcelas
prestacao
 string | inteiro ÉSim Valor atravésdas da rota, [POST] /Proposta/simulacao-valor/:propostaIdparcelas
diaRecebimento
inteiro| number
Não É obtido através da rota, [GET] /Proposta/oferta-produto/ 
tipoRenda
string | inteiro
 SimÉ obtido através da rota, [GET] /Contexto/proposta
vencimento
string | inteiro
Sim
É obtido através da rota, [POST] /Proposta/calculo-vencimento
valor

string | inteiro
 ÉSim Valor atravéscheio dado rota,contrato [POST]que /Proposta/simulacao-valor/o cliente esta solicitando
tipoCalculo
string | inteiro
 ÉSim TipoCalculo: através0 daé rota,o [GET]valor /Contexto/propostasolicitado;
TipoCalculo: 1 é o valor por parcela.
convenioDadosId
string | inteiro
 ÉApenas obtidopara atravéso da rota, [GET] /Proposta/oferta-produto/:propostaId
valor
string | inteiro
Energia		 É obtido através da rota, [GET] /Proposta/oferta-produto/:propostaId
convenioIdrenda
string | inteiro
 É obtido através da rota, [GET] /Proposta/oferta-produto/:propostaId
convenioDadosId
string | inteiro
É obtido através da rota, [GET] /Proposta/oferta-produto/:propostaId
valor
string | inteiro
É obtido através da rota, [GET] /Proposta/oferta-produto/:propostaId
convenioId
string | inteiro
Sim		 É obtido através da rota, [GET] /Proposta/oferta-produto/:propostaId
contratosRefin
Array
Apenas pro REFIN Apenas quando tem refin

Exemplo de Requisição e Resposta

Exemplo de Request
curl 
curl --location --request PUT 'https://app2-crefaz-api-external-stag.azurewebsites.net/api/Proposta/oferta-produto/:propostaId' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJh...' \
--data '{
    "id": 1028682574,
    "convenioId": 2,
    "tabelaJurosId": 2,
    "produtoId": 6,
    "plano": 16,
    "prestacao": 226.09,
    "renda": 1550.16,
    "diaRecebimento": 5,
    "tipoRenda": 0,
    "vencimento": "2025-01-06",
    "valor": 1200.00,
    "tipoCalculo": 1,
    "adicionais": [
        {
            "convenioDadosId": 13,
            "valor": "2",
            "convenioId": 2
        },
        {
            "convenioDadosId": 14,
            "valor": "01",
            "convenioId": 2
        }
    ],
    "contratosRefin": []
}'

Regra de Negócio

  • O objeto adicionais deve ser enviado no request sempre que o produto for Energia.

  • Dentro de adicionais, existe o campo ConvenioDadosId, que representa os dados obrigatórios exigidos pela Companhia de Energia (Convênio).

    • Esse campo corresponde à Unidade Consumidora ou ao Número do Cliente (a nomenclatura varia de acordo com a companhia de energia).

    • Trata-se da chave utilizada pela Crefaz para inserir a cobrança diretamente na fatura de energia do cliente.

  • É obrigatório que esse valor seja informado corretamente, pois:

    • Ele é sempre extraído da fatura do cliente.

    • Caso o valor esteja incorreto, não será possível registrar a cobrança.

image.png


Então: 

  • Convenio → corresponde à Companhia de Energia do cliente.

  • ConvenioId → identificador único (ID) da Companhia de Energia.

  • ConvenioDadosId → identificador dos dados obrigatórios do produto Energia.

 

Body da Requisição
body 
{
    "id": 1028682574,
    "convenioId": 2,
    "tabelaJurosId": 2,
    "produtoId": 6,
    "plano": 16,
    "prestacao": 226.09,
    "renda": 1550.16,
    "diaRecebimento": 5,
    "tipoRenda": 0,
    "vencimento": "2025-01-06",
    "valor": 1200.00,
    "tipoCalculo": 1,
    "adicionais": [
        {
            "convenioDadosId": 13,
            "valor": "2",
            "convenioId": 2
        },
        {
            "convenioDadosId": 14,
            "valor": "01",
            "convenioId": 2
        }
    ],
    "contratosRefin": []
}
Exemplo de Response
jsonsucesso 
{
    "success": true,
    "data": {
        "propostaId": 1028682574,
        "aprovado": true,
        "novoLimite": {
            "valorLimiteSolicitado": 1200.00,
            "valorLimiteParcela": 227.94,
            "valorLimiteMinimoParcela": 50.00
        }
    },
    "errors": null
}
erro 
{
  "success": false,
  "data": null,
  "errors": [
    "Dados não compativeis com a simulação!"
  ]
}
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

Back to top