Retrieve Charge Template

GET/lokta-lms/api/v1/charges/template

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:

Field Defaults
Allowed description Lists
Example Request:

charges/template

Query parameters

chargeAppliesToquery · integer · int64 · optional

chargeTimeTypequery · integer · int64 · optional

Responses

defaultdefault response

Response fields

accountMappingForChargeConfigstring · optional

activeboolean · optional

amountnumber · optional

assetAccountOptionsarray of GLAccountData · optional

capitalizableboolean · optional

capitalizeByDefaultboolean · optional

chargeAppliesToEnumOptionData · optional

chargeAppliesToOptionsarray of EnumOptionData · optional

chargeCalculationTypeEnumOptionData · optional

chargeCalculationTypeOptionsarray of EnumOptionData · optional

chargePaymentModeEnumOptionData · optional

chargePaymetModeOptionsarray of EnumOptionData · optional

chargeTimeTypeEnumOptionData · optional

chargeTimeTypeOptionsarray of EnumOptionData · optional

clientChargeCalculationTypeOptionsarray of EnumOptionData · optional

clientChargeTimeTypeOptionsarray of EnumOptionData · optional

codestring · optional

currencyCurrencyData · optional

currencyOptionsarray of CurrencyData · optional

eirClassificationEnumOptionData · optional

eirClassificationOptionsarray of EnumOptionData · optional

expenseAccountOptionsarray of GLAccountData · optional

feeFrequencyEnumOptionData · optional

feeFrequencyOptionsarray of EnumOptionData · optional

feeIntervalinteger · int32 · optional

feeOnMonthDayobject · optional

freeWithdrawalboolean · optional

freeWithdrawalChargeFrequencyinteger · int32 · optional

idinteger · int64 · optional

incomeOrLiabilityAccountGLAccountData · optional

incomeOrLiabilityAccountOptionsobject · optional

isPaymentTypeboolean · optional

loanChargeCalculationTypeOptionsarray of EnumOptionData · optional

loanChargeTimeTypeOptionsarray of EnumOptionData · optional

maxCapnumber · optional

minCapnumber · optional

namestring · optional

overdueInstallmentChargeboolean · optional

paymentTypeOptionsPaymentTypeData · optional

penaltyboolean · optional

restartFrequencyinteger · int32 · optional

restartFrequencyEnuminteger · int32 · optional

savingsChargeCalculationTypeOptionsarray of EnumOptionData · optional

savingsChargeTimeTypeOptionsarray of EnumOptionData · optional

shareChargeCalculationTypeOptionsarray of EnumOptionData · optional

shareChargeTimeTypeOptionsarray of EnumOptionData · optional

taxGroupTaxGroupData · optional

taxGroupOptionsarray of TaxGroupData · 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.