Webhook de alteração de condições do contrato

Quando ocorre uma alteração das condições da consignação, como o valor da parcela ou o número de parcelas, a QI Tech envia este webhook ao parceiro com o resultado da alteração.

WEBHOOK_TYPE

laas.private_payroll.modify_contract_conditions

Quando o webhook é enviado

O webhook é enviado quando a alteração chega a um resultado final:

Status	Quando	contract_conditions
executed	A alteração foi aplicada ao contrato. Os novos valores já estão na averbação.	Preenchido
canceled	A alteração foi cancelada antes de ser aplicada. O contrato não mudou.	null

Não há webhook enquanto a alteração está em andamento.

Corpo do webhook

Campo	Tipo	Obrigatório	Descrição	Tamanho
webhook_type	string	Sim	Sempre laas.private_payroll.modify_contract_conditions.	—
key	uuid	Sim	Chave operação de crédito (credit_operation_key).	36
status	string	Sim	Resultado da alteração: executed ou canceled. Veja Quando o webhook é enviado.	—
event_datetime	string	Sim	Data e hora do envio, em UTC, no formato AAAA-MM-DDTHH:MM:SSZ.	20
data	object	Sim	Dados da alteração. Veja a tabela abaixo.	—

Atributos de data

Campo	Tipo	Obrigatório	Descrição
reservation_action_key	uuid	Sim	Chave que identifica esta alteração.
reservation_key	uuid	Sim	Chave da averbação.
external_key	uuid	Sim	Chave operação de crédito (credit_operation_key).
contract_number	string	Não	Número do contrato na DATAPREV.
reason	string	Não	Motivo do resultado. Hoje vem null nos dois status.
requested	object	Sim	O que foi pedido: period_amount e number_of_periods. O campo que não foi pedido vem null.
contract_conditions	object	Não	Condições do contrato depois da alteração. Só vem em executed; em canceled é null.

Atributos de contract_conditions

Campo	Tipo	Descrição
number_of_periods	integer	Número de parcelas do contrato depois da alteração.
period_amount	number	Valor da parcela depois da alteração.
start_competence	string	Primeira competência do contrato alterado.
end_competence	string	Última competência do contrato alterado.
expiration_date	string	Data de expiração, no formato AAAA-MM-DD, ou null se não houver.

Exemplos

Alteração aplicada

{
    "webhook_type": "laas.private_payroll.modify_contract_conditions",
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "status": "executed",
    "event_datetime": "2026-10-30T14:12:45Z",
    "data": {
        "reservation_action_key": "5c1d7e2a-8b34-4f6e-9a10-3d2b7c9e4f18",
        "reservation_key": "9b2f6c1e-4d3a-4f8b-a1c7-2e5d8f0b3a64",
        "external_key": "123e4567-e89b-12d3-a456-426614174000",
        "contract_number": "2024001234",
        "reason": null,
        "requested": {
            "period_amount": 250.0,
            "number_of_periods": 36
        },
        "contract_conditions": {
            "number_of_periods": 36,
            "period_amount": 250.0,
            "start_competence": "2026-11",
            "end_competence": "2029-10",
            "expiration_date": null
        }
    }
}

Alteração cancelada

{
    "webhook_type": "laas.private_payroll.modify_contract_conditions",
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "status": "canceled",
    "event_datetime": "2026-10-30T14:20:03Z",
    "data": {
        "reservation_action_key": "5c1d7e2a-8b34-4f6e-9a10-3d2b7c9e4f18",
        "reservation_key": "9b2f6c1e-4d3a-4f8b-a1c7-2e5d8f0b3a64",
        "external_key": "123e4567-e89b-12d3-a456-426614174000",
        "contract_number": "2024001234",
        "reason": null,
        "requested": {
            "period_amount": 250.0,
            "number_of_periods": null
        },
        "contract_conditions": null
    }
}

Próximo passo

• Consulta de Reservas: a averbação já aparece com as novas condições.
• Migração Automática de Contrato: o outro webhook que altera a averbação sem ação do parceiro.