Write a contract off as a credit loss

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/write-offs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Uncollectable after 360 days in arrears"
}
'

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/write-offs"

	payload := strings.NewReader("{\n  \"reason\": \"Uncollectable after 360 days in arrears\"\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({reason: 'Uncollectable after 360 days in arrears'})
};

fetch('https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/write-offs', 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/br/loan-accounts/{id}/write-offs"

payload = { "reason": "Uncollectable after 360 days in arrears" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "additionalLoss": "3850.00",
  "carryingAmount": "9850.00",
  "currency": "BRL",
  "debtAtWriteOff": "11600.00",
  "heldCashApplied": "150.00",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "loanAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provisionConsumed": "6000.00",
  "provisionReleased": "0.00",
  "reason": "<string>",
  "recordedBy": "<string>",
  "requestId": "<string>",
  "withheldDerecognized": "1600.00",
  "writtenOffAt": "2023-11-07T05:31:56Z"
}

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

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

Write a contract off as a credit loss

Writes a direct-credit contract off as a credit loss (Res. CMN 4.966 art. 49) in one transaction. The held cash first pays the debt as a receipt; the entry then clears the contract’s book as the ledger holds it against rendas a apropriar for the withheld interest and the provision allowance B, booking W - B to provision expense or B - W to provision reversal, and the contract leaves the book as written off. The write-off is irreversible: money recovered later is a recovery, recorded at POST /api/v1/br/loan-accounts//credit-loss-recoveries. A contract with nothing to write off is refused (LENDER-0969): when the held cash pays all a receipt reaches and some is left, run the full payoff, which discounts it; when the book carries no loss, the detail names the deferred fee or adjustment to wait out when amortizing it would leave a loss. A consignado contract is refused. The write-off is keyed on X-Idempotency alone; redelivering the same key with the same reason replays the write-off and moves nothing; the same key with another reason is refused.

POST

api

loan-accounts

{id}

write-offs

Write a contract off as a credit loss

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/write-offs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Uncollectable after 360 days in arrears"
}
'

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/write-offs"

	payload := strings.NewReader("{\n  \"reason\": \"Uncollectable after 360 days in arrears\"\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({reason: 'Uncollectable after 360 days in arrears'})
};

fetch('https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/write-offs', 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/br/loan-accounts/{id}/write-offs"

payload = { "reason": "Uncollectable after 360 days in arrears" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "additionalLoss": "3850.00",
  "carryingAmount": "9850.00",
  "currency": "BRL",
  "debtAtWriteOff": "11600.00",
  "heldCashApplied": "150.00",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "loanAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provisionConsumed": "6000.00",
  "provisionReleased": "0.00",
  "reason": "<string>",
  "recordedBy": "<string>",
  "requestId": "<string>",
  "withheldDerecognized": "1600.00",
  "writtenOffAt": "2023-11-07T05:31:56Z"
}

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

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

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency

string

Idempotency key of the write-off: 1 to 255 bytes of UTF-8. The route refuses a request without it, or with a blank, longer or non-UTF-8 one (LENDER-0965). X-Request-ID is never read as the key.

Parâmetros de caminho

string<uuid>

obrigatório

Direct-credit loan account to write off.

Corpo

application/json

reason

string

obrigatório

Why the contract is written off: 1 to 500 characters, edge spaces trimmed. A repeat of the same X-Idempotency key must carry the same reason.

Exemplo:

"Uncollectable after 360 days in arrears"

Resposta

Created

additionalLoss

string

obrigatório

Loss above the allowance booked to provision expense: W - B when positive (2 d.p. string).

Exemplo:

"3850.00"

carryingAmount

string

obrigatório

Carrying amount written off (W): the book net of the withheld interest, after the held cash paid what it reached (2 d.p. string).

Exemplo:

"9850.00"

currency

string

obrigatório

ISO 4217 currency of the amounts.

Exemplo:

"BRL"

debtAtWriteOff

string

obrigatório

Debt D the borrower still owes after the write-off: the contract's full payoff of the write-off day, frozen at the write-off; recoveries pay it down (2 d.p. string).

Exemplo:

"11600.00"

heldCashApplied

string

obrigatório

Held cash the write-off's receipt applied to the debt first (2 d.p. string).

Exemplo:

"150.00"

string<uuid>

obrigatório

Recorded write-off.

loanAccountId

string<uuid>

obrigatório

Written-off loan account.

provisionConsumed

string

obrigatório

Provision the write-off consumed: the lesser of the allowance B and W (2 d.p. string).

Exemplo:

"6000.00"

provisionReleased

string

obrigatório

Allowance beyond the loss booked as a provision reversal: B - W when positive (2 d.p. string).

Exemplo:

"0.00"

reason

string

obrigatório

Why the contract was written off.

recordedBy

string

obrigatório

Subject of the validated identity that wrote it off; empty when none reached the route.

requestId

string

obrigatório

X-Idempotency key the write-off was recorded under.

withheldDerecognized

string

obrigatório

Withheld interest cleared from rendas a apropriar (2 d.p. string).

Exemplo:

"1600.00"

writtenOffAt

string<date-time>

obrigatório

RFC 3339 instant the write-off was recorded, with fractional seconds; the server clock dates it.

Produtos de empréstimo do Brasil

Operações de consignado

Ciclo de vida do produto

Versões do produto

Configuração do produto

Tabelas de taxa flutuante

Modelos de documento

Solicitações de Empréstimo

Instrumentos de crédito

Informações regulatórias e risco

Quitação e pré-pagamento

Baixas contábeis e recuperação de crédito

Visão geral e auditoria da conta

Encargos e cronograma

Pagamentos

Transações

Recebíveis de pagamento devolvido

Fundos de cessão

Lotes de cessão

Exceções e dossiês da cessão

Contabilidade

Painéis da carteira

Jurisdições

Impostos

Acesso de parceiros

Sessão

Data de negócio

Streaming

Tratamento de erros

Eventos

Write a contract off as a credit loss

Autorizações

Cabeçalhos

Parâmetros de caminho

Corpo

Resposta