Tools: Transient Calculator

Use the Loan Calculations API to preview loan calculations for a specified loan. This API calculates fields similar to the calculations performed in Update Loan, however, the transient calculations provide a preview and do not save to the loan file.

Loan Calculation Object

The following attributes are contained within the loanCalculationRequestBody object.

ATTRIBUTEDESCRIPTION
loanId
string
The unique identifier of the loan.


loanData
object
Provides the loan contract from which to calculate data.


entities
array of strings
List of loan entities. Refer to Get Supported Entities to view the list of loan entities that can be retrieved from a loan.
calcAllOnly
boolean
Indicates whether calculations will be executed for all fields. The default is true.