Consultar aditamentos da dívida

Devolve os aditamentos de uma dívida (CCB) do originador, paginados, do mais recente ao mais antigo. Use para conferir em que ponto está um aditamento cujo webhook você recebeu, ou para ver o cronograma de parcelas antes e depois do aditamento.

Endpoint

ENDPOINT

/amendment/credit_operation/CREDIT_OPERATION_KEY

MÉTODO

GET

STATUS

200

Este é o único endpoint de aditamento exposto ao originador. A criação do aditamento não é uma chamada sua: a QI Tech a dispara quando o cronograma da dívida é refeito, e você acompanha pelos webhooks e por esta consulta.

Parâmetros de caminho

Campo	Tipo	Obrigatório	Descrição	Tamanho
`credit_operation_key`	`uuid`	Sim	Chave da dívida (CCB) cujos aditamentos você quer consultar.	36

Parâmetros de consulta

Campo	Tipo	Obrigatório	Descrição	Tamanho
`page_number`	`integer`	Não	Número da página, a partir de `1`. Padrão: `1`.	—
`page_rows`	`integer`	Não	Itens por página, de `1` a `100`. Padrão: `25`.	—

Resposta

A consulta só devolve aditamentos de dívidas do seu próprio requerente. Uma dívida de outro requerente e uma dívida sem aditamentos respondem igual: 200 com data vazio.

Campo	Tipo	Obrigatório	Descrição	Tamanho
`data`	`array`	Sim	Os aditamentos da página, do mais recente ao mais antigo.	—
`pagination`	`object`	Sim	Posição da página. Veja a tabela abaixo.	—

Atributos de `pagination`

Campo	Tipo	Obrigatório	Descrição	Tamanho
`current_page`	`integer`	Sim	Página devolvida.	—
`next_page`	`integer`	Sim	Próxima página, quando a página veio cheia. `null` quando veio com menos itens que `page_rows`.	—
`rows_per_page`	`integer`	Sim	Itens por página usados na consulta.	—

informação

Quando a última página vem exatamente cheia, next_page aponta para mais uma página, que responde com data vazio. Pagine até next_page ser null ou até receber uma página vazia.

Atributos de cada item de `data`

Campo	Tipo	Obrigatório	Descrição	Tamanho
`amendment_key`	`uuid`	Sim	Chave do aditamento. É a mesma que chega em `data.amendment_key` nos webhooks.	36
`credit_operation_key`	`uuid`	Sim	Chave da dívida (CCB) aditada.	36
`request_control_key`	`uuid`	Não	Chave de controle do pedido que originou o aditamento. `null` quando o aditamento foi iniciado sem ela.	36
`amendment_status`	`string`	Sim	Status atual. Veja Status do aditamento.	—
`wallet_configuration_key`	`uuid`	Sim	Chave da configuração do cessionário da dívida usada pelo aditamento.	36
`amendment_date`	`string`	Sim	Data do aditamento, no formato `AAAA-MM-DD`.	10
`next_check_datetime`	`string`	Não	Quando a QI Tech tentará de novo avisar o fundo, em ISO 8601. `null` quando não há nova tentativa agendada.	—
`amendment_external_key`	`string`	Não	Chave do aditamento no fundo cessionário. `null` até o fundo reconhecer o aditamento.	—
`amendment_data`	`object`	Sim	O cronograma que foi pedido. Veja Atributos de `amendment_data`.	—
`amended_interest_rate`	`object`	Não	Taxa de juros da dívida antes do aditamento. `null` quando o aditamento não troca a taxa.	—
`new_interest_rate`	`object`	Não	Taxa de juros depois do aditamento. `null` quando o aditamento não troca a taxa.	—
`amended_installments`	`array`	Sim	Parcelas da dívida antes do aditamento. Vazio até o aditamento ser aplicado à dívida.	—
`new_installments`	`array`	Sim	Parcelas da dívida depois do aditamento. Vazio até o aditamento ser aplicado à dívida.	—
`status_events`	`array`	Sim	Histórico de status, do mais antigo ao mais recente.	—

Atributos de `amendment_data`

O que foi pedido, exatamente como chegou. Os valores são números, em reais.

Campo	Tipo	Obrigatório	Descrição	Tamanho
`installments`	`array`	Sim	As parcelas do novo cronograma.	—
`installments[].due_date`	`string`	Sim	Vencimento da parcela, no formato `AAAA-MM-DD`.	10
`installments[].amount`	`number`	Sim	Valor total da parcela, em reais.	—
`installments[].principal_amortization_amount`	`number`	Sim	Parte da parcela que amortiza o principal, em reais.	—
`installments[].prefixed_amount`	`number`	Sim	Parte da parcela que corresponde aos juros pré-fixados, em reais.	—
`installments[].tax_amount`	`number`	Sim	Parte da parcela que corresponde a tributos, em reais.	—
`interest_rate`	`object`	Não	Taxas do aditamento, com `daily_rate`, `monthly_rate` e `annual_rate`. `null` quando a taxa da dívida não muda.	—

Atributos de `amended_interest_rate` e `new_interest_rate`

Os valores vêm como texto, para não perder casas decimais.

Campo	Tipo	Obrigatório	Descrição	Tamanho
`monthly_rate`	`string`	Não	Taxa mensal.	—
`daily_rate`	`string`	Não	Taxa diária.	—
`annual_rate`	`string`	Não	Taxa anual.	—
`interest_base`	`string`	Não	Base de cálculo dos juros: `calendar_days`, `workdays` ou `calendar_days_365`. A base nunca muda com o aditamento.	—

Atributos de `amended_installments` e `new_installments`

Os valores monetários vêm como texto, em reais.

