Alterar los términos mutables de un contrato averbado

curl --request PATCH \
  --url https://consignado.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"
}
'

import requests

url = "https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/terms"

payload = {
    "codigoInscricaoEmpregador": "1",
    "cpf": "99999999999",
    "matricula": "99999999999-A",
    "nomeTrabalhador": "Trabalhador 99999999999",
    "numeroInscricaoEmpregador": "42422253000101",
    "numeroParcelas": 11,
    "valorParcela": "444.96",
    "competenciaInicioDesconto": "202608"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    codigoInscricaoEmpregador: '1',
    cpf: '99999999999',
    matricula: '99999999999-A',
    nomeTrabalhador: 'Trabalhador 99999999999',
    numeroInscricaoEmpregador: '42422253000101',
    numeroParcelas: 11,
    valorParcela: '444.96',
    competenciaInicioDesconto: '202608'
  })
};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/terms', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/terms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'codigoInscricaoEmpregador' => '1',
    'cpf' => '99999999999',
    'matricula' => '99999999999-A',
    'nomeTrabalhador' => 'Trabalhador 99999999999',
    'numeroInscricaoEmpregador' => '42422253000101',
    'numeroParcelas' => 11,
    'valorParcela' => '444.96',
    'competenciaInicioDesconto' => '202608'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Idempotency: <x-idempotency>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/terms"

	payload := strings.NewReader("{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"nomeTrabalhador\": \"Trabalhador 99999999999\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\",\n  \"numeroParcelas\": 11,\n  \"valorParcela\": \"444.96\",\n  \"competenciaInicioDesconto\": \"202608\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/terms")
  .header("X-Idempotency", "<x-idempotency>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"nomeTrabalhador\": \"Trabalhador 99999999999\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\",\n  \"numeroParcelas\": 11,\n  \"valorParcela\": \"444.96\",\n  \"competenciaInicioDesconto\": \"202608\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/terms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-Idempotency"] = '<x-idempotency>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"nomeTrabalhador\": \"Trabalhador 99999999999\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\",\n  \"numeroParcelas\": 11,\n  \"valorParcela\": \"444.96\",\n  \"competenciaInicioDesconto\": \"202608\"\n}"

response = http.request(request)
puts response.read_body

{
  "hashOperacao": "33908101"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Alterar los términos mutables de un contrato averbado

Esta operación actúa como proxy de alterar-consignado-trabalhador (Manual 003 §3.2): recuento de cuotas, monto de la cuota, nombre del trabajador y, opcionalmente, la primera competencia de deducción. Se aplican la misma prueba de titularidad del tenant y el mismo requisito de idempotencia que en suspend. El dinero es una cadena decimal, nunca un flotante.

PATCH

consignado

contracts

{numero_contrato}

terms

Alterar los términos mutables de un contrato averbado

curl --request PATCH \
  --url https://consignado.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"
}
'

import requests

url = "https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/terms"

payload = {
    "codigoInscricaoEmpregador": "1",
    "cpf": "99999999999",
    "matricula": "99999999999-A",
    "nomeTrabalhador": "Trabalhador 99999999999",
    "numeroInscricaoEmpregador": "42422253000101",
    "numeroParcelas": 11,
    "valorParcela": "444.96",
    "competenciaInicioDesconto": "202608"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    codigoInscricaoEmpregador: '1',
    cpf: '99999999999',
    matricula: '99999999999-A',
    nomeTrabalhador: 'Trabalhador 99999999999',
    numeroInscricaoEmpregador: '42422253000101',
    numeroParcelas: 11,
    valorParcela: '444.96',
    competenciaInicioDesconto: '202608'
  })
};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/terms', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/terms",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'codigoInscricaoEmpregador' => '1',
    'cpf' => '99999999999',
    'matricula' => '99999999999-A',
    'nomeTrabalhador' => 'Trabalhador 99999999999',
    'numeroInscricaoEmpregador' => '42422253000101',
    'numeroParcelas' => 11,
    'valorParcela' => '444.96',
    'competenciaInicioDesconto' => '202608'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Idempotency: <x-idempotency>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/terms"

	payload := strings.NewReader("{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"nomeTrabalhador\": \"Trabalhador 99999999999\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\",\n  \"numeroParcelas\": 11,\n  \"valorParcela\": \"444.96\",\n  \"competenciaInicioDesconto\": \"202608\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/terms")
  .header("X-Idempotency", "<x-idempotency>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"nomeTrabalhador\": \"Trabalhador 99999999999\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\",\n  \"numeroParcelas\": 11,\n  \"valorParcela\": \"444.96\",\n  \"competenciaInicioDesconto\": \"202608\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/terms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-Idempotency"] = '<x-idempotency>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"nomeTrabalhador\": \"Trabalhador 99999999999\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\",\n  \"numeroParcelas\": 11,\n  \"valorParcela\": \"444.96\",\n  \"competenciaInicioDesconto\": \"202608\"\n}"

response = http.request(request)
puts response.read_body

{
  "hashOperacao": "33908101"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

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.

Ejemplo:

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

Parámetros de ruta

numero_contrato

string

requerido

Rail contract number of an averbação belonging to 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: x >= 1

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

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"

⌘I

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado — Dataprev

Alterar los términos mutables de un contrato averbado

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta