Listar renegociações

Request

ENDPOINT

/renegotiation/proposal

MÉTODO

GET

Query Params

Todos os parâmetros são opcionais e podem ser combinados livremente para filtrar a listagem.

Campo	Tipo	Descrição
proposal_status	string (enumerador)	Filtra pelo status da proposta. Ver Enumerador proposal_status.
payment_type	string (enumerador)	Filtra pelo tipo de pagamento da proposta. Ver Enumerador payment_type.
amortization_type	string (enumerador)	Filtra pelo tipo de amortização aplicado à proposta. Ver Enumerador amortization_type.
contract_number	string	Número do contrato original que está sendo renegociado.
issuer_document_number	string	CPF ou CNPJ do tomador (devedor) do contrato original.
issuer_name	string	Nome do tomador do contrato original.
requester_key	string (UUID)	Chave do solicitante (parceiro) que criou a proposta. Quando não informado, é assumido automaticamente a partir do header SELECTED-AGENT.
requester_name	string	Nome do solicitante que criou a proposta.
credit_operation_key	string (UUID)	Chave da operação de crédito original que está sendo renegociada.
payment_amount	string (numérico)	Filtra pelo valor da parcela de pagamento da proposta.
proposal_start_due_date	string (data, yyyy-MM-dd)	Filtra propostas com data de vencimento (proposal_due_date) a partir desta data.
proposal_end_due_date	string (data, yyyy-MM-dd)	Filtra propostas com data de vencimento (proposal_due_date) até esta data.
page	string (numérico)	Número da página. Padrão: 1.
page_size	string (numérico)	Quantidade de registros por página. Padrão: 10. Valores acima de 50 são automaticamente limitados a 50.

Response

STATUS

200

Response Body

