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": "AVERBACAO_ARTIFACT_CONFLICT",
"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": "AVERBACAO_ARTIFACT_CONFLICT",
"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": "AVERBACAO_ARTIFACT_CONFLICT",
"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": "AVERBACAO_ARTIFACT_CONFLICT",
"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"
}
}Withdraw a competência's early-payment suspension
Proxies excluir-antecipar-parcela (Manual 013 v1.3 §2.2), returning the contract to its normal discount schedule for the named competência. Same tenant-ownership proof and idempotency requirement as incluir.
PUT
/
v1
/
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": "AVERBACAO_ARTIFACT_CONFLICT",
"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": "AVERBACAO_ARTIFACT_CONFLICT",
"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": "AVERBACAO_ARTIFACT_CONFLICT",
"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": "AVERBACAO_ARTIFACT_CONFLICT",
"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"
}
}Autorizações
JWT bearer token issued by the identity provider.
Cabeçalhos
Client-chosen idempotency key. REQUIRED: an absent key is 422, never a generated default.
Exemplo:
"idem-antecipacao-excluir-0001"
Parâmetros de caminho
Rail contract number of an averbação belonging to the authenticated tenant.
Required string length:
2 - 15Exemplo:
"1997123478"
The suspended competência to withdraw, yyyyMM.
Pattern:
^[0-9]{6}$Exemplo:
"202611"
Esta página foi útil?

