Skip to main content

POST Calcular Vencimento

Introdução

Retorna o vencimento previsto da primeira cobrança para o cliente.

Rota
/Proposta/calculo-vencimento
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 Obrigatorio Descrição
propostaId int Sim Identificador único da proposta, utilizado para referenciar a proposta específica.
produtoId int Sim Identificador do produto, obtido através da rota [GET] Proposta/oferta-produto/{propostaId}.
convenioId
int | null Apenas para o ENERGIA Identificador do convênio, obtido através da rota [GET] Proposta/oferta-produto/{propostaId}. Obrigatório apenas para o produto Energia.
rota
int | null Apenas para o ENERGIA Identificador da rota. Obrigatório apenas para o produto Energia.
leitura
string | null Apenas para o ENERGIA Informação de leitura. Obrigatório apenas para o produto Energia.
vencimento
string | null Não Data de vencimento associada à proposta.
tabelaJurosId
int Sim Identificador da tabela de juros, obtido através da rota [GET] Proposta/oferta-produto/{propostaId}.

Exemplo de Requisição e Resposta

Exemplo de Request
curl 
curl --location 'https://app2-crefaz-api-external-stag.azurewebsites.net/api/Proposta/calculo-vencimento' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "propostaId": 1028673845,
  "produtoId": 6,
  "convenioId": 1,
  "rota": null, // INFORMAR NULL
  "leitura": null, // INFORMAR NULL
  "vencimento": null, // INFORMAR NULL
  "tabelaJurosId": 2
}'
Body da Requisição
body 
{
  "propostaId": 1028673845,
  "produtoId": 6,
  "convenioId": 1,
  "rota": null,
  "leitura": null,
  "vencimento": null,
  "tabelaJurosId": 2
}

 

Exemplo de Response
sucesso 
{
  "success": true,
  "data": [
        {
          "vencimento": "2024-12-31"
        }
    ],
    "errors": null
}

 

erro

Em caso de falha, a propriedade data será retornada vazia.

{
  "success": true,
  "data": [],
  "errors": null
}

 

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

No Comments
Back to top