{
  "data": [
    {
      "proposal_key": "9f1c2e3a-7b6d-4a1e-8c2f-3d4e5f6a7b8c",
      "proposal_status": "pending_payment",
      "payment_type": "bank_slip",
      "amortization_type": "overdue_installment_payment",
      "contract_number": "0000049047/UO",
      "requester_key": "ba99b7f1-3db6-4a63-a386-ba2c7f31e784",
      "requester_name": "QI Sociedade de Crédito Direto",
      "issuer_name": "Urich Oliveira",
      "issuer_document_number": "37197645832",
      "origin_key": null,
      "payment_amount": 1210.26,
      "discount_amount": 0,
      "discount_percentage": 0,
      "devolution_amount": null,
      "proposal_due_date": "2026-08-15",
      "reference_date": "2026-08-01",
      "request_control_key": null,
      "payment": {
        "digitable_line": "34191790010104351004791020150008196610000121026",
        "qr_code_url": null,
        "qr_code_key": null,
        "bank_slip_key": "4b1c9e3d-2f5a-4c8b-9d6e-7f8a9b0c1d2e",
        "paid_method_type": null,
        "source_account_key": null,
        "payment_data": null
      },
      "affected_installments": [
        {
          "installment_key": "946a99c7-1f9d-429d-8ab9-bf2d0e6c6e48",
          "due_date": "2026-06-15",
          "principal_amount": 168.34,
          "interest_amount": 33.37,
          "fine_amount": 0,
          "total_amount": 201.71,
          "present_amount": 200.00,
          "paid_amount": 201.71,
          "principal_amortization_payment_amount": 168.34,
          "prefixed_interest_payment_amount": 33.37,
          "fine_payment_amount": 0,
          "discount_amount": 0
        }
      ],
      "remaining_installments": [
        {
          "installment_key": "b007376d-c0ce-4e83-a279-4981ab331ccf",
          "due_date": "2026-09-15",
          "principal_amount": 170.02,
          "interest_amount": 31.69,
          "fine_amount": null,
          "total_amount": 201.71
        },
        {
          "installment_key": "c1183e5c-0f8e-4b2a-8e4a-1a2b3c4d5e6f",
          "due_date": "2026-10-15",
          "principal_amount": 171.71,
          "interest_amount": 30.00,
          "fine_amount": null,
          "total_amount": 201.71
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": 2,
    "rows_per_page": 30,
    "total_pages": 5,
    "total_rows": 140
  }
}

Detalhamento dos campos de data[]

Campo	Tipo	Descrição
proposal_key	string (UUID)	Chave única da proposta de renegociação.
proposal_status	string (enumerador)	Status atual da proposta. Ver Enumerador proposal_status.
payment_type	string (enumerador)	Meio de pagamento configurado para a proposta. Ver Enumerador payment_type.
amortization_type	string (enumerador)	Tipo de amortização aplicado na simulação/criação da proposta. Ver Enumerador amortization_type.
contract_number	string	Número do contrato original que está sendo renegociado.
requester_key	string (UUID)	Chave do solicitante (parceiro) que criou a proposta.
requester_name	string	Nome do solicitante que criou a proposta.
issuer_name	string	Nome do tomador (devedor) do contrato original.
issuer_document_number	string	CPF ou CNPJ do tomador.
origin_key	string, opcional	Chave de origem da proposta, quando aplicável.
payment_amount	número	Valor de cada parcela da proposta de renegociação.
discount_amount	número, opcional	Valor de desconto aplicado sobre o saldo devedor.
discount_percentage	número, opcional	Percentual de desconto aplicado sobre o saldo devedor.
devolution_amount	número, opcional	Valor a ser devolvido ao tomador, quando aplicável.
proposal_due_date	string (data)	Data de vencimento da proposta.
reference_date	string (data)	Data de referência utilizada no cálculo da proposta.
request_control_key	string, opcional	Chave de controle da requisição que originou a proposta, quando informada na criação.
include_matured_installment	booleano, opcional	Indica se parcelas vencidas foram incluídas na renegociação. Só aparece na resposta quando não for nulo.
force_due_date	booleano, opcional	Indica se a data de vencimento informada foi forçada, ignorando a data sugerida pelo cálculo. Só aparece na resposta quando não for nulo.
issue_amount	número, opcional	Valor de emissão, presente apenas para tipos de amortização que permitem desembolso (ex.: equal_amount, present_amount). Só aparece na resposta quando não for nulo.
disbursement_issue_amount	número, opcional	Valor de emissão a ser desembolsado ao tomador. Só aparece na resposta quando não for nulo.
total_iof	número, opcional	Valor total de IOF da operação, quando houver desembolso. Só aparece na resposta quando não for nulo.
remaining_principal_disbursement_amount	número, opcional	Saldo de principal a ser desembolsado nas parcelas remanescentes. Só aparece na resposta quando não for nulo.
remaining_principal_iof_amount	número, opcional	Saldo de IOF nas parcelas remanescentes. Só aparece na resposta quando não for nulo.
payment	objeto	Dados do meio de pagamento gerado para a proposta. Ver Objeto payment.
affected_installments	lista de objetos, opcional	Parcelas do contrato original afetadas/liquidadas por esta proposta. Ver Objeto affected_installments.
remaining_installments	lista de objetos	Novas parcelas geradas pela renegociação, ainda a vencer. Ver Objeto remaining_installments.

Objeto payment

Campo	Tipo	Descrição
digitable_line	string, opcional	Linha digitável do boleto, quando payment_type for bank_slip.
qr_code_url	string, opcional	URL do QR Code Pix, quando payment_type for pix.
qr_code_key	string, opcional	Chave do QR Code Pix gerado.
bank_slip_key	string, opcional	Chave do boleto gerado.
paid_method_type	string (enumerador), opcional	Meio efetivamente utilizado no pagamento, preenchido somente após o pagamento ser realizado. Ver Enumerador paid_method_type.
source_account_key	string, opcional	Chave da conta de origem do pagamento, quando aplicável.
payment_data	objeto, opcional	Dados adicionais do pagamento, conforme o meio utilizado.

Objeto affected_installments[]

Cada item representa uma parcela do contrato original consumida por esta proposta.

Campo	Tipo	Descrição
installment_key	string (UUID)	Chave da parcela do contrato original.
due_date	string (data)	Data de vencimento original da parcela.
principal_amount	número	Valor de principal da parcela.
interest_amount	número	Valor de juros da parcela.
fine_amount	número, opcional	Valor de multa da parcela.
total_amount	número	Valor total da parcela (principal + juros + multa).
present_amount	número	Valor presente da parcela na data de referência da proposta.
paid_amount	número	Valor efetivamente considerado como pago/liquidado desta parcela pela proposta.
principal_amortization_payment_amount	número, opcional	Parcela do pagamento amortizada como principal.
prefixed_interest_payment_amount	número, opcional	Parcela do pagamento amortizada como juros pré-fixados.
fine_payment_amount	número, opcional	Parcela do pagamento amortizada como multa.
discount_amount	número, opcional	Valor de desconto aplicado a esta parcela.
paid_principal_disbursement	número, opcional	Valor de principal desembolsado referente a esta parcela. Só aparece na resposta quando não for nulo.
paid_principal_iof	número, opcional	Valor de IOF desembolsado referente a esta parcela. Só aparece na resposta quando não for nulo.
discount_principal_disbursement	número, opcional	Desconto aplicado sobre o principal desembolsado. Só aparece na resposta quando não for nulo.
discount_principal_iof	número, opcional	Desconto aplicado sobre o IOF desembolsado. Só aparece na resposta quando não for nulo.
discount_fine_amount	número, opcional	Desconto aplicado sobre a multa. Só aparece na resposta quando não for nulo.
discount_prefixed_interest_amount	número, opcional	Desconto aplicado sobre os juros pré-fixados. Só aparece na resposta quando não for nulo.
discount_principal_amortization_amount	número, opcional	Desconto aplicado sobre a amortização de principal. Só aparece na resposta quando não for nulo.

Objeto remaining_installments[]

Cada item representa uma nova parcela, ainda a vencer, gerada pela renegociação.

Campo	Tipo	Descrição
installment_key	string (UUID)	Chave da nova parcela.
due_date	string (data)	Data de vencimento da nova parcela.
principal_amount	número	Valor de principal da parcela.
interest_amount	número	Valor de juros da parcela.
fine_amount	número, opcional	Valor de multa da parcela.
total_amount	número	Valor total da parcela (principal + juros + multa).
principal_disbursement_amount	número, opcional	Valor de principal a ser desembolsado referente a esta parcela, quando o tipo de amortização permitir desembolso. Só aparece na resposta quando não for nulo.
principal_iof_amount	número, opcional	Valor de IOF referente ao desembolso desta parcela. Só aparece na resposta quando não for nulo.

Enumeradores

Enumerador proposal_status

Valor	Descrição
pending_payment	Proposta criada, aguardando pagamento.
processing_payment	Pagamento identificado e em processamento.
paid	Proposta paga/liquidada com sucesso.
canceled	Proposta cancelada.
rejected	Proposta rejeitada.
awaiting_disbursement	Proposta paga e aguardando o desembolso do valor ao tomador.
partially_settled	Proposta parcialmente liquidada.

Enumerador payment_type

Valor	Descrição
manual	Pagamento controlado manualmente, sem geração de meio de pagamento pela QI Tech.
bank_slip	Pagamento via boleto bancário.
pix	Pagamento via Pix.
internal	Pagamento processado internamente, sem geração de boleto ou Pix.

Enumerador paid_method_type

Valor	Descrição
bank_slip	Pagamento identificado via boleto bancário.
pix	Pagamento identificado via Pix.
integrated_payment	Pagamento identificado via integração de pagamento (ex.: desconto em folha/conta).
manual	Pagamento registrado manualmente.
internal	Pagamento processado internamente.

Enumerador amortization_type

Valor	Descrição
installment_payment	Pagamento de parcela(s) específica(s).
first_installments	Amortização das primeiras parcelas do contrato.
last_installments	Amortização das últimas parcelas do contrato.
overdue_installment_payment	Pagamento de parcela(s) em atraso.
overdue_and_maturing_payment	Pagamento de parcelas em atraso e a vencer.
full_settle	Liquidação total do contrato.
equal_amount	Renegociação com parcelas de valor igual, com possibilidade de desembolso.
present_amount	Renegociação a valor presente, com possibilidade de desembolso.

Paginação

pagination.next_page retorna null quando a página atual já é a última.

STATUS

400

Response Body

{
  "title": "Bad Request",
  "description": "1 validation error for GetParamsEntity\nproposal_status\n  value is not a valid enumeration member; permitted: 'pending_payment', 'processing_payment', 'paid', 'canceled', 'rejected', 'awaiting_disbursement', 'partially_settled' (type=type_error.enum; enum_values=[<ProposalStatusEnum.pending_payment: 'pending_payment'>, <ProposalStatusEnum.processing_payment: 'processing_payment'>, <ProposalStatusEnum.paid: 'paid'>, <ProposalStatusEnum.canceled: 'canceled'>, <ProposalStatusEnum.rejected: 'rejected'>, <ProposalStatusEnum.awaiting_disbursement: 'awaiting_disbursement'>, <ProposalStatusEnum.partially_settled: 'partially_settled'>])",
  "translation": "Payload Inválido",
  "code": "QIT000001"
}