Run fees for a period and produce draft invoices

POST/lokta-lms/api/v1/fee-runs

Computes partner fees for a period and produces a draft invoice for each partner and currency.

Walks every attributed loan, finds the agreement in force for that loan's product, and accrues each fee line for the uncovered day-ranges of the period (a live accrual for the same loan+line covers its days). Then produces one draft invoice per partner+currency with a non-zero amount, each carrying a tracking number, the per-line basis with the terms version, and an identity snapshot. A rerun tops up late attributions; nothing is superseded or refused for overlap. A zero amount produces no draft.

Requires an Idempotency-Key; a replayed compute would double a partner's earnings for a period.

When to use it

Run this at the end of a period to compute partner fees from attributed loans and produce a draft invoice for each partner and currency.

Worth knowing

Send an Idempotency-Key header. A replayed compute would double a partner's earnings for the period.
A rerun tops up late attributions. It does not fail on overlap.

Header parameters

Idempotency-Keyheader · string · optional

Per-intent key

Request body application/json

period_startstring · optional

Placeholder name, to be confirmed. The first day of the period to compute.

period_endstring · optional

Placeholder name, to be confirmed. The last day of the period to compute.

Responses

defaultdefault response

Every request authenticates with HTTP Basic and carries a Tenant-Identifier header. See the conventions for dates, commands, pagination and errors. Open this operation in the interactive explorer, or read it as Markdown.

This is the API reference for Lokta, the agentic loan servicing platform. Go to lokta.ai

curl -X POST \ 'https://default.lokta.tech/lokta-lms/api/v1/fee-runs' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default' \ -H 'Content-Type: application/json' \ -d '{ "period_start": "string", "period_end": "string" }'

import requests response = requests.post( "https://default.lokta.tech/lokta-lms/api/v1/fee-runs", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, json={ "period_start": "string", "period_end": "string" }, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/fee-runs", { method: "POST", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", "Content-Type": "application/json", }, body: JSON.stringify({ "period_start": "string", "period_end": "string" }), }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://default.lokta.tech/lokta-lms/api/v1/fee-runs")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(""" { "period_start": "string", "period_end": "string" } """)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

payload := strings.NewReader(`{ "period_start": "string", "period_end": "string" }`) req, _ := http.NewRequest("POST", "https://default.lokta.tech/lokta-lms/api/v1/fee-runs", payload) req.SetBasicAuth("{username}", "{password}") req.Header.Set("Tenant-Identifier", "default") req.Header.Set("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(string(data))