Create accrual run

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/accrual-runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "businessDate": "2023-12-25",
  "mode": "<string>",
  "loanProductIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

import requests

url = "https://lender.sandbox.lerian.net/api/v1/accrual-runs"

payload = {
    "businessDate": "2023-12-25",
    "mode": "<string>",
    "loanProductIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    businessDate: '2023-12-25',
    mode: '<string>',
    loanProductIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://lender.sandbox.lerian.net/api/v1/accrual-runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://lender.sandbox.lerian.net/api/v1/accrual-runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'businessDate' => '2023-12-25',
    'mode' => '<string>',
    'loanProductIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/accrual-runs"

	payload := strings.NewReader("{\n  \"businessDate\": \"2023-12-25\",\n  \"mode\": \"<string>\",\n  \"loanProductIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\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))

}

HttpResponse<String> response = Unirest.post("https://lender.sandbox.lerian.net/api/v1/accrual-runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"businessDate\": \"2023-12-25\",\n  \"mode\": \"<string>\",\n  \"loanProductIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://lender.sandbox.lerian.net/api/v1/accrual-runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"businessDate\": \"2023-12-25\",\n  \"mode\": \"<string>\",\n  \"loanProductIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "businessDate": "<string>",
  "correlationId": "<string>",
  "id": "<string>",
  "journalReferenceId": "<string>",
  "status": "<string>",
  "outboxEventId": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank",
  "upstream": {
    "code": "<string>",
    "message": "<string>"
  }
}

POST

api

accrual-runs

Create accrual run

curl --request POST \
  --url https://lender.sandbox.lerian.net/api/v1/accrual-runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "businessDate": "2023-12-25",
  "mode": "<string>",
  "loanProductIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

import requests

url = "https://lender.sandbox.lerian.net/api/v1/accrual-runs"

payload = {
    "businessDate": "2023-12-25",
    "mode": "<string>",
    "loanProductIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    businessDate: '2023-12-25',
    mode: '<string>',
    loanProductIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://lender.sandbox.lerian.net/api/v1/accrual-runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://lender.sandbox.lerian.net/api/v1/accrual-runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'businessDate' => '2023-12-25',
    'mode' => '<string>',
    'loanProductIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://lender.sandbox.lerian.net/api/v1/accrual-runs"

	payload := strings.NewReader("{\n  \"businessDate\": \"2023-12-25\",\n  \"mode\": \"<string>\",\n  \"loanProductIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\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))

}

HttpResponse<String> response = Unirest.post("https://lender.sandbox.lerian.net/api/v1/accrual-runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"businessDate\": \"2023-12-25\",\n  \"mode\": \"<string>\",\n  \"loanProductIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://lender.sandbox.lerian.net/api/v1/accrual-runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"businessDate\": \"2023-12-25\",\n  \"mode\": \"<string>\",\n  \"loanProductIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "businessDate": "<string>",
  "correlationId": "<string>",
  "id": "<string>",
  "journalReferenceId": "<string>",
  "status": "<string>",
  "outboxEventId": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank",
  "upstream": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Body

application/json

businessDate

string<date>

required

Business date (YYYY-MM-DD) the accrual batch is queued for.

Example:

"2026-06-14"

mode

string

required

Accrual run cadence. The scheduled driver sends monthly, one competencia per loan.

Required string length: 1 - 32

Example:

"monthly"

loanProductIds

string<uuid>[] | null

Optional loan product identifiers to scope the run.

Maximum array length: 100

Response

Created

businessDate

string

required

Business date (YYYY-MM-DD, UTC) the run was queued for.

Example:

"2026-06-14"

correlationId

string

required

Correlation identifier linking the run to its journal/outbox lineage and downstream events.

Example:

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

string

required

Server-assigned UUID of the queued accrual run.

Example:

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

journalReferenceId

string

required

UUID of the journal reference recording this run's posting lineage.

Example:

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

status

string

required

Lifecycle status of the queued run (e.g. queued).

Example:

"queued"

outboxEventId

string

UUID of the emitted outbox event; omitted when no outbox event was recorded.

Example:

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

⌘I

Brazil loan products

Consignado operations

Loan product lifecycle

Product configuration

Loan Applications

Regulatory disclosures and risk

Payoff and prepayment

Account overview and audit

Charges and schedule

Repayments

Transactions

Accounting

Jurisdictions

Tax

Create accrual run

Authorizations

Body

Response