Utilities

Solve a time-value-of-money problem

Relates the five standard variables (rate, nper, pmt, pv, fv) and solves for the one named in solve_for given the other four. Sign convention: cash you pay out is negative, cash you receive is positive. rate is the interest rate per period; nper is the number of periods. Deterministic.

post/v1/tvm

Request

  • Base URL: https://api.numeratica.com
  • URL: https://api.numeratica.com/v1/tvm
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

solve_for'fv' | 'pv' | 'pmt' | 'rate' | 'nper' required

Which variable to solve for. The other four must be supplied.

ratenumber

Interest rate per period (> -1, magnitude <= 100). Required unless solving for rate.

npernumber

Number of periods (> 0, <= 100000). Required unless solving for nper.

pmtnumber

Payment per period (negative = outflow).

pvnumber

Present value (negative = outflow).

fvnumber

Future value.

payments_at_beginningboolean

If true, payments occur at the start of each period (annuity due).

Example request

{
  "rate": 0.0033333333,
  "nper": 360
}

Response

Solved variables

result_idstring
engine_versionstring
solve_forstring
disclaimerstring

Example response

{
  "result_id": "tvm_1a2b3c4d5e6f7a8b",
  "engine_version": "tvm-1.0.0",
  "solve_for": "pmt",
  "inputs": {
    "rate": 0.0033333333,
    "nper": 360
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.