Simulação de uma renegociação

Request

ENDPOINT

/renegotiation/simulation

MÉTODO

POST

Request Body

{
	"contract_number": "ABCD/1",
	"amortization_type": "installment_payment",
	"reference_date": "2022-07-20",
	"installments": [{
		"installment_key": "ca5741c7-99a2-42e7-92a1-9328a36e4e88"
	}],
	"discount_percentage": 0.2,
	"amount_percentage": 100
}

Body Params

Campo	Tipo	Descrição	Caracteres
contract_number	string	Número do contrato.	10
amortization_type	enum	Tipo de amortização.	Enumeradores
reference_date	date	Data de referencia da renegociação.	10
installments	array of objects	Parcelas renegociadas.	Installments array of objects
discount_percentage	float	Percentual de desconto que será calculado sobre o valor presente da renegociação.	10
amount_percentage	float	Valor de desconto que será aplicado sobre o valor presente da renegociação.	10

Installments array of objects

Campo	Tipo	Descrição	Caracteres
installment_key	string	key da parcela a ser renegociada	chave uuid

Response

STATUS

200

Response Body

{
  "contract_number": "ABCD/1",
  "discount_percentage": 0.2,
  "payment_amount": 240,
  "reference_date": "2022-07-20",
  "proposal_due_date": "2022-07-20",
  "requester_name": "Requester",
  "amortization_type": "installment_payment",
  "requester_key": "bcc16a6d-ce21-4cd4-8d8c-d26f89ccc685",
  "issuer_name": "issuer",
  "issuer_document_number": "98765432100",
  "affected_installments": [
    {
      "installment_key": "ca5741c7-99a2-42e7-92a1-9328a36e4e88",
      "due_date": "2022-05-01",
      "principal_amount": 100,
      "interest_amount": 20,
      "fine_amount": 5,
      "total_amount": 125,
      "present_amount": 100,
      "paid_amount": 80
    },
    {
      "installment_key": "6597a073-ea7a-4447-b250-f4d3f07b0b74",
      "due_date": "2022-06-01",
      "principal_amount": 100,
      "interest_amount": 20,
      "fine_amount": 5,
      "total_amount": 125,
      "present_amount": 100,
      "paid_amount": 80
    },
    {
      "installment_key": "3da60b56-17fb-4b32-a1e4-1f0c28d18900",
      "due_date": "2022-07-01",
      "principal_amount": 100,
      "interest_amount": 20,
      "fine_amount": 5,
      "total_amount": 125,
      "present_amount": 100,
      "paid_amount": 80
    }
  ],
  "remaining_installments": [
    {
      "installment_key": "3da60b56-17fb-4b32-a1e4-1f0c28d18903",
      "due_date": "2022-08-01",
      "principal_amount": 100,
      "interest_amount": 20,
      "fine_amount": 5,
      "total_amount": 125
    },
    {
      "installment_key": "3da60b56-17fb-4b32-a1e4-1f0c28d18904",
      "due_date": "2022-09-01",
      "principal_amount": 100,
      "interest_amount": 20,
      "fine_amount": 5,
      "total_amount": 125
    },
    {
      "installment_key": "3da60b56-17fb-4b32-a1e4-1f0c28d18905",
      "due_date": "2022-10-01",
      "principal_amount": 100,
      "interest_amount": 20,
      "fine_amount": 5,
      "total_amount": 125
    }
  ]
}

STATUS

400

Response Body

{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}