This request allows you to target an APR amount by changing a loan's escrow settings.
General
LoanPro features a targeting tool that allows you to adjust escrow to reach a specific APR. Here's what you need to know about this request:
- APR is calculated via a number of factors, but this tool will adjust the loan's interest rate to reach the desired APR.
- The targeting tool can only be used on accounts that are not activated.
- To use this request, the loan must also have an Escrow Buckets configuration set on the loan. The ID of the bucket is used in the
solveparameter.
For more information regarding this request, see our API – APR Targeting article on our help site.
For an example of how targeting APR works within the UI, take a look at our APR Targeting article.
Pay special attention to the endpoint of this request.
This request does not use OData, so it's not included in the endpoint like most other LMS requests.
Database
For information on loan setup database tables, see the following articles:
- Database – Loan Setup (loan_setup_entity)
- Database – Loan Table (loan_entity)
- Database – Escrow calculator (escrow_calculator_entity)
- Database – Escrow Subset Entity (escrow_subset_entity)
{
"apr": "24.87",
"solve": 1
}
Try It Instructions
Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is ready for you—hit Try It to send the request.
However, if you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.