From fa6af79a3a45faa7b57975cff73c90e518134d4e Mon Sep 17 00:00:00 2001 From: John Woodlock Date: Fri, 1 Jun 2012 18:17:23 +1000 Subject: [PATCH] api docs update --- APIFolder/api.htm | 47 +++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 45 insertions(+), 2 deletions(-) diff --git a/APIFolder/api.htm b/APIFolder/api.htm index 45491c7d4..749c10ed3 100644 --- a/APIFolder/api.htm +++ b/APIFolder/api.htm @@ -826,8 +826,51 @@ Request Body:

Loans

-

overview here -

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field Descriptions
digitsAfterDecimal
Override the loan product default value for digitsAfterDecimal.
principal
Loan amount.
inArrearsTolerance
numberOfRepayments
Number of installments to repay.
+ Used like: numberOfRepayments Every repaymentEvery repaymentFrequencyType
+ e.g. 10 (repayments) Every 12 Weeks
interestRatePerPeriod
Interest Rate.
+ Used like: interestRatePerPeriod% interestRateFrequencyType - interestType
+ e.g. 12.0000% Per year - Declining Balance
repaymentEvery
Used like: numberOfRepayments Every repaymentEvery repaymentFrequencyType
+ e.g. 10 (repayments) Every 12 Weeks
Each of the items below has an id, code and (english) value.
+ Only the id (integer) is used when updating. All 3 are returned on GET (read) requests.
+ The options are fully listed in Retrieve Loan Product Details Template. +
repaymentFrequencyType
Used like: numberOfRepayments Every repaymentEvery repaymentFrequencyType
+ e.g. 10 (repayments) Every 12 Weeks +
Example Values: Days, Weeks, Months +
interestRateFrequencyType
Used like: interestRatePerPeriod% interestRateFrequencyType - interestType
+ e.g. 12.0000% Per year - Declining Balance +
Example Values: Per month, Per year
amortizationType
+ Example Values: Equal principle payments, Equal installments
interestType
Used like: interestRatePerPeriod% interestRateFrequencyType - interestType
+ e.g. 12.0000% Per year - Declining Balance +
Example Values: Declining Balance, Flat
interestCalculationPeriodType
+ Example Values: Same as repayment period, Daily
Field Descriptions
externalId