Skip to main content

Loanproductschedulesettings

Defines the settings and constraints for schedule for the loans that are created based on this product.

amortizationPeriod object

It holds information about the loan product amortization period. The PMT is calculated as the loan would have [amortisationPeriod] instalments

defaultValueinteger<int32>

default value

maxValueinteger<int32>

max value

minValueinteger<int32>

min value

billingCycles object

Defines the billing cycles settings for revolving credit products

enabledboolean

The billing cycle status if it is enabled or disabled

startDaysinteger<int32>[]

The billing cycle start days in case it is enabled

defaultRepaymentPeriodCountinteger<int32>

Interval Repayment Methodology Settings.

firstRepaymentDueDateOffset object

Decimal integer, like min/max/default.

defaultValueinteger<int32>

The default value, will be used in case no other value was filled in by the user.

encodedKeystring

The encoded key of the integer constraint, auto generated, unique

maxValueinteger<int32>

The maximum value.

minValueinteger<int32>

The minimum value.

fixedDaysOfMonthinteger<int32>[]

Specifies the days of the month when the repayment due dates should be. Only available if the Repayment Methodology is ScheduleDueDatesMethodDTO#FIXED_DAYS_OF_MONTH.

interestAccrualSincestring

Represents the moment the interest will start getting accrued.

Possible values: [DISBURSEMENT, DUE_DATE]

keepInstallmentsEqualIfLongFirstPeriodboolean

For optimized payments only, indicates whether the installments should remain equal when the first period is long

numInstallments object

Decimal integer, like min/max/default.

defaultValueinteger<int32>

The default value, will be used in case no other value was filled in by the user.

encodedKeystring

The encoded key of the integer constraint, auto generated, unique

maxValueinteger<int32>

The maximum value.

minValueinteger<int32>

The minimum value.

previewSchedule object

Defines the Preview Schedule settings for revolving products

numberOfPreviewedInstalmentsinteger<int32>

Number of Previewed Instalments.

previewScheduleEnabledboolean

Preview Schedule status.

repaymentMethodstring

The repayment method value

Possible values: [AMOUNT, INSTALLMENTS]

repaymentPeriodUnitstring

The frequency of the loan repayment.

Possible values: [DAYS, WEEKS, MONTHS, YEARS]

repaymentReschedulingMethodstringrequired

The repayment rescheduling method used in calculations.

Possible values: [NONE, NEXT_WORKING_DAY, PREVIOUS_WORKING_DAY, EXTEND_SCHEDULE]

repaymentScheduleEditOptionsstring[]

Shows the properties from the repayment schedule can be edited.

Possible values: [ADJUST_PAYMENT_DATES, ADJUST_PRINCIPAL_PAYMENT_SCHEDULE, ADJUST_INTEREST_PAYMENT_SCHEDULE, ADJUST_FEE_PAYMENT_SCHEDULE, ADJUST_PENALTY_PAYMENT_SCHEDULE, ADJUST_NUMBER_OF_INSTALLMENTS, ADJUST_PAYMENT_HOLIDAYS]

repaymentScheduleMethodstringrequired

The method used by the loans to compute the repayment schedule.

Possible values: [NONE, FIXED, DYNAMIC]

roundingSettings object

Defines the rounding settings used in the loan computation.

repaymentCurrencyRoundingstringrequired

Specifies the repayment currency rounding method.

Possible values: [NO_ROUNDING, ROUND_TO_NEAREST_WHOLE_UNIT, ROUND_UP_TO_NEAREST_WHOLE_UNIT]

repaymentElementsRoundingMethodstringrequired

Determines how the repayment currency rounding is handled on each element from the schedule.

Possible values: [NO_ROUNDING, ROUND_ALL, PAYMENT_DUE]

roundingRepaymentScheduleMethodstringrequired

Specifies the rounding repayment schedule method.

Possible values: [NO_ROUNDING, ROUND_REMAINDER_INTO_LAST_REPAYMENT, ROUND_PRINCIPAL_AND_INTEREST_REMAINDER_INTO_LAST_REPAYMENT]

scheduleDueDatesMethodstringrequired

The schedule due dates method. Used by the loan accounts to determine the due dates of the repayments.

Possible values: [INTERVAL, FIXED_DAYS_OF_MONTH]

scheduleEditOptionDetails object

Holds Repayments Schedule Editing options

paymentHolidaysSettings object

Holds Payment Holidays Settings

paymentHolidaysLoanTermOptionstring

payment holiday option

Possible values: [EXTEND_LOAN_TERM, KEEP_THE_SAME_LOAN_TERM]

shortMonthHandlingMethodstring

The short month handling method type for a loan account.

Possible values: [LAST_DAY_IN_MONTH, FIRST_DAY_OF_NEXT_MONTH]

Loanproductschedulesettings
{
"amortizationPeriod": {
"defaultValue": 0,
"maxValue": 0,
"minValue": 0
},
"billingCycles": {
"enabled": true,
"startDays": [
0
]
},
"defaultRepaymentPeriodCount": 0,
"firstRepaymentDueDateOffset": {
"defaultValue": 0,
"encodedKey": "string",
"maxValue": 0,
"minValue": 0
},
"fixedDaysOfMonth": [
0
],
"interestAccrualSince": "DISBURSEMENT",
"keepInstallmentsEqualIfLongFirstPeriod": true,
"numInstallments": {
"defaultValue": 0,
"encodedKey": "string",
"maxValue": 0,
"minValue": 0
},
"previewSchedule": {
"numberOfPreviewedInstalments": 0,
"previewScheduleEnabled": true
},
"repaymentMethod": "AMOUNT",
"repaymentPeriodUnit": "DAYS",
"repaymentReschedulingMethod": "NONE",
"repaymentScheduleEditOptions": [
"ADJUST_PAYMENT_DATES"
],
"repaymentScheduleMethod": "NONE",
"roundingSettings": {
"repaymentCurrencyRounding": "NO_ROUNDING",
"repaymentElementsRoundingMethod": "NO_ROUNDING",
"roundingRepaymentScheduleMethod": "NO_ROUNDING"
},
"scheduleDueDatesMethod": "INTERVAL",
"scheduleEditOptionDetails": {
"paymentHolidaysSettings": {
"paymentHolidaysLoanTermOption": "EXTEND_LOAN_TERM"
}
},
"shortMonthHandlingMethod": "LAST_DAY_IN_MONTH"
}