Record a loan or lease
loan_createRecord a loan or lease and return its id, level payment and effective annual rate. principal_minor, fees and balloon are whole MINOR units; rate_bps is the nominal annual rate in basis points. Free: 3 agreements.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | Default "loan" | |
| name | Yes | What this agreement is, e.g. Van finance or Office lease | |
| note | No | ||
| lender | No | Who the money is owed to | |
| method | Yes | annuity for a level payment, straight-principal for equal principal and a falling payment | |
| currency | Yes | ISO code the agreement is denominated in | |
| rate_bps | Yes | Nominal annual interest rate in basis points. 1200 is 12 percent. Zero is allowed | |
| fees_minor | No | Arrangement fees in whole minor units, paid at drawdown. Default 0 | |
| start_date | Yes | Drawdown date, YYYY-MM-DD. The first payment falls one period after it | |
| compounding | Yes | How often interest compounds | |
| term_periods | Yes | Number of payment periods, not years | |
| balloon_minor | No | Final balloon or residual value in whole minor units, due with the last payment and not inside it. Default 0 | |
| principal_minor | Yes | Amount borrowed, in whole minor units (integer cents). 1,000,000 is EUR 10,000.00 | |
| payment_frequency | Yes | How often a payment falls due |