Schedulesettings

The schedule settings, holds all schedule properties.

amortizationPeriodinteger<int32>

The PMT is calculated as the loan would have [amortizationPeriod] installments.

billingCycle object

Defines the billing cycles settings for a loan account

daysinteger<int32>[]

The billing cycle start days in case it is enabled

defaultFirstRepaymentDueDateOffsetinteger<int32>

The default first repayment due date offset, indicates how many days the first repayment due date should be extended(all other due dates from the schedule are relative to first repayment due date - they will also be affected by the offset)

fixedDaysOfMonthinteger<int32>[]

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

gracePeriodinteger<int32>required

The grace period. Represents the grace period for loan repayment - in number of installments.

gracePeriodTypestring

The grace period type for a loan account.

Possible values: [NONE, PAY_INTEREST_ONLY, INTEREST_FORGIVENESS]

hasCustomScheduleboolean

Flag used when the repayments schedule for the current account was determined by the user, by editing the due dates or the principal due

paymentPlan object[]

A list of periodic payments for the current loan account.

Array [

amountnumberrequired

The PMT value used in periodic payment

encodedKeystring

The encoded key of the periodic payment, auto generated, unique.

toInstallmentinteger<int32>required

The installment's position up to which the PMT will be used

]

periodicPaymentnumber

The periodic payment amount for the accounts which have balloon payments or Reduce Number of Installments and Optimized Payments

previewSchedule object

The number of previewed instalments for an account

numberOfPreviewedInstalmentsinteger<int32>

The number of previewed instalments

principalRepaymentIntervalinteger<int32>

The principal repayment interval. Indicates the interval of repayments that the principal has to be paid.

repaymentInstallmentsinteger<int32>

The repayment installments. Represents how many installments are required to pay back the loan.

repaymentPeriodCountinteger<int32>

The repayment period count. Represents how often the loan is to be repaid: stored based on the type repayment option.

repaymentPeriodUnitstring

The frequency of the loan repayment.

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

repaymentScheduleMethodstring

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

Possible values: [NONE, FIXED, DYNAMIC]

scheduleDueDatesMethodstring

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]

shortMonthHandlingMethodstring

The short month handling method type for a loan account.

Possible values: [LAST_DAY_IN_MONTH, FIRST_DAY_OF_NEXT_MONTH]

Schedulesettings

{
  "amortizationPeriod": 0,
  "billingCycle": {
    "days": [
      0
    ]
  },
  "defaultFirstRepaymentDueDateOffset": 0,
  "fixedDaysOfMonth": [
    0
  ],
  "gracePeriod": 0,
  "gracePeriodType": "NONE",
  "hasCustomSchedule": true,
  "paymentPlan": [
    {
      "amount": 0,
      "encodedKey": "string",
      "toInstallment": 0
    }
  ],
  "periodicPayment": 0,
  "previewSchedule": {
    "numberOfPreviewedInstalments": 0
  },
  "principalRepaymentInterval": 0,
  "repaymentInstallments": 0,
  "repaymentPeriodCount": 0,
  "repaymentPeriodUnit": "DAYS",
  "repaymentScheduleMethod": "NONE",
  "scheduleDueDatesMethod": "INTERVAL",
  "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH"
}