curatedapi

Excel CUMPRINC function: principal paid between two periods

Total principal repaid from one period to another, as Excel's CUMPRINC.

Interest rate per period, as a decimal (0.005 for 0.5%). Write a monthly rate from an annual one as "0.06/12". A ratio of two decimals such as "0.08/12" is accepted.
Total number of payment periods.
Present value (the loan amount). A ratio of two decimals such as "0.08/12" is accepted.
First period to include (periods start at 1).
Last period to include.
0: payments at the end of each period; 1: at the beginning.
More options: rounding and decimals
Precision and rounding
Rounding mode applied once to each result. Default half_even.
Round results to this many digits after the decimal point.
Round results to this many significant digits.

Examples

Example: Microsoft's example: principal in the second year of a 30-year $125,000 loan

Cumprinc
Total principal over the periods (negative: paid).
-934.1071234 rounded

Rounding: Half even, 7 decimal places. Calculator excel/cumprinc@1.

How it is calculated

Σ PPMT(rate, k, nper, pv, 0, type) for k = start_period … end_period

CUMPRINC(rate, nper, pv, start_period, end_period, type).

  • Arguments are named and ordered as in Excel. Excel computes in binary floating point; this API computes the exact value of the same formula and rounds it once, so it agrees with Excel to the digits Excel can show, and where Excel's own rounding error reaches the 15th digit this answer is the correct one.

References

Results follow each calculator's documented rules and the sources listed. They are not financial, tax or legal advice. Check that the rules fit your case before you rely on a result. See the terms.

Use it from your code

POST /v1/calc/excel/cumprincVersion 1
curl https://api.curatedapi.com/v1/calc/excel/cumprinc \
  -H "Authorization: Bearer $CURATEDAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "rate": "0.09/12",
    "nper": 360,
    "pv": "125000",
    "start_period": 13,
    "end_period": 24,
    "type": 0,
    "options": {"decimals": 7}
  }'
The same call in Python
import os

import requests

payload = {
    "rate": "0.09/12",
    "nper": 360,
    "pv": "125000",
    "start_period": 13,
    "end_period": 24,
    "type": 0,
    "options": {
        "decimals": 7,
    },
}
response = requests.post(
    "https://api.curatedapi.com/v1/calc/excel/cumprinc",
    headers={"Authorization": f"Bearer {os.environ['CURATEDAPI_KEY']}"},
    json=payload,
    timeout=10,
)
print(response.json()["result"])
The same call in JavaScript
const payload = {
    "rate": "0.09/12",
    "nper": 360,
    "pv": "125000",
    "start_period": 13,
    "end_period": 24,
    "type": 0,
    "options": {
        "decimals": 7,
    },
};
const response = await fetch("https://api.curatedapi.com/v1/calc/excel/cumprinc", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CURATEDAPI_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});
console.log((await response.json()).result);

MCP tool calc_excel_cumprinc at https://mcp.curatedapi.com. Inputs, outputs and errors in the API reference.

Put it on your website

<div data-curatedapi-widget="excel/cumprinc" data-key="capi_public_…"></div>
<script src="https://widgets.curatedapi.com/v1/widget.js" async></script>

Use a public key registered for your site. Calculations are billed like API calls. How widgets work.

Related calculators

Get Excel's answer in your own code

Moving a spreadsheet model into an app? The API returns what Excel returns for the same inputs, so your users see the same numbers in both.

Free for up to 1,000 calculations a month. 50,000 calculations a month cost $9.00 on the Starter plan.