home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / bbs / amigalib / d987 / loancalc.lha / LoanCalc / LoanCalc.doc < prev    next >
Encoding:
Text File  |  1994-04-05  |  18.8 KB  |  428 lines
  1.                       LoanCalc V2.0d - by Robert Bromley
  2.                                                                         
  3.  
  4.                               TABLE OF CONTENTS
  5.  
  6.                       1   Copyrights
  7.                       2   Introduction
  8.                       3   The Main Menu
  9.                       4   Sample Data Files
  10.                       5   The Interest Compound Period
  11.                       6   Calculation of the Payment Date
  12.                       7   Program Requirements
  13.                       8   Program Limitations
  14.                       9   Error Messages
  15.                      10   Accuracy
  16.                      11   Files Included With This Program
  17.  
  18.  
  19.     1   COPYRIGHTS 
  20.  
  21.     LoanCalc is © 1990, 1991, 1994 by Robert Bromley.  All rights reserved.
  22.     LoanCalc may be considered to be what I have heard refered to as
  23.     "giftware".  This means that it is freely distributable, as long as the
  24.     entire package is distributed unaltered and intact, and no charge is
  25.     made for it other than reasonable costs for copying and media.
  26.  
  27.     There is no payment required for the use of LoanCalc, but, if you find
  28.     the program to be particularly useful, then I would request that you
  29.     send me whatever you think it is worth.
  30.  
  31.     MuchMore is © 1991 by Fridtjof Seibert.
  32.     Refer to the "MuchMore.ReadMe" file for further information.
  33.  
  34.     ARP is © 1987, 88, 89 by ARP Authors.
  35.  
  36.  
  37.     2   INTRODUCTION 
  38.  
  39.     Although there are many mortgage calculation programs available, all
  40.     that I have seen are designed around 'fixed' mortgages, ie. mortgages
  41.     that have a fixed payment due on a fixed date.  As well as providing a
  42.     printed Amortization Table for Fixed Mortgages with Monthly, Semi-
  43.     Monthly, Bi-Weekly and Weekly payment schedules, (including a provision
  44.     for making Lump Sum Payments), LoanCalc (LC) is designed to track
  45.     'Open' mortgages that allow any size payment to be made at any time.
  46.  
  47.     If you are looking for a program that will quickly give you payments or
  48.     amortization periods of loans with fixed monthly payments, without the
  49.     printed Amortization Table, I can heartily recommend MortCalc, written
  50.     by Michel Laliberte, available on Fish 385.  It will be easier to use
  51.     for this purpose.  The advantage of LC is the flexability to calculate
  52.     repayment schedules for almost any timetable, the Lump Sum Payment
  53.     option, the Open Mortgage option, and the ability to give you an easy
  54.     to read printed Amortization Table.
  55.  
  56.     I apologize for the size of this program.  Being a 'weekend' programer,
  57.     my programing style could not be described as elegant.  The program is
  58.     written in BASIC, compiled with the HiSoft BASIC Professional compiler.
  59.     To anyone out there who still programs with the AmigaBASIC interpreter,
  60.     I admire your dedication.  The frustration of it all was just too much
  61.     for me.  Look into HiSoft BASIC Professional, and put the joy back into
  62.     programing.
  63.  
  64.     This version of LC supports both mouse and keyboard for most of its
  65.     functions, the major exception of course being specific data which must
  66.     be input (ie. payments, dates, etc), and it uses the ARP requester for
  67.     the input of filenames.
  68.  
  69.     As of Version 2.0, LC utilizes the freely distributable file viewer
  70.     "MuchMore" for all viewing and printing of data files.  MuchMore is a
  71.     terrific, full-featured file viewer, and I thank Fridtjof and AMOK for
  72.     making this program freely distributable.  Please read the
  73.     "MuchMore.ReadMe" file to fully appreciate all of the features of this
  74.     program.  Pressing the <Help> key while MuchMore is running will give
  75.     you a synopsis.
  76.  
  77.     Note that for the viewing or printing of datafiles, the MuchMore
  78.     program will have to be either in the Current Directory, or in your
  79.     search path.  The C: directory would probably be the best place to put
  80.     it, as I would not be surprised if you decided to use it as your
  81.     regular text viewer.
  82.  
  83.     At any time, if the 'Esc' key is hit, then LC will escape from the data
  84.     entry mode and return to the Main Menu.
  85.  
  86.     LC generally multitasks very well.  While waiting for input, the
  87.     program is 'sleeping', and therefore does not use up CPU time
  88.     needlessly.
  89.  
  90.     If LC is launched from Workbench, icons will be created for all '.data'
  91.     files created, in case you would like to edit the file.  These icons
  92.     have no default tool, however, since I don't know which editor you
  93.     would be using to edit the file.  You can supply your own using the
  94.     Workbench 'Info' Menu item.
  95.  
  96.     If launched from the CLI, no icons are created.
  97.  
  98.     While entering data (especially data for Open Mortgages), there are
  99.     lots of tiresome "Are you sure?" type prompts.  Although nobody likes
  100.     them when data is correct, they are useful in case of finger-trouble.
  101.  
  102.  
  103.     3   THE MAIN MENU 
  104.  
  105.     LC opens on the Main Menu, where there are 8 selections:
  106.  
  107.         1.  Start a New Mortgage/Loan File
  108.         2.  Enter a Payment to an Existing Open-type File
  109.         3.  Re-Calculate the Current Fixed-type Loan
  110.         4.  View/Print a Data File
  111.         5.  Information
  112.         6.  About
  113.         7.  Help  (or <Help> key)
  114.         8.  Quit  (or <Esc>)
  115.  
  116.     Just Click on the appropriate item, or press the appropriate number
  117.     on either number pad.
  118.     
  119.     1.  Start a New Mortgage/Loan File 
  120.  
  121.     This selection should be made if you have not already opened a file
  122.     under the proposed filename, for example "FirstMortgage", and there is
  123.     no "FirstMortgage.data" and "FirstMortgage.datavar" files in the
  124.     specified directory.  A file will then be built from scratch.
  125.  
  126.     While running, LC will request a directory and filename under which the
  127.     program data will be kept.  The default directory is RAM:, but you may
  128.     specify any other.  Two files will then be generated in that directory.
  129.     One, "Filename.data", will store all information regarding payments
  130.     made, dates, interest paid, total interest, etc.  The other,
  131.     "Filename.datavar", will store all the variables required by LC, which
  132.     will vary from one session to the next.  If the files are created in
  133.     RAM:, then ensure that these files are copied to a disk for a permanent
  134.     record.
  135.  
  136.     The ".data" file is almost totally ASCII (the only exception being the
  137.     odd CHR$(12) used for page formating), and, if you feel comfortable
  138.     doing so, may be edited with a good text editor.  This, of course,
  139.     excludes Commodore's "Ed", which will not accept binary.
  140.  
  141.     The ".datavar" file should never be edited.  If you do so, any further
  142.     .data files will almost certainly be garbage.
  143.     
  144.     Open Loans 
  145.  
  146.     The Open-type file will be built one entry at a time, using the data
  147.     entered.  This option is good for Open Mortgages, Line of Credit type
  148.     loans, or any loan that does not have a Fixed repayment schedule.
  149.     This file cannot "think ahead", because it cannot predict when your
  150.     payments will be made, or exactly how large or how small they will be.
  151.     Once a data entry (payment) has been made, you have the option of
  152.     making another <Press any key>, totaling the file <Left Alternate-
  153.     Shift-T>, or returning to the Main Menu <Escape>.  <Left Alternate-
  154.     Shift-T> merely prints a footnote to the file, stating your Total
  155.     Payments so far and by how much the Principal was reduced, and then
  156.     returns you to the Main Menu.  It is intended to be used after the last
  157.     payment is made, but may be used beforehand.
  158.     
  159.     Fixed Loans 
  160.  
  161.     The Fixed-type file will take all the parameters pertinent to your
  162.     loan, and then display some summary information about your loan;
  163.     ie. the Unit Payment (Installment), the Total Interest to be paid,
  164.     the Actual (Effective) Interest Rate, and the Amortization Period.
  165.     You may then Return to the Main Menu, Re-enter data, or request the
  166.     Amortization Table.  In the last case you will be prompted for the
  167.     number of months you want the Table shown.  The Amortization Table will
  168.     be shown for any period from one month, to the Amortization Period
  169.     of the loan.
  170.     
  171.     Lump Sum Payments in a Fixed Loan 
  172.  
  173.     If you are allowed to make Lump Sum payments to your Fixed loan, then
  174.     request the Amortization Table for the number of months such that the
  175.     last payment displayed is the date on which the Lump Sum payment is to
  176.     be made.  Then use the <L> option to show your Lump Sum Payment, and
  177.     the Principal reduction will be made on that date.  Since all payments
  178.     must be made in chronological order, once the Amortization Table has
  179.     been displayed for a month beyond one in which you want to make a
  180.     Lump Sum payment, you would have to go back to Selection 3, and
  181.     re-select the number of months to display, in order to make the
  182.     Lump Sum payment.
  183.  
  184.     If you wish to increase the balance for any reason (sort of a reverse
  185.     Lump Sum payment), it is done in a similar manner, except that you
  186.     merely enter the amount as a negative number.  EG, to add $300
  187.     to the balance, display the Amortization Table to the date of the
  188.     payment, and press <L>.  When prompted for the amount of the payment,
  189.     just press the Minus key, and "300".  When the balance in increased for
  190.     any reason, you will be given the option of entering a short comment
  191.     of 44 characters or less, which will appear in the Table.  This can be
  192.     used to indicate the reason for the balance increase.  If the comment
  193.     is less than 20 characters, the whole transaction will remain on one
  194.     line.  Otherwise, it will be split over two lines.
  195.     
  196.     2.  Enter a Payment to an Existing Open-type File 
  197.  
  198.     This item is used to enter more payments to an Open Mortgage/Loan
  199.     file which has already been opened with Selection 1.  Although there is
  200.     a provision to make lump payments on a Fixed-type loan, that is not
  201.     done using this Menu item.  Note that if you are updating a file, the
  202.     "Filename.datavar" file must be situated in the same directory as the
  203.     "Filename.data" file.
  204.  
  205.     As described above, a "negative" payment may also be made to an Open
  206.     loan, which will be shown in your .data file.   Negative payments will
  207.     always occupy two lines in Open loan files.
  208.     
  209.     3.  Re-Calculate the Current Fixed-type Loan 
  210.  
  211.     This item is for Fixed-type loans only.  If you have already entered
  212.     the Mortgage/Loan parameters (Principal, Interest Rate, Commencement
  213.     Date, Interest Compound Period and Filename), then LC will ask for
  214.     confirmation of these numbers, and request the Payment Frequency and
  215.     the Amortization Period/Monthly Payment.  Any changes to these
  216.     parameters may be made at this time.  In this way, the same numbers can
  217.     be quickly "fiddled" to show various combinations of these variables.
  218.     This feature cannot be used for Open-type loans for the reason
  219.     mentioned above - Open loan payments cannot be predicted.
  220.     
  221.     4.  View/Print a Data File 
  222.  
  223.     This item will ask for the filename of the ".data" file you want to
  224.     View or Print.  Select the path and "Filename.data" in the requester.
  225.     The program will not accept any filename which does not end in ".data".
  226.     The file will then be loaded into the MuchMore file viewer, where
  227.     you may then see the file almost exactly as it will look when printed,
  228.     (the printed version will be page formated).   The data you see in this
  229.     file is the same data that was printed to the screen while the
  230.     calculations were being made.  Therefore, IF IT WASN'T SHOWN ON THE SCREEN
  231.     AT THAT TIME, THEN IT WON'T BE IN THE DATA FILE.  So if you want to see
  232.     the whole Amortization Table in the data file, press <Return> when
  233.     prompted "Amortization Table for how many months", so that the whole
  234.     Table will be calculated and displayed.
  235.  
  236.     Probably the easiest way to view forward and backward is by using the
  237.     Left and Right Mouse Buttons.
  238.  
  239.     File printing is also done from within the MuchMore file viewer.
  240.     To print the entire file you are looking at, simply press
  241.     <Left Alternate-Shift-O> together, and the file will be sent to
  242.     whichever printer you have selected in Preferences.  If desired, it is
  243.     also possible to print out only a portion of the data file.  Please
  244.     read the "MuchMore.ReadMe" file for full information.
  245.     
  246.     5.  Information 
  247.  
  248.     This just recaps a bit of the information in this file, in case
  249.     nobody reads it.
  250.     
  251.     6.  About 
  252.  
  253.     Tells you who not to blame if something goes wrong.
  254.     
  255.     7.  Help  (or <Help> key) 
  256.  
  257.     Pressing the <Help> key will run the MuchMore file viewer, and, if
  258.     LoanCalc.doc (this file) is in the Current Directory, it will be
  259.     automatically loaded.  Therefore the doc file can easily be referenced
  260.     without having to Quit LoanCalc.  If it is not in the Current Directory
  261.     the MuchMore File Requester will appear.
  262.     
  263.     8.  Quit  (or <Esc>) 
  264.  
  265.     Exits the program, after confirmation.
  266.  
  267.  
  268.     4   SAMPLE DATA FILES 
  269.  
  270.     I have included with this program 4 sample ".data" files to give you an
  271.     idea of what your print-out will look like.  The 4 files represent the
  272.     same $50,000 mortgage, with an Interest Rate of 10.25%, amortized over
  273.     5 years, and includes one lump sum payment made on the second
  274.     anniversary of the loan.  One shows the Amortization Table if you had
  275.     chosen to repay the mortgage with Monthly payments, another with Semi-
  276.     Monthly payments, and the others with Bi-Weekly and Weekly payments.
  277.  
  278.     Note that these are sample print-outs only.  These files cannot be
  279.     re-worked using Main Menu item 3, as their ".datavar" files are not
  280.     included here.
  281.  
  282.  
  283.     5   THE INTEREST COMPOUND PERIOD 
  284.  
  285.     Although LC will accept an I.C.P. of almost any frequency, the standard
  286.     frequencies appear to be as follows, and should be used unless you know
  287.     that your situation is different:
  288.  
  289.     Canadian Mortgages are compounded Semi-Annually.
  290.  
  291.     American Mortgages and both Canadian and American bank loans are
  292.     compounded Monthly.  Very few bank employees seem to know this - during
  293.     my enquiries I got a lot of different answers, but the hard figures
  294.     always came down to "Monthly Compounded Interest".  This information is
  295.     also shown in the program.
  296.  
  297.  
  298.     6   CALCULATION OF THE PAYMENT DATE 
  299.  
  300.     The "Payment" date shown for each payment will depend on the type of
  301.     Mortgage/Loan you select, as follows:
  302.       
  303.       Open Mortgages: 
  304.       will naturally show the payment on whatever date you enter.
  305.       
  306.       Fixed Mortgages: 
  307.       The first payment to a mortgage is normally due one payment period
  308.       after the commencement of the loan.  Therefore - 
  309.  
  310.       If you choose to make Monthly Payments, then the payments will be
  311.       shown as due on the day of the month that the loan was taken out.
  312.       So if you want payments due on the 1st of the month, show the loan as
  313.       starting on the 1st day of the previous month.  
  314.  
  315.       Semi-Monthly Payments are always shown as due on the 1st and 15th day
  316.       of the month.
  317.  
  318.       Bi-Weekly Payments are shown as first due 14 days after the starting
  319.       date of the loan, and due every 14 days thereafter.
  320.  
  321.       Weekly Payments are shown as first due 7 days after the starting date
  322.       of the loan, and due every 7 days thereafter.
  323.  
  324.  
  325.     7   PROGRAM REQUIREMENTS 
  326.  
  327.     Workbench 1.3 or greater is required because of the math libraries.
  328.  
  329.     The arp.library is required because of the ARP requester.
  330.  
  331.     MuchMore is required for file viewing or printing.
  332.  
  333.  
  334.     8   PROGRAM LIMITATIONS 
  335.  
  336.     Some limitations of LC are:
  337.  
  338.     All Open Loan data entries MUST be in chronological order.  
  339.  
  340.     Also, with Open Loans, a data entry must be made every 6 months or so.
  341.     This as necessary to keep the year-ends straight, so that LC knows
  342.     which are leap-years.  (The formula is slightly different in
  343.     leap-years).
  344.  
  345.  
  346.     9   ERROR MESSAGES 
  347.  
  348.     FILE ALREADY OPEN!
  349.  
  350.     This error mesage will occasionally pop up while LC is trying to open
  351.     a ".data" or ".datavar" file.  As all of my OPEN commands are
  352.     immediately preceded by a CLOSE command on the same line, this should
  353.     be impossible, but it does happen.  At any rate, I built a RESET
  354.     command into the Error Handler, which seems to work well enough to
  355.     allow the file to be rebuilt from Menu Item 3, rather than have to
  356.     start from scratch at Menu Item 1.
  357.  
  358.     FILE NOT FOUND!
  359.  
  360.     If this message appears during program startup, then most probably
  361.     the "arp.library" is not in the LIBS: directory.
  362.  
  363.     If it appears after seleting View/Print a Data File from the Main Menu,
  364.     then most probably LoanCalc cannot find either MuchMore, or the
  365.     .datavar file that goes with the selected .data file.
  366.  
  367.     ILLEGAL FUNCTION CALL!
  368.  
  369.     I got this message once when I was specifying a monthly payment for a
  370.     Fixed loan that was lower than the Interest payment.  In other words,
  371.     the loan would never have been paid off at that monthly payment.
  372.  
  373.     INPUT PAST END!
  374.  
  375.     There are two possible explanations for this message.  The most likely
  376.     is that you are trying to open a ".datavar" file that was created using
  377.     LoanCalc V1.x.  Unfortunately, these files are not compatible with
  378.     LoanCalc V2.x.  The ".data" files are still correct, but if you want
  379.     to re-calculate a loan (ie. with Menu item 3), the loan data will have
  380.     to be re-entered with Menu item 1, which will build a new and
  381.     compatible ".datavar" file.
  382.  
  383.     The second possibility is that the applicable ".datavar" file has
  384.     somehow become corrupted, in which case also, the data will probably
  385.     have to be re-entered.
  386.  
  387.  
  388.     10   ACCURACY 
  389.  
  390.     To the best of my knowledge, this program is now as accurate as any
  391.     other similar programs available.  Monthly payment figures seem to
  392.     agree with those found in commercial Amortization Tables.
  393.  
  394.  
  395.     11   FILES INCLUDED WITH THIS PROGRAM 
  396.  
  397.     LoanCalc
  398.     LoanCalc.doc
  399.     Revision_History
  400.     Monthly.data
  401.     Semi-Monthly.data
  402.     Bi-Weekly.data
  403.     Weekly.data
  404.     MuchMore
  405.     MuchMore.ReadMe   - The documentation for MuchMore.
  406.     MuchMore.LiesMich - The documentation for MuchMore, in German.
  407.     arp.library V39.1 - in case there is still someone out there who is not
  408.                         utilizing this marvelous library.  Just put it in
  409.                         your LIBS: directory, and leave it there.
  410.     plus appropriate .info files.
  411.  
  412.  
  413.     Any comments, problems or bug reports are welcome.  Please send to:
  414.  
  415.  
  416.                             Robert Bromley
  417.                             1168 Timber Lane
  418.                             Victoria,   B.C.
  419.                             CANADA   V8Y 1E4
  420.  
  421.  
  422.     Hope someone finds this useful.
  424.           __
  425.          /_/  __   /_
  426.      _  /_/  /_/  /_/  _ 
  427.  
  428.