Create Loan Modification

This request allows you to create a loan modification.


This request is a bit different from our others listed here in our documentation. Instead of consisting on one request, the loan modification process requires several (pretty exciting, huh?). We'll explain the whole process and provide the requests you will need below. First, let's go over what loan modifications are.

A Loan ModificationModification - Performing a modification on an account is essentially writing a new contract for the account while saving the original loan information and loan history. This tool lets you update settings, numbers, and calculations on an account., like the name implies, is a change made to the settings of a loan. Loan Modifications are more than simple changes to a loan's terms, however; here's what you need to know about creating Loan Modifications:

  • A Loan Modification is a complex change made in the middle of a loan's life; it's essentially a new loan that is placed on top of an old loan.
  • This will fully reset values such as Change Due Dates, Suspend/Resume Interest, Days Past Due, Amount Past Due.
  • Changing loan values that have no effect on the amortization schedule such as sales tax, dealer profit, amount down, custom fields, or due dates should be made in other ways.
  • A Loan Modification can only be made on an activated loan, and the terms of activatedactivated - Activating an account will cause the calculations on the loan to take into account actual dates and payment history. An account that hasn’t been activated exists in an abstract piece of time with no sense of past or future. loans are locked in and only editable via modifications.

Step 1 - Transactions After Modification Date (Optional)

You may find it necessary to modify a loan previous to payments or other transactions, and you may want those transactions to apply after the proposed modification. There is an available endpoint that will show you which loan transactions apply after the proposed modification date. To see this information, send a GET request to the following endpoint:{loanId})/Autopal.PreModTestLoan({modificationDate})

A successful response will look like the following:

            "info":"04/17/2019 Credit/Debit Card"

Step 2 - Modify the Loan

To create a loan modification, send a POST request to the following endpoint:{loanId})/Autopal.CreateModification({modificationDate})

Make sure to replace {loanId} with the ID of the loan you're modifying, and {modificationDate} with the modification date you will use. The date should be formatted as YYYY-MM-DD. If you are opting to have transactions apply after the modification date, you should include a payload that looks something like this:

    "persistentTransactions": {
        "payments": [
    "modificationDate": "2018-12-28"

The persistentTransactions object should contain an array for each transaction type. The array should contain IDs as strings separated by commas (e.g. "1","2","3").

Step 3 - Get Loan Setup ID

Creating a modification will create a new loanSetup entity and assign it to the loan. To update the new loan setup, you will need the ID. To receive the ID, send a GET request to the following endpoint:{loanId})/LoanSetup

Be sure to replace {loanId} with the ID for the loan. The response should look something like this:

      "LoanSetup": {
        "__metadata": {
        "uri": "",
        "type": "Entity.LoanSetup"
      "title":"LN - PHP SDK597f933a295d6",

In the example above, the setupId is 861. Once you have the loanSetup ID, you are ready to set the loan terms of the modification.

Step 4 - Update the Loan Setup

To update the new loan setup, send a PUT request to the following endpoint:{loanId})

Be sure to replace {loanId} with the ID of the loan.

Your payload should look something like the following:

      "id":861, // <--- loan setup id
      "__id":861, // <--- loan setup id
   "__id":702, // <--- loan id

Step 5 - Roll the Payment (Optional)

You may want to roll the payment for the customer so it matches the original payment amount. This achieved by sending a POST request to the following endpoint:{loanID})

Make sure to replace {loanId} with the ID of the loan. Your payload should look something like the following:

  "amount": "100.00",
  "method": "loan.rollPayment.termExact"

Step 6 - Activate the Loan

The last step is to activate the loan. To activate it, send a POST request to the following endpoint:{loanID})/AutoPal.Activate()

Make sure to replace {loanId} with the ID of the loan. No payload is required for this request. If this request is successful, the process of modifying a loan is now complete.


For information on Loan Modification database tables, see the following articles: