Create New Loan

post https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans()

This request creates a new loan.

General

Loans can be configured in limitless ways. However, not every field within the payload of this request is required, and some are more important than others. Here is what you need to know about this request:

  • When creating loans, you can add objects that hold specific information. For example, you can create a loan and associate Collateral, Escrow, Customers, and more by adding their respective objects. This is optional, and we explain how these objects are formatted elsewhere in this documentation. For an example of how you can include multiple objects in a request to create a new loan, take a look at the sample payloads below.
  • Many users desire to link a customer when they create a new loan within one request. This is possible, and we have included an example of how to do so below. To create a loan and link a customer within one request, you will need to use an existing customer or create a new customer beforehand. Here's why:

    When you create a new loan and link a customer within the same request, you use the customer's ID in the payload and send the request through the Loans endpoint. Therefore, you will need a valid customer ID since you can't create a customer via the Loans endpoint.

For an example of how creating a loan works within the UI, take a look at our Create New Loan article.

Database

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

{
  "displayId": "New Loan Display ID",
  "LoanSetup": {
    "loanAmount": "10000.00",
    "discount": "500.00",
    "underwriting": "0.00",
    "loanRate": "12.0212",
    "loanRateType": "loan.rateType.annually",
    "loanTerm": "36",
    "contractDate": "2015-05-07",
    "firstPaymentDate": "2015-05-08",
    "amountDown": "0.00",
    "reserve": "5.00",
    "salesPrice": "12000",
    "gap": "1120.",
    "warranty": "2500",
    "dealerProfit": "1000",
    "taxes": "125.25",
    "creditLimit": "15500",
    "loanClass": "loan.class.carLoan",
    "loanType": "loan.type.installment",
    "scheduleTemplate": "0",
    "discountSplit": "1",
    "paymentFrequency": "loan.frequency.monthly",
    "calcType": "loan.calcType.simpleInterest",
    "daysInYear": "loan.daysInYear.frequency",
    "interestApplication": "loan.interestApplication.betweenTransactions",
    "begEnd": "loan.begend.end",
    "firstPeriodDays": "loan.firstPeriodDays.frequency",
    "firstDayInterest": "loan.firstdayinterest.yes",
    "discountCalc": "loan.discountCalc.rebalancing",
    "diyAlt": "loan.diyAlt.no",
    "daysInPeriod": "loan.daysinperiod.24",
    "roundDecimals": "5",
    "lastAsFinal": "loan.lastasfinal.no",
    "curtailPercentBase": "loan.curtailpercentbase.loanAmount",
    "nddCalc": "loan.nddCalc.standard",
    "endInterest": "loan.endInterest.no",
    "feesPaidBy": "loan.feesPaidBy.date",
    "graceDays": "5",
    "lateFeeType": "loan.lateFee.3",
    "lateFeeAmount": "30.00",
    "lateFeePercent": "10.00",
    "lateFeeCalc": "loan.lateFeeCalc.standard",
    "lateFeePercentBase": "loan.latefeepercentbase.regular",
    "paymentDateApp": "loan.pmtdateapp.actual",
    "maxInterestAmount": "0", 
    "financeChargeAsMIA": 1
  }
}

// This payload uses the tenant Loan Defaults to input the remaining loan information.

{
  "displayId": "New Loan Display ID",
  "LoanSetup": {
    "loanAmount": "10000.00",
    "loanRate": "4.5",
    "loanClass": "loan.class.carLoan",
    "loanType": "loan.type.installment",
    "contractDate": "2022-05-07",
    "firstPaymentDate": "2022-05-14"
  }
}

// This payload uses the tenant Loan Defaults to input the remaining loan information.

{
    "displayId": "New Loan Display ID",
    "LoanSetup": {
        "loanAmount": "10000.00",
        "loanRate": "4.5",
        "loanClass": "loan.class.carLoan",
        "loanType": "loan.type.installment",
        "contractDate": "2022-05-07",
        "firstPaymentDate": "2022-05-14"
    },
    "Customers": { // 👈 This object will link a customer to the loan.
        "results": [
            {
                "__id": 873,
                "__setLoanRole": "loan.customerRole.primary"
            }
        ]
    }
}

// This payload includes multiple objects that hold information detailed in other pages of our documentation.

{
    "displayId": "New Loan Display ID",
    "LoanSetup": {
        "loanAmount": "10000.00",
        "discount": "500.00",
        "underwriting": "0.00",
        "loanRate": "12.0212",
        "loanRateType": "loan.rateType.annually",
        "loanTerm": "36",
        "contractDate": "2022-02-17",
        "firstPaymentDate": "2022-03-17",
        "amountDown": "0.00",
        "reserve": "5.00",
        "salesPrice": "12000",
        "gap": "1120",
        "warranty": "2500",
        "dealerProfit": "1000",
        "taxes": "125.25",
        "creditLimit": "15500",
        "loanClass": "loan.class.carLoan",
        "loanType": "loan.type.installment",
        "scheduleTemplate": "0",
        "discountSplit": "1",
        "paymentFrequency": "loan.frequency.monthly",
        "calcType": "loan.calcType.simpleInterest",
        "daysInYear": "loan.daysInYear.frequency",
        "interestApplication": "loan.interestApplication.betweenTransactions",
        "begEnd": "loan.begend.end",
        "firstPeriodDays": "loan.firstPeriodDays.frequency",
        "firstDayInterest": "loan.firstdayinterest.yes",
        "discountCalc": "loan.discountCalc.rebalancing",
        "diyAlt": "loan.diyAlt.no",
        "daysInPeriod": "loan.daysinperiod.24",
        "roundDecimals": "5",
        "lastAsFinal": "loan.lastasfinal.no",
        "curtailPercentBase": "loan.curtailpercentbase.loanAmount",
        "nddCalc": "loan.nddCalc.standard",
        "endInterest": "loan.endInterest.no",
        "feesPaidBy": "loan.feesPaidBy.date",
        "graceDays": "5",
        "lateFeeType": "loan.lateFee.3",
        "lateFeeAmount": "30.00",
        "lateFeePercent": "10.00",
        "lateFeeCalc": "loan.lateFeeCalc.standard",
        "lateFeePercentBase": "loan.latefeepercentbase.regular",
        "paymentDateApp": "loan.pmtdateapp.actual",
        "maxInterestAmount": "0",
        "financeChargeAsMIA": 1
    },
    "LoanSettings": {
        "cardFeeAmount": 0,
        "cardFeeType": "loan.cardfee.types.1",
        "cardFeePercent": 0,
        "agent": 0,
        "loanStatusId": 2,
        "loanSubStatusId": 9,
        "sourceCompany": null,
        "paymentTypeDefault": 0,
        "eBilling": 0,
        "ECOACode": "loan.ecoacodes.1",
        "coBuyerECOACode": "loan.ecoacodes.0",
        "creditStatus": "loan.creditstatus.0",
        "creditBureau": "loan.creditbureau.00",
        "reportingType": "loan.reportingtype.I",
        "secured": 1,
        "autopayEnabled": 1,
        "repoDate": "",
        "closedDate": "",
        "liquidationDate": "",
        "followUpDate": "",
        "isStoplightManuallySet": 0,
        "merchantProcessorGroupId": 0,
        "repo": false,
        "closed": false,
        "liquidation": false,
        "paymentTypeDefaultText": "Company Default"
    },
    "Portfolios": {
        "results": [
            {
                "__metadata": {
                    "uri": "/api/1/odata.svc/Portfolios(id=2)",
                    "type": "Entity.Portfolio"
                }
            }
        ]
    },
    "SubPortfolios": {
        "results": [
            {
                "__metadata": {
                    "uri": "/api/1/odata.svc/Portfolios(id=31)",
                    "type": "Entity.SubPortfolio"
                }
            }
        ]
    },
    "Customers": {
        "results": [
            {
                "__id": 292,
                "__setLoanRole": "loan.customerRole.primary"
            }
        ]
    },
    "Collateral": {
        "results": [
            {
                "a": "2020",
                "b": "Honda",
                "c": "Accord",
                "d": "LE",
                "additional": "No Additional Information",
                "collateralType": "collateral.type.car",
                "vin": "1HGES839020812730",
                "distance": "13000",
                "bookValue": "24708.59",
                "color": "Blue",
                "gpsStatus": "collateral.gpsstatus.notinstalled",
                "gpsCode": "NONE",
                "licensePlate": "H3L 6N8",
                "gap": "0",
                "warranty": "0",
                "positionId": 1
            }
        ]
    }
}

📘

Try It Instructions

Our pages often provide sample payload information so that you can try requests yourself. This request is ready for you—expand the object by clicking the "+" symbol and hit the Try It button to send the request.

If you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.

Language
Authorization
Click Try It! to start a request and see the response here!