Criar uma renegociação

Request

ENDPOINT

/renegotiation/proposal

MÉTODO

POST

Request Body

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

Body Params

Campo	Tipo	Descrição	Caracteres
contract_number	string	Numero do contrato.	10
amortization_type	string	Tipo de amortização.	Enumeradores
reference_date	string	Data de referencia da renegociação.	10
proposal_due_date	string	Data de vencimento da proposta.	10
discount_percentage	string	Percentual de desconto.	10
payment_type	string	Tipo de pagamento.	Enumeradores
installments	array of objects	Parcelas renegociadas.	Installments Object

Installments Object

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

Enumeradores amortization_type

Campo	Descrição
installment_payment	Pagamento de parcelas

Enumeradores payment_type

Campo	Descrição
banklisp	Pagamento via boleto bancário
manual	Pagamento feito de forma manual
pix	Pagamento via pix

Response

STATUS

200

Response Body

{
  "proposal_key": "bcc16a6d-ce21-4cd4-8d8c-d26f89ccc685",
  "contract_number": "ABCD/1",
  "proposal_status": "pending_payment",
  "amortization_type": "installment_payment",
  "discount_percentage": 0.2,
  "payment_amount": 240,
  "requester_name": "Requester",
  "requester_key": "bcc16a6d-ce21-4cd4-8d8c-d26f89ccc685",
  "issuer_name": "issuer",
  "reference_date": "2022-07-20",
  "proposal_due_date": "2022-07-20",
  "issuer_document_number": "98765432100",
  "payment_type": "bank_slip",
  "payment": {
    "digitable_line": "",
    "qr_code_url": {},
    "qr_code_key": "",
    "bank_slip_key": "",
    "paid_method_type": null
  },
  "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\"}"
}