Create/Define a Charge

POST/lokta-lms/api/v1/charges

Define a new charge that can later be associated with loans and savings through their respective product definitions or directly on each account instance.

Request body application/json

activeboolean · optional

amountnumber · double · optional

capitalizableboolean · optional

capitalizeByDefaultboolean · optional

chargeAppliesTointeger · int32 · optional

chargeCalculationTypeinteger · int32 · optional

chargePaymentModeinteger · int32 · optional

chargeTimeTypeinteger · int32 · optional

codestring · optional

currencyCodestring · optional

eirClassificationinteger · int32 · optional

enablePaymentTypeboolean · optional

feeFrequencystring · optional

feeIntervalstring · optional

feeOnMonthDaystring · optional

localestring · optional

maxCapnumber · optional

minCapnumber · optional

monthDayFormatstring · optional

namestring · optional

paymentTypeIdinteger · int64 · optional

penaltyboolean · optional

taxGroupIdinteger · int64 · optional

Responses

200OK

Response fields

resourceIdinteger · int64 · optional

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.

curl -X POST \ 'http://localhost:8080/lokta-lms/api/v1/charges' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default' \ -H 'Content-Type: application/json' \ -d '{ "active": true, "amount": 0, "capitalizable": true, "capitalizeByDefault": true, "chargeAppliesTo": 1, "chargeCalculationType": 1, "chargePaymentMode": 1, "chargeTimeType": 1, "code": "string", "currencyCode": "string" }'

import requests response = requests.post( "http://localhost:8080/lokta-lms/api/v1/charges", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, json={ "active": True, "amount": 0, "capitalizable": True, "capitalizeByDefault": True, "chargeAppliesTo": 1, "chargeCalculationType": 1, "chargePaymentMode": 1, "chargeTimeType": 1, "code": "string", "currencyCode": "string" }, ) print(response.json())

const response = await fetch("http://localhost:8080/lokta-lms/api/v1/charges", { method: "POST", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", "Content-Type": "application/json", }, body: JSON.stringify({ "active": true, "amount": 0, "capitalizable": true, "capitalizeByDefault": true, "chargeAppliesTo": 1, "chargeCalculationType": 1, "chargePaymentMode": 1, "chargeTimeType": 1, "code": "string", "currencyCode": "string" }), }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("http://localhost:8080/lokta-lms/api/v1/charges")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(""" { "active": true, "amount": 0, "capitalizable": true, "capitalizeByDefault": true, "chargeAppliesTo": 1, "chargeCalculationType": 1, "chargePaymentMode": 1, "chargeTimeType": 1, "code": "string", "currencyCode": "string" } """)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

payload := strings.NewReader(`{ "active": true, "amount": 0, "capitalizable": true, "capitalizeByDefault": true, "chargeAppliesTo": 1, "chargeCalculationType": 1, "chargePaymentMode": 1, "chargeTimeType": 1, "code": "string", "currencyCode": "string" }`) req, _ := http.NewRequest("POST", "http://localhost:8080/lokta-lms/api/v1/charges", 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))