Calculates and returns detailed amortization payment schedules for a loan. The API supports the following scenario types: ActualCase, BestCase, and WorstCase. In addition, the API supports Complete and Yearly schedule formats, providing comprehensive payment breakdowns including principal, interest, mortgage insurance, and balances over the loan term.

This API added with the 26.2 release of Encompass.

Usage Notes

• This API accepts either the loanId query parameter OR loan object in the request body. Note: At least one required. If both missing, API returns HTTP 400 Bad Request.
• Multiple Scenarios: The API returns ActualCase by default when scenarios not provided. The BestCase and WorstCase available for non-fixed loans.
• Fixed vs Non-Fixed Loans: For Fixed amortization types, all scenarios return the same schedule since payment schedules don't change across scenarios.
• Schedule Types: Complete returns all payment periods. Yearly returns annual summaries. Note: When schedules is not provided, API returns both Complete and Yearly schedules.
• Note: Duplicate values in scenarios or schedules array return HTTP 400 Bad Request.
• Mortgage Type Support: Standard fields plus USDA and FHA-specific fields.
• Payment Frequency: Supports Monthly (12 payments/year) and Biweekly (26 payments/year).