Reconcile a contract's deferred origination fee

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

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/loan-accounts/{id}/deferred-fee-reconciliation"

	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/loan-accounts/{id}/deferred-fee-reconciliation', 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/loan-accounts/{id}/deferred-fee-reconciliation"

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

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

print(response.text)

{
  "accounts": [
    "<string>"
  ],
  "currency": "BRL",
  "loanAccountId": "550e8400-e29b-41d4-a716-446655440003",
  "retainedFee": "150.00",
  "status": "MATCH",
  "figures": {
    "deferred": "150.00",
    "recognised": "25.00",
    "released": "125.00",
    "remaining": "0.00",
    "difference": "-150.00"
  }
}

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

Reconcile a contract's deferred origination fee

Reads the ledger lines of the contract’s own deferred-fee accounts, across every chart it lived under, into deferred, recognised, released and remaining, and holds the deferred figure against the fee the contract record says was retained. The contract is named by its loan account alone: product version, disbursement day, currency and retained fee come from the tenant’s contract record. A ledger that does not answer is status UNAVAILABLE, not an error.

GET

api

loan-accounts

{id}

deferred-fee-reconciliation

Reconcile a contract's deferred origination fee

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

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/loan-accounts/{id}/deferred-fee-reconciliation"

	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/loan-accounts/{id}/deferred-fee-reconciliation', 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/loan-accounts/{id}/deferred-fee-reconciliation"

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

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

print(response.text)

{
  "accounts": [
    "<string>"
  ],
  "currency": "BRL",
  "loanAccountId": "550e8400-e29b-41d4-a716-446655440003",
  "retainedFee": "150.00",
  "status": "MATCH",
  "figures": {
    "deferred": "150.00",
    "recognised": "25.00",
    "released": "125.00",
    "remaining": "0.00",
    "difference": "-150.00"
  }
}

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

Loan account identifier of the contract.

Example:

"550e8400-e29b-41d4-a716-446655440003"

Response

accounts

string[] | null

required

The contract's own deferred-fee accounts the figures were read from, one per chart the contract lived under, oldest first; always present, empty when the contract's charts defer no fee.

currency

string

required

Asset the fee is held in.

Example:

"BRL"

loanAccountId

string

required

Loan account (uuid) of the contract reconciled.

Example:

"550e8400-e29b-41d4-a716-446655440003"

retainedFee

string

required

Fee the contract record says was withheld at disbursement, summed over every tranche, as a fixed two-decimal string.

Example:

"150.00"

status

enum<string>

required

MATCH: the ledger deferred exactly the fee the contract retained. DIVERGENT: the two differ, or remaining is negative (the fee was earned more than once); figures.difference says by how much. UNAVAILABLE: the ledger did not answer, so figures is absent.

Available options:

MATCH,

DIVERGENT,

UNAVAILABLE

figures

object

What the ledger holds on the fee accounts. Present on MATCH and DIVERGENT, absent on UNAVAILABLE.

Show child attributes

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

Account overview and audit

Charges and schedule

Repayments

Transactions

Returned payment receivables

Assignment funds

Assignment sets

Assignment exceptions and registry

Accounting

Portfolio dashboards

Jurisdictions

Tax

Session

Streaming

Error handling

Events

Reconcile a contract's deferred origination fee

Authorizations

Path Parameters

Response