Withdraw a competência's early-payment suspension

curl --request PUT \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/antecipacao/{competencia} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Idempotency: <x-idempotency>'

package main

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

func main() {

	url := "https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/antecipacao/{competencia}"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'PUT',
  headers: {'X-Idempotency': '<x-idempotency>', Authorization: 'Bearer <token>'}
};

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

import requests

url = "https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/antecipacao/{competencia}"

headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>"
}

response = requests.put(url, headers=headers)

print(response.text)

{
  "contrato": "1997123478",
  "mensagem": "Antecipacao de parcela realizada com sucesso"
}

{
  "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"
  }
}

{
  "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"
  }
}

PUT

consignado

contracts

{numero_contrato}

antecipacao

{competencia}

Withdraw a competência's early-payment suspension

curl --request PUT \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/antecipacao/{competencia} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Idempotency: <x-idempotency>'

package main

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

func main() {

	url := "https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/antecipacao/{competencia}"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'PUT',
  headers: {'X-Idempotency': '<x-idempotency>', Authorization: 'Bearer <token>'}
};

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

import requests

url = "https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/antecipacao/{competencia}"

headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>"
}

response = requests.put(url, headers=headers)

print(response.text)

{
  "contrato": "1997123478",
  "mensagem": "Antecipacao de parcela realizada com sucesso"
}

{
  "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"
  }
}

{
  "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-antecipacao-excluir-0001"

Parámetros de ruta

numero_contrato

string

requerido

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

Required string length: 2 - 15

Ejemplo:

"1997123478"

competencia

string

requerido

The suspended competência to withdraw, yyyyMM.

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

Ejemplo:

"202611"

Respuesta

contrato

string

requerido

The contract number the rail confirmed the operation against.

Ejemplo:

"1997123478"

mensagem

string

requerido

The rail's own message.

Ejemplo:

"Antecipacao de parcela realizada com sucesso"

Configuración del tenant y credenciales

Datos del trabajador y margen

Subastas y propuestas

Registro y documentos del contrato

Correcciones del contrato

Ciclo de vida del contrato

Refinanciación, renegociación y portabilidad

Contratos legados

Garantías del FGTS

Conciliación y calendario

Fondos y cesiones

Capacidad y uso

Monitoreo

Suscripciones de eventos

Manejo de errores

Eventos

Withdraw a competência's early-payment suspension

Autorizaciones

Encabezados

Parámetros de ruta

Respuesta