diff --git a/APIFolder/api.htm b/APIFolder/api.htm index e422e5d77..45491c7d4 100644 --- a/APIFolder/api.htm +++ b/APIFolder/api.htm @@ -482,6 +482,9 @@ var jqxhr = $.ajax({ externalId A place to put an external reference for this client e.g. The ID another system uses. + maxJoinedOnOffsetFromToday + Convenience field. Number of days since the Client joined. + @@ -1889,28 +1892,36 @@ Request Body: inArrearsTolerance numberOfRepayments - Number of installments to repay. + 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 - - Example Values: Days, Weeks, Months + Used like: numberOfRepayments Every repaymentEvery repaymentFrequencyType
+ e.g. 10 (repayments) Every 12 Weeks +
Example Values: Days, Weeks, Months - interestRateFrequencyTypePer month - - Example Values: Per month, Per year + 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 - - Example Values: Declining Balance, Flat + 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 diff --git a/APIFolder/docUpdateComments.txt b/APIFolder/docUpdateComments.txt index 5c3b551bb..05a6c9acf 100644 --- a/APIFolder/docUpdateComments.txt +++ b/APIFolder/docUpdateComments.txt @@ -63,12 +63,9 @@ DOCUMENTATION REMAINING Just Errors section to do in the Overview section -Loans - what does Keith think about a description - Identify Fields that need explaining ========================= -Clients -displayName, externalId, maxJoinedOnOffsetFromToday +bit of loan product/loan repayment/waiver