API – Loan Settings
Introduction
Loan settings are options that do not directly affect the calculations of a loan. These allow you to configure a loan's fee options, credit reporting options, agent user, and more. You can configure loan settings either within the UI or in the API, which this article covers. To edit loan settings, you will first need to create a loan.
To see the details of this request (and even try a sample request), take a look at our dedicated API docs:
Adding and Editing Loan Settings
To add loan settings to a loan or edit them, send a PUT request to the URL of the desired loan:
PUT https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(515)
You will need to include the loan's system ID in the endpoint. In the example above, we are editing a loan whose ID is 515.
Request Body
The request body will be formatted as follows:
{
"LoanSettings": {
"MerchantProcessorGroup": {},
"id": 1562,
"loanId": 2893,
"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,
"displayId": "2893",
"repo": false,
"closed": false,
"liquidation": false,
"paymentTypeDefaultText": "Company Default",
"CustomFieldValues": {
"results": []
},
"__id": 1562,
"__update": true
},
"CustomFieldValues": {},
"Portfolios": {
"results": [
{
"__metadata": {
"uri": "/api/1/odata.svc/Portfolios(id=39)",
"type": "Entity.Portfolio"
}
}
]
},
"SubPortfolios": {
"results": [
{
"__metadata": {
"uri": "/api/1/odata.svc/Portfolios(id=40)",
"type": "Entity.SubPortfolio"
}
}
]
},
"StopInterestDates": {
"results": []
},
"displayId": "2893"
}Here's a breakdown of the fields used in the payload above:
- loanId – This is the ID of the associated loan.
- cardFeeAmount – This is the flat fee amount for processing a card.
- cardFeeType – The type of the card fee. See Loan Settings Collections for more information.
- cardFeePercent – This is the percentage used for calculating the fee amount.
- agent – This is the ID of the assigned agent user.
- loanStatusId – This is the ID of the corresponding Loan Status.
- loanSubStatusId – This is the ID of the corresponding Loan Sub-Status.
- sourceCompany – This is the ID of the source company that the loan is linked to.
- paymentTypeDefault – This determines the default payment type (principal only, fees only, etc.). This field allows you to set a default that is specific to this loan, but you can also set it to zero to leave it as your company default. This list comprises both LoanPro default types and any custom types that you've created, and a full list is available within Settings > Loan > Payments > Types.
- eBilling – This determines whether the loan is marked for eBilling. See Loan Settings Collections for more information.
- ECOACode – This is the ECOA code to use for credit reporting for the primary borrower. See Loan Settings Collections for more information.
- coBuyerECOACode – This is the ECOA code to use for credit reporting for the secondary borrower. See Loan Settings Collections for more information.
- creditStatus – This is the credit status for the account. See Loan Settings Collections for more information.
- creditBureau – This is the type of loan to report to the Credit Bureau. See Loan Settings Collections for more information.
- reportingType – This is the reporting type for reporting credit. See Loan Settings Collections for more information.
- secured – This determines whether the loan is secured. 1 indicates yes; 0 no.
- autopayEnabled – This determines whether or not AutoPays will be processed.
- repoDate – This is the date of repossession, formatted as (YYYY-MM-DD).
- closedDate – This is the date the loan was closed, formatted as (YYYY-MM-DD).
- liquidationDate – This is the date the loan was liquidated, formatted as (YYYY-MM-DD).
- followUpDate – This sets when the loan should be followed up on, formatted as (YYYY-MM-DD).
- isStoplightManuallySet – This determines whether the stoplight was manually set. 1 indicates yes; 0 no.
- merchantProcessorGroupId – This is the ID for the merchant processor group. If left blank, the default group will be applied.
- displayId – This is the display ID of the loan.
- repo – This determines whether the collateral has been repossessed.
- closed – This determines whether the loan account has been closed.
- liquidation – This determines whether the account has been liquidated.
- paymentTypeDefaultText – This determines the text associated with the paymentTypeDefault field.