Alter the mutable terms of an averbado contract

Proxies alterar-consignado-trabalhador (Manual 003 §3.2): instalment count, instalment amount, worker name, and optionally the first deduction competência. Same tenant-ownership proof and idempotency requirement as suspend. Money is a decimal string, never a float.

PATCH /v1/consignado/contracts/{numero_contrato}/terms

Alter the mutable terms of an averbado contract

cURL

curl --request PATCH \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/terms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "codigoInscricaoEmpregador": "1",
  "cpf": "99999999999",
  "matricula": "99999999999-A",
  "nomeTrabalhador": "Trabalhador 99999999999",
  "numeroInscricaoEmpregador": "42422253000101",
  "numeroParcelas": 11,
  "valorParcela": "444.96",
  "competenciaInicioDesconto": "202608"
}
'

200

{
  "hashOperacao": "33908101"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency · string · requerido

Client-chosen idempotency key. REQUIRED: an absent key is 422, never a generated default.

Maximum string length: 255

Ejemplo:

"idem-terms-2026-07-30-0001"

Parámetros de ruta

numero_contrato · string · requerido

Rail contract number of a contract this gateway holds for the authenticated tenant.

Required string length: 1 - 15

Ejemplo:

"99999999999AN1"

Cuerpo

application/json

codigoInscricaoEmpregador · enum<string> · requerido

Employer inscription type: 1 = CNPJ, 2 = CPF.

Opciones disponibles: 1, 2

Ejemplo:

"1"

cpf · string · requerido

Worker CPF, exactly 11 digits. In the BODY, never a path or query parameter.

Pattern: ^[0-9]{11}$

Ejemplo:

"99999999999"

matricula · string · requerido

Minimum string length: 1

Ejemplo:

"99999999999-A"

nomeTrabalhador · string · requerido

Minimum string length: 1

Ejemplo:

"Trabalhador 99999999999"

numeroInscricaoEmpregador · string · requerido

Minimum string length: 1

Ejemplo:

"42422253000101"

numeroParcelas · integer<int64> · requerido

Number of instalments.

Rango requerido: 1 <= x <= 999

Ejemplo:

11

valorParcela · string · requerido

Instalment amount (decimal string, BRL, at most 2 decimals). A decimal string end to end — a money field never becomes a binary float on the way to the rail.

Pattern: ^[0-9]+(\.[0-9]{1,2})?$

Ejemplo:

"444.96"

competenciaInicioDesconto · string

First deduction competência, yyyyMM. Obrigatório=Não at the rail: omitted, the rail fills it automatically. Relayed verbatim — sending an empty string would be an invalid value rather than an absence, so an omitted field is dropped from the wire.

Ejemplo:

"202608"

Respuesta

200

application/json

OK

hashOperacao · string

The rail's own operation identity, surfaced as its exact decimal digits (the rail types it Numérico). Manual 003 publishes no response table for these operations, so it MAY be absent on a 2xx — a 2xx is itself the success signal, do not branch on this field being present.

Ejemplo:

"33908101"