Previewloanaccountschedule
Payload structure to preview loan account schedule.
disbursementDetails object
The the disbursement details it holds the information related to the disbursement details as disbursement date, first repayment date, disbursement fees.
The date of the expected disbursement.Stored as Organization Time.
2016-09-06T13:37:50+03:00fees object[]
List of fees that should be applied at the disbursement time.
The amount of the custom fee.
The encoded key of the custom predefined fee, auto generated, unique.
The percentage of the custom fee.
The encoded key of the predefined fee
The date of the expected first repayment. Stored as Organization Time.
2016-09-06T13:37:50+03:00feeRateSettings object
Defines fees settings for schedule preview.
The fee rate. Represents the fee rate for the loan account.
The value of the interest booked by the organization from the accounts funded by investors. Null if the funds are not enable
interestSettings object
The interest settings, holds all the properties regarding interests for the loan account.
accountInterestRateSettings object[]
The interest settings details for schedule preview.
The encoded key of the interest rate settings, auto generated, unique
Index rate source key.
Interest rate value.
Maximum value allowed for index based interest rate. Valid only for index interest rate.
Minimum value allowed for index based interest rate. Valid only for index interest rate.
Interest rate review frequency unit count. Valid only for index interest rate.
The interest rate review unit values. Shows how often is index interest rate reviewed.
Possible values: [DAYS, WEEKS, MONTHS]
The interest rate review unit values. Shows how often is index interest rate reviewed.
Possible values: [FIXED_INTEREST_RATE, INDEX_INTEREST_RATE]
Interest spread value.
Date since an interest rate is valid
2016-09-06T13:37:50+03:00The interest rate. Represents the interest rate for the loan account. The interest on loans is accrued on a daily basis, which allows charging the clients only for the days they actually used the loan amount.
Interest to be added to active organization index interest rate in order to find out actual interest rate
The loan amount
plannedInstallmentFees object[]
A list with planned manual fees to be applied on the installments for schedule preview.
The amount of the planned fee.
The date when a planned fee should be applied, overriding installment's due date. It should match the interval of the installment. If it belong to first installment, it should be between disbursement date and installment due date.
2016-09-06T13:37:50+03:00The encoded key of the planned installment fee, auto generated, unique.
The encoded key of the installment on which the predefined fee is planned.
The number of the installment on which the predefined fee is planned. It is used only in the case when fees are created at the same time with the loan account creation or during preview schedule, before account creation, otherwise this should be empty and installmentKey will be used to identify an installment.
The encoded key of the predefined fee which is planned.
The key to the type of product that this account is based on.
scheduleSettings object
The schedule settings, holds all schedule properties needed for schedule preview request.
The PMT is calculated as the loan would have [amortizationPeriod] installments.
Specifies the days of the month when the repayment due dates should be. Only available if the Repayment Methodology is FIXED_DAYS_OF_MONTH.
The grace period. Represents the grace period for loan repayment - in number of installments.
paymentPlan object[]
A list of periodic payments for the current loan account.
The PMT value used in periodic payment
The installment's position up to which the PMT will be used
The periodic payment amount for the accounts which have balloon payments or Reduce Number of Installments and Optimized Payments
The principal repayment interval. Indicates the interval of repayments that the principal has to be paid.
The repayment installments. Represents how many installments are required to pay back the loan.
The repayment period count. Represents how often the loan is to be repaid: stored based on the type repayment option.
The frequency of the loan repayment.
Possible values: [DAYS, WEEKS, MONTHS, YEARS]
The top up amount in case of a refinanced account
tranches object[]
List of tranches to be considered for schedule preview.
The amount this tranche has available for disburse
disbursementDetails object
The disbursement details regarding a loan tranche.
The key of the disbursement transaction logged when this tranche was disbursed. This field will be null until the tranche disbursement
The date when this tranche is supposed to be disbursed (as Organization Time)
2016-09-06T13:37:50+03:00The encoded key of the transaction details , auto generated, unique.
fees object[]
Fees that are associated with this tranche
The amount of the custom fee.
The encoded key of the custom predefined fee, auto generated, unique.
The percentage of the custom fee.
The encoded key of the predefined fee
Index indicating the tranche number
{
"disbursementDetails": {
"expectedDisbursementDate": "2016-09-06T13:37:50+03:00",
"fees": [
{
"amount": 0,
"encodedKey": "string",
"percentage": 0,
"predefinedFeeEncodedKey": "string"
}
],
"firstRepaymentDate": "2016-09-06T13:37:50+03:00"
},
"feeRateSettings": {
"feeRate": 0
},
"interestCommission": 0,
"interestSettings": {
"accountInterestRateSettings": [
{
"encodedKey": "string",
"indexSourceKey": "string",
"interestRate": 0,
"interestRateCeilingValue": 0,
"interestRateFloorValue": 0,
"interestRateReviewCount": 0,
"interestRateReviewUnit": "DAYS",
"interestRateSource": "FIXED_INTEREST_RATE",
"interestSpread": 0,
"validFrom": "2016-09-06T13:37:50+03:00"
}
],
"interestRate": 0,
"interestSpread": 0
},
"loanAmount": 0,
"plannedInstallmentFees": [
{
"amount": 0,
"applyOnDate": "2016-09-06T13:37:50+03:00",
"encodedKey": "string",
"installmentKey": "string",
"installmentNumber": 0,
"predefinedFeeKey": "string"
}
],
"productTypeKey": "string",
"scheduleSettings": {
"amortizationPeriod": 0,
"fixedDaysOfMonth": [
0
],
"gracePeriod": 0,
"paymentPlan": [
{
"amount": 0,
"toInstallment": 0
}
],
"periodicPayment": 0,
"principalRepaymentInterval": 0,
"repaymentInstallments": 0,
"repaymentPeriodCount": 0,
"repaymentPeriodUnit": "DAYS"
},
"topUpAmount": 0,
"tranches": [
{
"amount": 0,
"disbursementDetails": {
"disbursementTransactionKey": "string",
"expectedDisbursementDate": "2016-09-06T13:37:50+03:00"
},
"encodedKey": "string",
"fees": [
{
"amount": 0,
"encodedKey": "string",
"percentage": 0,
"predefinedFeeEncodedKey": "string"
}
],
"trancheNumber": 0
}
]
}