curatedapi
Browse the docs

Guides

Finance

Excel functions

Late payments

E-invoices

Accounting

Number checks

VAT and GST

Billing and pricing

Money and currencies

Dates and time

Math

Unit conversion

Everyday

Health

Excel PPMT function: principal part of a payment API

The principal repaid in one period of a loan, the same as Excel's PPMT.

POST https://api.curatedapi.com/v1/calc/excel/ppmt

PPMT(rate, per, nper, pv, [fv], [type]) = PMT − IPMT for that period.

Formula

PPMT = PMT − IPMT
  • 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.

Inputs

Send numbers as strings to keep every digit. options sets precision and rounding (see numbers and rounding).

InputTypeDescription
rate required decimal (string) 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. Allowed: > -1 and <= 1000.
per required decimal (string) The period you want, from 1 to nper. A ratio of two decimals such as "0.08/12" is accepted. Allowed: >= 1 and <= 12000.
nper required decimal (string) Total number of payment periods. A ratio of two decimals such as "0.08/12" is accepted. Allowed: > 0 and <= 12000.
pv required decimal (string) Present value: the amount now (a loan you receive is positive). A ratio of two decimals such as "0.08/12" is accepted. Allowed: >= -1000000000000000 and <= 1000000000000000.
fv decimal (string)
default 0
Future value wanted after the last payment. A ratio of two decimals such as "0.08/12" is accepted. Allowed: >= -1000000000000000 and <= 1000000000000000.
type integer
default 0
When payments are due: 0 at the end of each period, 1 at the beginning. Allowed: >= 0 and <= 1.
options.rounding half_even | half_up | half_down | up | down | ceiling | floor Rounding mode applied once to each result. Default half_even.
options.decimals integer Round results to this many digits after the decimal point.
options.significant_digits integer Round results to this many significant digits.

Result

Under result in the answer, next to exactness, precision, inputs, formula, references and warnings.

ResultTypeDescription
ppmtdecimal (string)The principal repaid in that period.

Examples

Microsoft's example: month 1 of a 2-year $2,000 loan at 10%

Requestcurl
curl https://api.curatedapi.com/v1/calc/excel/ppmt \
  -H "Authorization: Bearer $CURATEDAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "rate": "0.10/12",
    "per": "1",
    "nper": "24",
    "pv": "2000",
    "options": {"decimals": 2}
  }'
200 OKResponse
{
  "calculator": "excel/ppmt@1",
  "result": {
    "ppmt": "-75.62"
  },
  "exactness": {
    "ppmt": "rounded"
  },
  "precision": {
    "rounding": "half_even",
    "decimals": 2
  },
  "inputs": {
    "rate": "1/120",
    "per": "1",
    "nper": "24",
    "pv": "2000",
    "fv": "0",
    "type": 0
  },
  "formula": "PPMT = PMT − IPMT",
  "references": [
    {
      "title": "Microsoft Excel PPMT function",
      "url": "https://support.microsoft.com/en-us/excel/functions/ppmt-function"
    }
  ],
  "warnings": []
}

Microsoft's example: year 10 of a 10-year $200,000 loan at 8%

Requestcurl
curl https://api.curatedapi.com/v1/calc/excel/ppmt \
  -H "Authorization: Bearer $CURATEDAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "rate": "0.08",
    "per": "10",
    "nper": "10",
    "pv": "200000",
    "options": {"decimals": 2}
  }'
200 OKResponse
{
  "calculator": "excel/ppmt@1",
  "result": {
    "ppmt": "-27598.05"
  },
  "exactness": {
    "ppmt": "rounded"
  },
  "precision": {
    "rounding": "half_even",
    "decimals": 2
  },
  "inputs": {
    "rate": "0.08",
    "per": "10",
    "nper": "10",
    "pv": "200000",
    "fv": "0",
    "type": 0
  },
  "formula": "PPMT = PMT − IPMT",
  "references": [
    {
      "title": "Microsoft Excel PPMT function",
      "url": "https://support.microsoft.com/en-us/excel/functions/ppmt-function"
    }
  ],
  "warnings": []
}

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.

Errors share one format; see errors. Billing, retries and batches work the same for every endpoint.