Campo	Tipo	Obrigatório	Descrição	Tamanho
`installment_key`	`uuid`	Sim	Chave da parcela.	36
`installment_number`	`integer`	Sim	Número da parcela na dívida.	—
`installment_status`	`string`	Sim	Status da parcela na dívida, por exemplo `opened` ou `paid_partial`.	—
`due_date`	`string`	Sim	Vencimento, no formato `AAAA-MM-DD`.	10
`business_due_date`	`string`	Não	Vencimento ajustado para dia útil, no formato `AAAA-MM-DD`.	10
`total_amount`	`string`	Sim	Valor total da parcela.	—
`principal_amortization_amount`	`string`	Não	Parte que amortiza o principal.	—
`prefixed_amount`	`string`	Não	Parte que corresponde aos juros pré-fixados.	—
`tax_amount`	`string`	Sim	Parte que corresponde a tributos.	—
`total_paid_amount`	`string`	Não	Quanto já foi pago da parcela.	—

Atributos de `status_events`

Campo	Tipo	Obrigatório	Descrição	Tamanho
`amendment_status`	`string`	Sim	Status em que o aditamento entrou.	—
`event_data`	`object`	Não	Detalhe da transição. Só vem preenchido no status `failed`, com `code` e `description` da recusa do fundo.	—

Status do aditamento

Status	Significado	Dispara webhook
`pending_apply`	Aditamento criado. O novo cronograma ainda não foi aplicado à dívida.	Sim, de aditamento criado
`pending_fund_notification`	O novo cronograma já vale na dívida. Falta avisar o fundo cessionário.	Sim
`in_pending_fund_notification_queue`	O aviso ao fundo está em andamento.	Não
`applied`	O fundo cessionário reconheceu o aditamento. Estado final.	Sim
`failed`	O fundo recusou o aditamento e a recusa não se resolve com nova tentativa. Estado final.	Sim

Exemplo

curl --request GET \
  "/amendment/credit_operation/5ae2c008-44c1-4435-bbfa-094a4b11d962?page_number=1&page_rows=25"

{
    "data": [
        {
            "amendment_key": "c3a7f1d2-6b0e-4e8a-9d41-27b5e0f8a6c4",
            "credit_operation_key": "5ae2c008-44c1-4435-bbfa-094a4b11d962",
            "request_control_key": "9e1b6a47-3c52-4f0d-8a2e-5d7c1b0f4e93",
            "amendment_status": "pending_fund_notification",
            "wallet_configuration_key": "71d0c5b8-2a96-4c3f-b1e7-0a4f9d6e8c25",
            "amendment_date": "2026-11-09",
            "next_check_datetime": null,
            "amendment_external_key": null,
            "amendment_data": {
                "installments": [
                    {
                        "due_date": "2026-12-05",
                        "amount": 498.12,
                        "principal_amortization_amount": 401.37,
                        "prefixed_amount": 96.75,
                        "tax_amount": 0
                    },
                    {
                        "due_date": "2027-01-05",
                        "amount": 498.12,
                        "principal_amortization_amount": 405.9,
                        "prefixed_amount": 92.22,
                        "tax_amount": 0
                    }
                ],
                "interest_rate": {
                    "daily_rate": 0.001142,
                    "monthly_rate": 0.0350,
                    "annual_rate": 0.5114
                }
            },
            "amended_interest_rate": {
                "monthly_rate": "0.0390",
                "daily_rate": "0.001276",
                "annual_rate": "0.5835",
                "interest_base": "workdays"
            },
            "new_interest_rate": {
                "monthly_rate": "0.0350",
                "daily_rate": "0.001142",
                "annual_rate": "0.5114",
                "interest_base": "workdays"
            },
            "amended_installments": [
                {
                    "installment_key": "1f6c2e90-8d34-4b7a-a5c1-3e9b7d0f2a48",
                    "installment_number": 3,
                    "installment_status": "opened",
                    "due_date": "2026-11-05",
                    "business_due_date": "2026-11-05",
                    "total_amount": "512.40",
                    "principal_amortization_amount": "409.10",
                    "prefixed_amount": "103.30",
                    "tax_amount": "0.00",
                    "total_paid_amount": "0.00"
                }
            ],
            "new_installments": [
                {
                    "installment_key": "d84a3b17-5e6f-4c20-9b8d-1a7e0c5f3b62",
                    "installment_number": 3,
                    "installment_status": "opened",
                    "due_date": "2026-12-05",
                    "business_due_date": "2026-12-07",
                    "total_amount": "498.12",
                    "principal_amortization_amount": "401.37",
                    "prefixed_amount": "96.75",
                    "tax_amount": "0.00",
                    "total_paid_amount": "0.00"
                }
            ],
            "status_events": [
                { "amendment_status": "pending_apply", "event_data": null },
                { "amendment_status": "pending_fund_notification", "event_data": null }
            ]
        }
    ],
    "pagination": {
        "current_page": 1,
        "next_page": null,
        "rows_per_page": 25
    }
}

Erros

Status	Código	Quando
`400`	`QIT000400`	`page_number` ou `page_rows` fora do intervalo permitido, ou não inteiro.

Os demais erros (assinatura inválida, endpoint não habilitado para a sua integração) são os da plataforma. Veja o catálogo de erros do LaaS.

Webhooks relacionados

Próximo passo

Webhook de aditamento criado: o primeiro aviso do fluxo, quando o aditamento nasce.

Endpoint​

Parâmetros de caminho​

Parâmetros de consulta​

Resposta​

Atributos de pagination​

Atributos de cada item de data​

Atributos de amendment_data​

Atributos de amended_interest_rate e new_interest_rate​

Atributos de amended_installments e new_installments​

Atributos de status_events​

Status do aditamento​

Exemplo​

Erros​

Webhooks relacionados​

Próximo passo​