API – Suspend Forecast Payments
Introduction
This article explains how to use the API to suspend payments. For more info on the topic and to learn how it works in the UI, see our article on Suspending Payments.
Creating Suspensions
To suspend forecast payments, send a POST request to a URL formatted as follows:
POST https://loanpro.simnang.com/api/public/api/1/Loans(667)/AutoPal.SuspendForecast(2021-07-17)
There are two fields that you will need to update when you try this yourself. The first is the loan ID, which is 667 in this example. The second is the date of the suspension, which is 2021-07-17 in this example.
Clearing Suspensions
To clear a suspended forecast, you'll send a POST request to the same URL but with the date reset to 0 like shown below.
POST https://loanpro.simnang.com/api/public/api/1/Loans(667)/AutoPal.SuspendForecast(0000-00-00)