Deactivate loan

Loan accounts have an activation status to determine whether the calculator should run on the account. By default, a loan is not activated when it's created; but a loan can be deactivated after it has been activated. Deactivating a loan allows you to use the POST update loan setup values request within the LoanSetup object. Note the following when deactivating a loan:

This request pauses the LoanPro calculator for the loan account. Loan values will no longer update daily and the loan functions as though it's not aware of dates.

Deactivating a loan updates the "active" field within the LoanSetup object that's nested within the Loans entity. An deactivated loan will have a "active" value of 0 instead of 1.

For an example of how loan activation works within the UI, take a look at our Setting up a loan article.

💭 Are deactivated loans included in my billable accounts?

Yes. However, you can use the PUT archive loan request to exclude it from your billable accounts.

Database

For information regarding loan database tables, see the following articles:

Database – Loan Table (loan_entity)

Database – Loan Setup (loan_setup_entity)

Database – Loan Status Entity (loan_status_entity)

{
    "LoanSetup": {
        "active": 0,
        "__id": 11670,
        "__update": true
    }
}