api docs update

APIFolder/api.htm

@@ -482,6 +482,9 @@ var jqxhr = $.ajax({
                     <tr class=alt><td>externalId</td></tr>
                     <tr><td class=fielddesc>A place to put an external reference for this client e.g. The ID another system uses.</td></tr>
                     </tr>
+                    <tr class=alt><td>maxJoinedOnOffsetFromToday</td></tr>
+                    <tr><td class=fielddesc>Convenience field. Number of days since the Client joined.</td></tr>
+                    </tr>
                 </table>
             </div>
         </div>
@@ -1889,28 +1892,36 @@ Request Body:
                     <tr class=alt><td>inArrearsTolerance</td></tr>
                     <tr><td class=fielddesc></td></tr>
                     <tr class=alt><td>numberOfRepayments</td></tr>
-                    <tr><td class=fielddesc>Number of installments to repay.</td></tr>
+                    <tr><td class=fielddesc>Number of installments to repay.<br>
+                    Used like: numberOfRepayments Every repaymentEvery repaymentFrequencyType<br>
+                    e.g. <b>10</b> (repayments) Every 12 Weeks</td></tr>
                     <tr class=alt><td>interestRatePerPeriod</td></tr>
-                    <tr><td class=fielddesc></td></tr>
+                    <tr><td class=fielddesc>Interest Rate.<br>
+                    Used like: interestRatePerPeriod% interestRateFrequencyType - interestType<br>
+                    e.g. <b>12.0000</b>%  Per year - Declining Balance</td></tr>
                     <tr class=alt><td>repaymentEvery</td></tr>
-                    <tr><td class=fielddesc></td></tr>
+                    <tr><td class=fielddesc>Used like: numberOfRepayments Every repaymentEvery repaymentFrequencyType<br>
+                    e.g. 10 (repayments) Every <b>12</b> Weeks</td></tr>
                     <tr><td class=fieldtype>Each of the items below has an id, code and (english) value.<br>
                     Only the id (integer) is used when updating.  All 3 are returned on GET (read) requests.<br>
                     The options are fully listed in <a href="#loanproducts_template">Retrieve Loan Product Details Template</a>.
                     </td></tr>
                     <tr class=alt><td>repaymentFrequencyType</td></tr>
-                    <tr><td class=fielddesc>
+                    <tr><td class=fielddesc>Used like: numberOfRepayments Every repaymentEvery repaymentFrequencyType<br>
-                        <span>Example Values:</span> Days, Weeks, Months
+                    e.g. 10 (repayments) Every 12 <b>Weeks</b>
+                    <br><span>Example Values:</span> Days, Weeks, Months
                     </td></tr>
-                    <tr class=alt><td>interestRateFrequencyType</td></tr>Per month
+                    <tr class=alt><td>interestRateFrequencyType</td></tr>
-                    <tr><td class=fielddesc>
+                    <tr><td class=fielddesc>Used like: interestRatePerPeriod% interestRateFrequencyType - interestType<br>
-                        <span>Example Values:</span> Per month, Per year</td></tr>
+                    e.g. 12.0000%  <b>Per year</b> - Declining Balance
+                    <br><span>Example Values:</span> Per month, Per year</td></tr>
                     <tr class=alt><td>amortizationType</td></tr>
                     <tr><td class=fielddesc>
                         <span>Example Values:</span> Equal principle payments, Equal installments</td></tr></td></tr>
                     <tr class=alt><td>interestType</td></tr>
-                    <tr><td class=fielddesc>
+                    <tr><td class=fielddesc>Used like: interestRatePerPeriod% interestRateFrequencyType - interestType<br>
-                        <span>Example Values:</span> Declining Balance, Flat</td></tr></td></tr>
+                    e.g. 12.0000%  Per year - <b>Declining Balance</b>
+                    <br><span>Example Values:</span> Declining Balance, Flat</td></tr></td></tr>
                     <tr class=alt><td>interestCalculationPeriodType</td></tr>
                     <tr><td class=fielddesc>
                         <span>Example Values:</span> Same as repayment period, Daily</td></tr></td></tr>

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
+bit of loan product/loan
-displayName, externalId, maxJoinedOnOffsetFromToday
 
 repayment/waiver