Read a contract's write-off and its recoveries

curl --request GET \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/write-off \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

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

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

	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: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

{
  "additionalLoss": "3850.00",
  "carryingAmount": "9850.00",
  "controlOpen": "0.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>",
  "recoveredTotal": "10200.00",
  "recoveries": [
    {
      "amount": "9000.00",
      "controlReleased": "8650.00",
      "currency": "BRL",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "loanAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "receivedAt": "2023-11-07T05:31:56Z",
      "recordedAt": "2023-11-07T05:31:56Z",
      "recordedBy": "<string>",
      "recoveredBefore": "1200.00",
      "remainingAfter": "1400.00",
      "requestId": "<string>",
      "taxAmount": "16.28",
      "taxedAmount": "350.00",
      "untaxedAmount": "8650.00",
      "writeOffId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reversedAt": "2023-11-07T05:31:56Z",
      "reversedBy": "<string>"
    }
  ],
  "remainingDebt": "1400.00",
  "requestId": "<string>",
  "withheldDerecognized": "1600.00",
  "writtenOffAt": "2023-11-07T05:31:56Z",
  "collectionEndedAt": "2023-11-07T05:31:56Z",
  "collectionEndedBy": "<string>",
  "controlReleasedAt": "2032-03-10"
}

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

GET

api

loan-accounts

{id}

write-off

Read a contract's write-off and its recoveries

curl --request GET \
  --url https://lender.sandbox.lerian.net/api/v1/br/loan-accounts/{id}/write-off \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

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

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

	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: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

{
  "additionalLoss": "3850.00",
  "carryingAmount": "9850.00",
  "controlOpen": "0.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>",
  "recoveredTotal": "10200.00",
  "recoveries": [
    {
      "amount": "9000.00",
      "controlReleased": "8650.00",
      "currency": "BRL",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "loanAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "receivedAt": "2023-11-07T05:31:56Z",
      "recordedAt": "2023-11-07T05:31:56Z",
      "recordedBy": "<string>",
      "recoveredBefore": "1200.00",
      "remainingAfter": "1400.00",
      "requestId": "<string>",
      "taxAmount": "16.28",
      "taxedAmount": "350.00",
      "untaxedAmount": "8650.00",
      "writeOffId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reversedAt": "2023-11-07T05:31:56Z",
      "reversedBy": "<string>"
    }
  ],
  "remainingDebt": "1400.00",
  "requestId": "<string>",
  "withheldDerecognized": "1600.00",
  "writtenOffAt": "2023-11-07T05:31:56Z",
  "collectionEndedAt": "2023-11-07T05:31:56Z",
  "collectionEndedBy": "<string>",
  "controlReleasedAt": "2032-03-10"
}

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

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

string<uuid>

required

Written-off direct-credit loan account.

Response

additionalLoss

string

required

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

Example:

"3850.00"

carryingAmount

string

required

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

Example:

"9850.00"

controlOpen

string

required

Written-off control still open (2 d.p. string); 0.00 once it was released.

Example:

"0.00"

currency

string

required

ISO 4217 currency of the amounts.

Example:

"BRL"

debtAtWriteOff

string

required

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

Example:

"11600.00"

heldCashApplied

string

required

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

Example:

"150.00"

string<uuid>

required

Recorded write-off.

loanAccountId

string<uuid>

required

Written-off loan account.

provisionConsumed

string

required

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

Example:

"6000.00"

provisionReleased

string

required

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

Example:

"0.00"

reason

string

required

Why the contract was written off.

recordedBy

string

required

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

recoveredTotal

string

required

Recovered so far across every standing recovery, reversed ones excluded (2 d.p. string).

Example:

"10200.00"

recoveries

object[] | null

required

The latest 100 recoveries, newest first, reversed ones included.

Show child attributes

remainingDebt

string

required

Debt still standing: debtAtWriteOff minus recoveredTotal (2 d.p. string).

Example:

"1400.00"

requestId

string

required

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

withheldDerecognized

string

required

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

Example:

"1600.00"

writtenOffAt

string<date-time>

required

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

collectionEndedAt

string<date-time>

RFC 3339 instant the client operator declared collection ended; absent until declared.

collectionEndedBy

string

Subject that declared it.

controlReleasedAt

string<date>

Business day the rest of the control left the books, the later of 5 years after the write-off and the declared end; absent while it stands.

Example:

"2032-03-10"

Brazil loan products

Consignado operations

Loan product lifecycle

Product versions

Product configuration

Floating-rate tables

Document templates

Loan Applications

Credit instruments

Regulatory disclosures and risk

Payoff and prepayment

Write-offs and credit-loss recovery

Account overview and audit

Charges and schedule

Repayments

Transactions

Returned payment receivables

Assignment funds

Assignment sets

Assignment exceptions and dossiers

Accounting

Portfolio dashboards

Jurisdictions

Tax

Partner access

Session

Business date

Streaming

Error handling

Events

Read a contract's write-off and its recoveries

Authorizations

Path Parameters

Response