Skip to main content

Retrieves fully amortized account installment plan by account code.

HEAD 
/Loans/fullyamortized/accounts/:code/installmentplan

Retrieves fully amortized account installment plan by account code.

Request​

Path Parameters

    code stringrequired

Query Parameters

    api-version string

Header Parameters

    X-Request-ID stringrequired

Responses​

Schema
    planId int32required

    Installment plan unique id.

    startDate date-timerequired

    Starting date of the plan.

    endDate date-timenullablerequired

    The date the plan became inactive. Null otherwise

    isActive booleanrequired

    If the plan is active

    installmentsNumber int32required

    Total number of installments.

    installmentPeriodType object

    The type of the period of each installment.

    oneOf

    string

    Possible values: [Day, Month, Year]

    installmentPeriodDuration int32required

    The number of period types of each installment. E.g. for 6-month installment, period type is Month and period duration is 6.

    yearDaysBasis int32required

    Days of the year for interest calculation. 360 or 365.

    interestFreeCapitalPercentage decimalrequired

    Percentage of capital that is interest free. Used in cofinanced loans in order to calculate interest only on the bank capital.

    levyFreeCapitalPercentage decimalrequired

    Percentage of capital that is levy free. Used in cofinanced loans in order to calculate interest levy only on the bank capital.

    floatingSubsidyRate booleanrequired

    If the subsidy rate is floating. In this case if the interest rate changes, then the sybsidy rate changes accordingly, keeping the subsidy percentage stable.

    removeSubsidyFromInterest booleanrequired

    If true, the installment interest is reduced by the subsidized amount and the customer pays only the non-subsidized interest.

    gracePeriod object nullable

    The type of the grace period given.

    oneOf

    string

    Possible values: [Without, InterestOnly, Extended, GradualCapitalization, TotalCapitalization]

    gracePeriodsNumber int32required

    The number of grace periods.

    gracePeriodPayment decimalrequired

    The amount to be paid on each installment during the grace period.

    paymentToleranceDays int32required

    Number of tolerance days after due date without arrears.

    overallApr decimalrequired

    Annual percentage rate (seppe).

    effectiveRate decimalrequired

    Annual percentage rate (seppe).

    periodDaysConvention object nullable

    Convention for the number of days of a monthly period (30.4166 , 30 or Actual)

    oneOf

    string

    Possible values: [Month_30_41666, Month_30, Actual]

    calculationMethod object nullable

    Calculation method of the installment plan.

    oneOf

    string

    Possible values: [EqualPayments, EqualPrincipal, EqualInterest, InterestOnInstalmentPrincipal]

    installments object[]nullable

    The list of the installments.

  • Array [
    • installmentId int32required

    Installment unique id.

    installmentNumber int32nullablerequired

    Installment sequence number.

    calendarDueDate date-timerequired

    Original due date (regardless of holidays or user changes).

    dueDate date-timerequired

    Due date of installment.

    paymentDate date-timerequired

    Date the installment can be paid without arrears.

    interestRate decimalrequired

    Interest rate in decimal (divided by 100). E.g. 5% rate is expressed as 0.05 . It is the total interest rate of the installment (product rate plus margin).

    levyRate decimalrequired

    Interest levy rate in decimal (divided by 100). E.g. 0.6% rate is expressed as 0.006

    interestSpreadRate decimalrequired

    Interest rate margin for the specific account/installment.

    levySpreadRate decimalrequired

    Levy rate margin for the specific account/installment.

    subsidyRate decimalnullablerequired

    Subsidized interest rate. Null for non subsidized loans.

    initialCapital decimalnullablerequired

    Initial total capital of the installment.

    principalAmount decimalrequired

    Principal amount of the installment.

    interestAmount decimalrequired

    Debit Interest amount of the installment.

    levyAmount decimalrequired

    Levy amount of the installment.

    loanFeesAmount decimalrequired

    Fees amount of the installment.

    insuranceFeesAmount decimalrequired

    Insurance fees amount of the installment.

    subsidyAmount decimalnullablerequired

    Subsidized interest amount of the installment. Null for non subsidized loans.

    isInterestInstallment booleannullablerequired

    True only for separate interest installments of amortized loans.

    totalIntallmentAmount decimalrequired

    Total payment amount of the installment.

    totalInterestRate decimalrequired

    Total interest rate of the installment (interest rate plus levy rate).

  • ]
Loading...