LoanPro's calculator settings can now be updated at the account level, meaning individual loan accounts can be configured to calculate in different ways. The calculator uses "calc flags" to determine how to calculate loan terms and balances. There are currently eleven different flags.

This article explains how to update a loan account's calculator settings and which calc settings to use depending on the calculation scenario.

Getting started

Before starting, ensure you have valid LMS API credentials for your environment. View the Quickstart Guide 🏁 to generate new credentials.

ℹ️

Ensure your API token has access to the LoanCalcSettings endpoint.

LoanPro's Role-Based Access Controls (RBAC) allow you to determine which API endpoints and HTTP methods are available for individual bearer tokens.

Before moving on, ensure your token has access to the LoanCalcSettings endpoint by navigating to Settings > Company > Access > Role-Based Access within the LoanPro UI to view and update access settings.

To learn more, view Creating Agent User-Based Access ↗

The LoanCalcSettings entity

Loan calc settings are stored within the LoanCalcSettings entity. This entity is not stored within the Loans entity, meaning loan calc settings cannot be found by sending a GET request to the /Loans endpoint.

Loan calc settings may or may not exist on a loan account depending on when the loan was created. If they do not exist for a given loan, they can manually added. To do so, send a POST /LoanCalcSettings request ↓

Here's a sample of the information stored within the LoanCalcSettings entity:

{
    "d": {
        "results": [
            {
                "__metadata": {
                    "uri": "https: //loanpro.simnang.com/api/public/api/1/odata.svc/LoanCalcSettings(id=80)",
                    "type": "Entity.LoanCalcSettings"
                },
                "id": 80, //<---- LoanCalcSettingsId
                "entityId": 3535, //<---- LoanId
                "entityType": "Entity.Loan",
                "setting": "roll-schedule-interest-only-with-irc", //<---- Calc flag
                "value": "1",
                "modified": "/Date(1744833606)/",
                "modifiedBy": 19327
            }
        ],
        "summary": {
            "start": 0,
            "pageSize": 50,
            "total": 1
        }
    }
}

Available calc flags

Calc flags are enumerated values that represent different calculator settings. Here's a breakdown of available flag options and how they affect loan calculations:

Updating a loan's new calc settings

Updating a loan's calc settings involves the following steps:

1. Send GET /LoanCalcSettings request to retrieve existing configuration information
2. Send POST /LoanCalcSettings request (if the loan has no existing settings configuration)
3. Send PUT /LoanCalcSettings request to update configuration

1. Retrieve existing configuration information

To update a loan account's calc settings, first determine if settings exist for the account. Send a GET request with a $filter param that references the ID of the loan:

curl --request GET \
     --url {baseUrl}/odata.svc/LoanCalcSettings?$filter=entityId eq {loanID} \
     --header 'Authorization: Bearer {token}' \
     --header 'Autopal-Instance-Id: {tenant ID}' \
     --header 'content-type: application/json' \
     --data ''

If the account has no existing loan calc settings configuration, the response will return no results:

{
    "d": {
        "results": [],
        "summary": {
            "start": 0,
            "pageSize": 50,
            "total": 0
        }
    }
}

In this scenario, send a POST /LoanCalcSettings request to create a configuration.

If the account has existing configuration data, the response will return the following:

{
    "d": {
        "results": [
            {
                "__metadata": {
                    "uri": "https://loanpro.simnang.com/api/public/api/1/odata.svc/LoanCalcSettings(id=1)",
                    "type": "Entity.LoanCalcSettings"
                },
                "id": 1,
                "entityId": 11115,
                "entityType": "Entity.Loan",
                "setting": "balance-lessthan-pmtamt",
                "value": "1",
                "modified": "/Date(1745000600)/",
                "modifiedBy": 12926
            }
        ],
        "summary": {
            "start": 0,
            "pageSize": 50,
            "total": 1
        }
    }
}

This response returns an ID that represents existing loan calc settings. The ID is stored within the "id" field (d.results[0].id), and it's used to update a loan's calc settings in subsequent requests. We'll reference this ID as {loan-calc-settings-id}.

In this scenario, send a PUT /LoanCalcSettings request to update an existing configuration.

2. Send POST request to create loan calc settings object

ℹ️

This request is only necessary if the loan account has no existing loan calc settings configuration

If a settings configuration already exists, skip to step 3.

To create a loan account's calc settings configuration, send a POST request:

curl --request POST \
     --url {baseUrl}/odata.svc/LoanCalcSettings \
     --header 'Authorization: Bearer {token}' \
     --header 'Autopal-Instance-Id: {tenant ID}' \
     --header 'content-type: application/json' \
     --data '
     {
        "entityId": {{loan-id}}, 
        "entityType": "Entity.Loan",
        "setting": "{{calc-flag}}",
        "value": 1
}
'

Here's a breakdown of the body params included in this request:

A successful request will return the following response structure:

{
    "d": {
        "__metadata": {
            "uri": "https://loanpro.simnang.com/api/public/api/1/odata.svc/LoanCalcSettings(id=2)",
            "type": "Entity.LoanCalcSettings"
        },
        "id": 2,
        "entityId": 10011,
        "entityType": "Entity.Loan",
        "setting": "balance-lessthan-pmtamt",
        "value": "1",
        "modified": "/Date(1745945901)/",
        "modifiedBy": 12926
    }
}

This request returns an ID that represents the newly created loan calc settings. The ID is stored within the "id" field (d.results.id), and it's used to update a loan's calc settings if desired. We'll reference this ID as {loan-calc-settings-id}.

3. Send PUT request to update settings

To update existing loan calc settings configurations, send a PUT request that includes the loan calc settings ID as a path parameter and the new settings within the payload body:

curl --request PUT \
     --url {baseUrl}/odata.svc/LoanCalcSettings({loan-calc-settings-id}) \
     --header 'Authorization: Bearer {token}' \
     --header 'Autopal-Instance-Id: {tenant ID}' \
     --header 'content-type: application/json' \
     --data '
     {
        "entityId": {{loan-id}}, 
        "entityType": "Entity.Loan",
        "setting": "{{calc-flag}}",
        "value": 1
}
'

Here's a breakdown of the body params included in this request: