Preview a consignado compensating adjustment

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/internal/br/consignado/compensating-adjustments/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "adjustmentAmount": "<string>",
  "currency": "<string>",
  "justification": "<string>",
  "numeroContrato": "<string>",
  "correctionEventId": "<string>",
  "debtAmountAfter": "<string>",
  "debtAmountBefore": "<string>",
  "divergenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/internal/br/consignado/compensating-adjustments/preview"

	payload := strings.NewReader("{\n  \"adjustmentAmount\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"justification\": \"<string>\",\n  \"numeroContrato\": \"<string>\",\n  \"correctionEventId\": \"<string>\",\n  \"debtAmountAfter\": \"<string>\",\n  \"debtAmountBefore\": \"<string>\",\n  \"divergenceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

	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))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    adjustmentAmount: '<string>',
    currency: '<string>',
    justification: '<string>',
    numeroContrato: '<string>',
    correctionEventId: '<string>',
    debtAmountAfter: '<string>',
    debtAmountBefore: '<string>',
    divergenceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://lender.sandbox.lerian.net/api/v1/internal/br/consignado/compensating-adjustments/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://lender.sandbox.lerian.net/api/v1/internal/br/consignado/compensating-adjustments/preview"

payload = {
    "adjustmentAmount": "<string>",
    "currency": "<string>",
    "justification": "<string>",
    "numeroContrato": "<string>",
    "correctionEventId": "<string>",
    "debtAmountAfter": "<string>",
    "debtAmountBefore": "<string>",
    "divergenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "adjustmentAmount": "<string>",
  "currency": "<string>",
  "numeroContrato": "<string>",
  "reason": "<string>",
  "creditRole": "<string>",
  "debitRole": "<string>",
  "debtAmountAfter": "<string>",
  "debtAmountBefore": "<string>",
  "principalSide": "<string>",
  "suspenseSide": "<string>"
}

{
  "code": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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"
  }
}

POST

api

internal

consignado

compensating-adjustments

preview

Preview a consignado compensating adjustment

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/internal/br/consignado/compensating-adjustments/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "adjustmentAmount": "<string>",
  "currency": "<string>",
  "justification": "<string>",
  "numeroContrato": "<string>",
  "correctionEventId": "<string>",
  "debtAmountAfter": "<string>",
  "debtAmountBefore": "<string>",
  "divergenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/internal/br/consignado/compensating-adjustments/preview"

	payload := strings.NewReader("{\n  \"adjustmentAmount\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"justification\": \"<string>\",\n  \"numeroContrato\": \"<string>\",\n  \"correctionEventId\": \"<string>\",\n  \"debtAmountAfter\": \"<string>\",\n  \"debtAmountBefore\": \"<string>\",\n  \"divergenceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

	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))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    adjustmentAmount: '<string>',
    currency: '<string>',
    justification: '<string>',
    numeroContrato: '<string>',
    correctionEventId: '<string>',
    debtAmountAfter: '<string>',
    debtAmountBefore: '<string>',
    divergenceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://lender.sandbox.lerian.net/api/v1/internal/br/consignado/compensating-adjustments/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://lender.sandbox.lerian.net/api/v1/internal/br/consignado/compensating-adjustments/preview"

payload = {
    "adjustmentAmount": "<string>",
    "currency": "<string>",
    "justification": "<string>",
    "numeroContrato": "<string>",
    "correctionEventId": "<string>",
    "debtAmountAfter": "<string>",
    "debtAmountBefore": "<string>",
    "divergenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "adjustmentAmount": "<string>",
  "currency": "<string>",
  "numeroContrato": "<string>",
  "reason": "<string>",
  "creditRole": "<string>",
  "debitRole": "<string>",
  "debtAmountAfter": "<string>",
  "debtAmountBefore": "<string>",
  "principalSide": "<string>",
  "suspenseSide": "<string>"
}

{
  "code": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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.

Cuerpo

application/json

adjustmentAmount

string

requerido

Signed compensating entry magnitude, exact two-decimal string. Sign convention: payment_shortfall must be negative, payment_excess and every disbursement_* reason must be positive.

currency

string

requerido

ISO-4217 currency code.

Required string length: 3

justification

string

requerido

Operator's structured justification.

Required string length: 1 - 4000

numeroContrato

string

requerido

Canonical rail contract number.

Required string length: 2 - 15

reason

enum<string>

requerido

Closed reason catalog; no free-form 'other'. A disbursement_* or refinance_payoff_* reason clears a disbursement in parts or a refinance payoff: it names the divergence and moves exactly its open amount. refinance_payoff_short_settled_residual only records, on a refinance_payoff_vs_rail item, that part of the shortfall (any amount up to the item's openShortfall and residualAvailable) is the CCB residual of the same contract: it posts nothing.

Opciones disponibles:

payment_shortfall,

payment_excess,

immutable_client_correction,

internal_ccb_residual,

disbursement_excess_recovered,

disbursement_excess_loss,

disbursement_remainder_paid_off_rail,

disbursement_remainder_cancelled,

refinance_payoff_short_recovered,

refinance_payoff_short_loss,

refinance_payoff_excess_refunded,

refinance_payoff_short_settled_residual

correctionEventId

string

Landed correction event this adjustment resolves. At most one of divergenceId/correctionEventId may be set.

Maximum string length: 255

debtAmountAfter

string

CCB debt after this adjustment. Both-or-neither with debtAmountBefore.

debtAmountBefore

string

CCB debt before this adjustment. Both-or-neither with debtAmountAfter.

divergenceId

string<uuid>

Divergence this adjustment resolves. At most one of divergenceId/correctionEventId may be set.

Respuesta

adjustmentAmount

string

requerido

Normalized signed amount, exact two-decimal string.

currency

string

requerido

ISO-4217 currency code.

numeroContrato

string

requerido

Canonical rail contract number.

reason

string

requerido

Closed reason catalog.

creditRole

string

above|cash|suspense: the account a disbursement_* reason credits.

debitRole

string

cash|loss|below: the account a disbursement_* reason debits.

debtAmountAfter

string

CCB debt after, when this adjustment changes the debt.

debtAmountBefore

string

CCB debt before, when this adjustment changes the debt.

principalSide

string

debit|credit: the direction the eventual posting intent moves the contract's principal (receivable) account. Always opposite suspenseSide. Absent for a disbursement_* reason.

suspenseSide

string

debit|credit: the direction the eventual posting intent moves the tenant's suspense account. Absent for a disbursement_* reason.

Productos de préstamo de Brasil

Operaciones de consignado

Ciclo de vida del producto

Versiones del producto

Configuración del producto

Tablas de tasa flotante

Plantillas de documento

Solicitudes de Préstamo

Garantías

Instrumentos de crédito

Divulgaciones regulatorias y riesgo

Liquidación y prepago

Bajas contables y recuperación de crédito

Resumen y auditoría de cuenta

Cargos y calendario

Pagos

Transacciones

Cuentas por cobrar de pago devuelto

Fondos de cesión

Lotes de cesión

Excepciones y dossiers de la cesión

Contabilidad

Paneles de cartera

Jurisdicciones

Impuestos

Acceso de socios

Sesión

Fecha de negocio

Streaming

Manejo de errores

Eventos

Preview a consignado compensating adjustment

Autorizaciones

Cuerpo

Respuesta