Skip to main content
PATCH
Alterar os termos mutáveis ​​de um contrato averbado

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

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

Exemplo:

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

Parâmetros de caminho

numero_contrato
string
obrigatório

Rail contract number of an averbação belonging to the authenticated tenant.

Required string length: 1 - 15
Exemplo:

"99999999999AN1"

Corpo

application/json
codigoInscricaoEmpregador
enum<string>
obrigatório

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

Opções disponíveis:
1,
2
Exemplo:

"1"

cpf
string
obrigatório

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

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

"99999999999"

matricula
string
obrigatório
Minimum string length: 1
Exemplo:

"99999999999-A"

nomeTrabalhador
string
obrigatório
Minimum string length: 1
Exemplo:

"Trabalhador 99999999999"

numeroInscricaoEmpregador
string
obrigatório
Minimum string length: 1
Exemplo:

"42422253000101"

numeroParcelas
integer<int64>
obrigatório

Number of instalments.

Intervalo obrigatório: x >= 1
Exemplo:

11

valorParcela
string
obrigatório

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})?$
Exemplo:

"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.

Exemplo:

"202608"

Resposta

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.

Exemplo:

"33908101"