All Categories > LMS API
How to get started with the LoanPro API.
7 articles by 3 authors
Articles with information regarding the use of Elasticsearch in LoanPro
3 articles by 2 authors
General. Before you can make a payment through the API you must have a loan and a customer set up in LMS. This process is explained here: Create a Loan - Full Process article as well as in the Before…
Updated 1 month ago by Andy
General. Actions and results are a good way to standardize notes, so it can be determined how often specific actions and results occur, and facilitate searches for those actions and results. For more…
Updated 3 months ago by Cole
General. In LoanPro, loans have both an activated and a non-activated state. You can activate a loan either in the UI , or through the API, which is explained in this article. When you first create a…
General. This article assumes that you have an existing loan. If not, see Creating a Loan with the API. LoanPro's latest release includes a breaking change in the use of collateral through the API. N…
Updated 3 weeks ago by Cole
General. You can add insurance to a loan both with the UI , or through the API, which is explained here. This article goes over how to add insurance to an existing loan; if you haven't created a loan…
This article builds on the information from our articles on Nested Entities , API – Updating Entities , and API – Expanding objects. There are many times in which the best, and sometimes only way, to…
LoanPro's July 2021 Update includes military addresses for members of the armed forces serving overseas. General. Many entities will require address information, and this information can be added or…
General. You can log an advancement or credit on a loan either through the UI , or using the API, which is explained here. To create an advancement/credit for a loan, you will need to send a PUT requ…
Updated 3 months ago by Sloan
General. You can change the amount past due (APD) for a loan either within the UI or through the API. In the API, send a PUT request to the URL of the loan. This URL is unique to each loan and contai…
This article catalogues the different values used in API requests relating to AutoPays. For the URL, full body, and some background info on the topic, check out our article on Creating AutoPays in th…
General. These are the options for the bankruptcy collections. For endpoints and payloads, see our article on Bankruptcy in the API. Or, for more general information and how to track bankruptcy in th…
General. At times you may get an error message similar to the following from the API: { "error": { "message":"Transaction warnings found." }, "warnings": [ "Email test@email.com already exists in the…
Updated 1 year ago by Sloan
General. In LoanPro, you can either change a due date within the UI or through the API, which this article covers. To change a due date for a loan, send a PUT request to the URL of the loan. This URL…
Charge Application Type. These are some of the values for Charge Application type, which are used with Creating and Editing Charges , as well as Recurring Charges. loan.latefeeapp.payoff Charge comes…
General. Below is a list of collections options for Adding Collateral to a Loan in the API. For certain fields, one of these options must be sent over in the JSON request. GPS Status. The GPS Status…
General. There are several selection options inside LoanPro that will only allow you to choose from a specific group of values. These groups of values are referred to as collections. LoanPro provides…
Updated 6 months ago by Sloan
General. You can create a bankruptcy filing on a loan either in the UI , or through the API. This article explains the latter. To create a bankruptcy filing on a loan, you will need to send a PUT req…
Updated 3 months ago by Darrin Wray
General. To create a payment profile in LoanPro, you will need to create a customer if the customer the you want to link the payment profile to doesn’t exist. Next, you should create the payment prof…
General. Loans in LoanPro are highly detailed. They include information about insurance , loan settings , loan setup , collateral, etc. As a result, payloads for creating a loan have several sections…
The Source Company Manager and many of its features are new to LoanPro's latest release. For more information, see our main article on the Source Company Manager. General. To create a source company…
Updated 3 weeks ago by Andy
General. Please review this article – The LoanPro API (AutoPays) These articles should be helpful in understanding what an AutoPay is AutoPay Overview , Schedule a New AutoPay. When you create an Aut…
Updated 3 months ago by Andy
General. For some Autopay data exports, query objects are required. Query objects tell the system how to filter the results that it sends back. This article will cover the basics of how to create a q…
General. Creating charges is done through the API by sending a PUT request to the loan on which the charge will be added. This article assumes you already have an existing loan. If not, see Creating…
General. Creating a note is done through the API by sending a PUT request to the loan or customer for which the note will be created. To create a note for a loan or a customer, you will need to send…
LoanPro's latest release now allows users to add APO/FPO/DPO addresses for military personnel stationed overseas. For more information, see our article on API – Addresses. General. This article cover…
Updated 3 weeks ago by Sloan
Pulling Credit Scores. To pull a credit score for a customer, send a POST request to a URL formatted as follows: https://loanpro.simnang.com/api/public/api/1/odata.svc/Customers(<id>)/Autopal.GetCred…
Edit an entity's custom fields through the API.
Updated 2 weeks ago by Jackson Stone
Pulling a Custom Form with the LoanPro API. If you are wanting to pull a custom form from the Software directly in the API and do something with it on your side, this article will help you understand…
Custom queries are a powerful way to pull data from LoanPro. It offers pulling specific information that can include current, archived, or reverse archived values from loans that match a certain quer…
General. This article discusses the collection options for a customer. Customer Type. customer.type.company Customer is a company.. customer.type.flooringCustomer Customer is a flooring customer (a c…
Customer Role. loan.customerRole.additional – customer is an additional customer. loan.customerRole.primary – customer is the primary customer. loan.customerRole.secondary – customer is the secondary…
General. This article explores how to add or edit a customer's phone number through the API. For a more general overview on how phones are used in LoanPro, see our article on Customer Phone Numbers.…
General. This article explores how to add or edit a customer's references through the API. For a more general overview on how references are used in LoanPro, see our article on References. To add a r…
General. When creating new customers, along with a few other entities, you may get a transactional warning response. These warn that you may have entered duplicate or inaccurate data into the system.…
General. Through the API you can easily create a dedicated login page or add a login area to an existing website. How To. To log the user into the customer-facing website, first send the user credent…
General. The LoanPro API returns dates in the following format: /Date(1427829732)/ The numeric portion of the date is the actual date expressed in epoch format (usually the number of seconds since Ja…
Adding DPD Adjustment. To adjust the days past due settings for a loan, send a PUT request to the desired loan. Below is a sample body of a request: { "id": 346, "DPDAdjustments": { "results": [ { "d…
General. Please note that deleting a loan will cause extra fees to be charged to your account! Proceed with care! To delete a loan, simply send a DELETE request to the url of the desired loan. For ex…
General. The deletion operation is very straight-forward, and can be done using a DELETE request. The only thing to take into consideration is that the requested entity MUST implement the “delete” me…
General. To delete a customer, simply send a DELETE request to the customers endpoint with the ID of the customer you want to delete. For example, to delete the customer with ID 515, you would send a…
General. In the event that you wish to mark a particular phone number as Do Not Call, you can do this through the API or by changing the status in the UI. If you wish to make the change in the UI, re…
Using DocuSign through the API. As a quick overview, our integration with DocuSign works as follows: You will send an HTTP post to an endpoint in LoanPro specifying the custom form ID and the loan ID…
General. This article explains how to upload documents through the API, but you can also upload common and customer-specific documents within the LoanPro UI. Uploading a document through the API is a…
Updated 2 months ago by Sloan
General. This article covers how to download the contents of an uploaded document. To learn about how to upload, update, or create documents please see the article API – Documents. Note: When you pul…
General. This article assumes you have read the following articles: API – Creating Charges. API – Updating Entities. When updating a charge, there is one extra field that needs to be set. This field…
General. If you want to send an email to a list of your loans, you can use the endpoint: POST https://loanpro.simnang.com/api/public/api/1/email.tool/next The payload should look something like this:…
Income Frequency. customerEmployer.incomeFrequency.annually – The customer receives the income amount annually. customerEmployer.incomeFrequency.biWeekly – The customer receives the income amount bi-…
General. To edit employer information for a customer send a PUT request to the URL of the customer. For example, if a customer had the id 1137, the url would be https://loanpro.simnang.com/api/public…
The endpoint, method, and payload for the new funding process, adding in the June 2021 release.
General. LoanPro has made an effort to standardize the error responses that are returned by the API. Error responses all have a format that is similar to the following: { "code" : "401-CN0001" , "mes…
Adding a New Escrow Adjustment. To add a new escrow adjustment for a loan, send a PUT request to the URL for the loan. For example, to add an escrow adjustment to a loan with ID 55, send a PUT reques…
Creating Escrow Calculators. Escrow calculators are useful for tracking escrow on a loan. Since escrow calculators are subentities of loans and are referenced in loan setups. Consequently, to create…
Escrow Subset Availability. loan.escrowAvailability.both – Available for both loans and leases. loan.escrowAvailability.lease – Available only for leases. loan.escrowAvailability.loan – Available onl…
General. To change the escrow subset options (aka. escrow settings) for an escrow account on a loan, send a PUT request to the URL of the loan. For example, to change escrow settings for a loan with…
Adding a New Escrow Transaction. To add a new escrow transaction for a loan, send a PUT request to the url for the loan. For example, to add an escrow transaction to a loan with ID 55, send a PUT req…
At various times in using the API, it will return URL references to various objects instead of the actual object data itself. Such requests occur most often when getting entity information. Below is…
General. This article assumes that you have read API – Creating Autopay Query Objects. Format. The URL to export an EFT file is as follows: https://loanpro.simnang.com/api/public/api/1/Autopal.Export…
General. Several LoanPro API endpoints use OData so you can filter your results without having to use an Elasticsearch object. Any endpoint that includes /odata.svc/ works with OData functionality. T…
Updated 1 month ago by Sloan
Use the UI to find a loan or customer ID.
General. To get admin stats for a loan, send a GET request to a URL formatted as follows: https://loanpro.simnang.com/api/public/api/1/Loans({id})/Autopal.GetAdminStats() Replace {id} with the ID of…
General. If you want to see the list of computation fields for you company, you can use the following endpoint: GET https://loanpro.simnang.com/api/public/api/1/odata.svc/ComputationFields The respon…
General. In order to retrieve customer bank account information through the API, send a GET request to the /Loans() endpoint. You expand the regular loan endpoint to include the bank account informat…
Use the LoanPro API to get information about loans and the customers associated with them. This article will explore the different endpoints you can use to retrieve loan information. Understanding th…
Updated 3 weeks ago by Jackson Stone
General. The odata.svc/Customers endpoint is one of the most important in LoanPro. Through this endpoint, you can create, read, or update customers, but you can also do the same for the customer nest…
General. This article will discuss pulling tenant settings. This does not allow for changing any of these settings, just viewing them. Base Request. The base request is a GET request to the URL https…
Setting Linked List. This article explains how to link loans through the API. For more general info or how to link loans loans in the UI, see our article on Account Linking. To link two loans in the…
Linking a Customer. This article explains how to link and unlink customers through the API. For a general overview of linking and how to do it in the UI, see our article on Account Linking. To link c…
General. This article covers modifying checklist items for existing loans. You can configure checklists in the UI , or through the API, which this article covers. This is done through the API by send…
General. This article explains how to fund a loan through the API. For more information regarding loan funding in general or the process in the UI, see Fund a Loan. To create a loan funding request,…
Loan Funding Authorization Reasons. This article lists some of the values used when doing loan funding through the API. For endpoints and other values, see our article on API – Loan Funding. loan.fun…
General. This article covers assigning a loan to a portfolio/subportfolio and removing a loan from a portfolio/subportfolio. You can do this in the UI , but this article shows how to do the same with…
LoanPro's latest update adding a new loan setting for default payment types. Before, you could only setting a single tenant-wide default, but now each individual can have a default set. The values "p…
Card Payment Fee Types. loan.cardfee.types.0 Waive Card Payment Fee.. loan.cardfee.types.1 Flat Fee.. loan.cardfee.types.2 Percentage.. loan.cardfee.types.3 Greater of Fee or Percentage.. loan.cardfe…
General. This article discusses the specifics of the Loan Setup of a loan, working with loan setup entities, and entity fields refer to. Working with Loan Setup Entities. When working through a loan…
General. This article shows a list of all collection options for the loan setup. Interest Rate Type. This is a list of all options for loan interest rate types. loan.rateType.annually Annual interest…
Updated 4 months ago by Darrin Wray
General. This article explains how to log a charge-off through the API, but it can also be done through the UI. To create a charge-off for a loan, you will need to send a PUT request to the URL of th…
This will only log a payment. Logging a payment is simply making a record of a transaction that occurred on a loan. This will not pull any money from a card or an account but will create a record of…
Updated 1 month ago by Darrin Wray
General. This is a list of miscellaneous endpoints that don’t require any special parameters. Just replace {id} with the ID of the corresponding entity (and see our article on Finding Loan and Custom…
General. You can modify a loan either within the UI , or through the API. To modify a loan in the API, follow these steps: Look for transactions that are after the modification date (optional). Compl…
The National Automated Clearing House Association (NACHA) set a specific format for formatting E-checks, which includes a set of codes for returned payments. These return codes act as a shorthand, ex…
General. Customers who use NACHA files to process transactions will often want to do something like the following: Pull a Payment History Report from LoanPro. Create a NACHA file outside of Secure Pa…
General. This article explores the concept of nested entities, and this article on getting loan information through the API will explain how to incorporate them into your API requests. Nested entitie…
General. LoanPro has an enpoint that specifically lets the user get the originally-calculated amortization schedule on a loan. A separate endpoint makes retrieving this information easy. The endpoint…
This article assumes you have read API – Responses with multiple results. When dealing with requests that return multiple results, many times you only want a subset of results. Other times, you have…
General. Creating an AutoPay on a parent loan requires additions to the typical AutoPay Payload. To create an AutoPay, use the request: PUT https://loanpro.simnang.com/api/public/api/1/odata.svc/Loan…
General. Parent-child loan linking functionality lets you designate multiple loans as the child of a single loan. When transactions are posted to the parent loan, a transaction is also posted to each…
General. Logging a payment on a parent loan requires additions to the typical payment payload. To log a payment, use the request: PUT https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(id)…
Extra Towards (Between Periods). payment.extra.periods.next Extra applies towards next payment.. payment.extra.periods.principalonly Extra applies only towards principal.. Extra Towards (Between Tran…
Account Type. paymentAccount.type.credit – Used for credit card payment profiles. paymentAccount.type.checking – Used for checking account payment profile.
General. LoanPro’s payment report offers detailed information about payments made and which loans the payments were applied towards. Each time a payment report is pulled a query is used to specify wh…
General. This collection is used to display payment status. This is not the LoanPro payment status, but the status received from the processor. What that means is when the processor reports a new pay…
General. With LoanPro, you can preview how a payment is applied before it is logged. To do this, send a POST request to a URL formatted as: https://loanpro.simnang.com/api/public/api/1/Loans(<id>)/Au…
Process a Payment - Processing a payment in LoanPro LMS will initiate a transaction that will actually pull money from the customer's card or account. This will create a record of the transaction jus…
Loan Promise Type. When creating a promise with the LoanPro API , these are the types of promise you can choose from. These options are the same choices you have when creating a promise in the UI. AP…
General. LoanPro allows you to track your customers' promises to pay. We have several articles explaining how to use promises in the LoanPro UI , and this one explains how to use the API. Creating a…
General. This article assumes that you have read API Query Objects. A lot of data in LoanPro is stored in strings, and often times you don’t care about an exact string match. Rather, you want to know…
LoanPro uses ElasticSearch to perform a large portion of searches. This means that the queries used by LoanPro closely resemble the queries used by Elastic search. This article will go over how to us…
General. This article assumes that you have read API Query Objects. At times, while performing a search, you’ll want to not only filter by entities that you are pulling for results, but also linked o…
General. This article assumes you have read API – Create a Loan. A Quick Quote is a temporary loan account that will last at least until midnight. After that, it will be deleted from the system and c…
Updating Recurrent Charges for a Loan. To update a recurring charge on a loan, send a PUT request to the URL of the loan. For example, to update the settings for loan 55 send a request to https://loa…
Sometimes, some requests will return multiple results. This often happens with GET requests where an ID is not specified. Such requests will have the following properties inside of the OData standard…
Payment reversal in LoanPro will mark a payment as reversed, and will then optionally forward it on to payment processors for voiding. This article explains how to reverse payments through the API, b…
Preview Roll Payment. To preview a roll payment, send a GET request to: https://loanpro.simnang.com/api/public/api/1/Loans(<id>)/Autopal.RollPayment(<amount>,<method>) “<id>” – The ID of the target l…
General. Rules Applied can make changes to Loan Settings. You can configure which rules will trigger which changes either using the UI or through the LoanPro API, which is explained here. To change a…
For information about Schedule Rolls and what the options do, see Roll Schedule Templates. Adding New Schedule Line. To add a new schedule line, send a PUT request to the URL of the target loan. This…
To know more about schedule roll options, see Roll Schedule Templates. Solve Using. loan.rollScheduleSolve.advanced – Advanced Schedule. loan.rollScheduleSolve.dollar – Dollar Amount. loan.rollSchedu…
General. Sometimes, it is easiest to find a specific customer by their SSN. This can be done through the API by sending a POST request to the following endpoint: https://loanpro.simnang.com/api/publi…
In the LoanPro UI, you can search for customers from Users > Customer Manager. This article will explain how to search through the API. To search customers a POST request is sent to the Customers/Aut…
Updated 2 months ago by Cole
Much like how you can search loans in the UI , you can also search them through the API. To search loans, a POST request is sent to the Loans/Autopal.Search() endpoint, often with request flags to de…
This article will discuss how to send emails using the API, but it can also be done through the UI. There are two steps. The first one is to create an email tool entity, and then the other one is to…
General. When customers have multiple payment profiles set up, one of them will need to be set as the primary profile. This can be done either with the Customer Manager tool in the UI , or through th…
General. The special report makes it possible to create an exportable report similar to the custom query. The difference is that with the special report, you can specify your own delimiter or you can…
General. LoanPro provides the ability to split payments across linked loans, which provides for many useful tools. This article assumes you have read API – Logging a Payment. Preview Split. To previe…
Suspending. For basic info and how it works in the UI, see our article on Suspending Payments. To suspend forecast payments, send a POST request to a URL formatted as follows: https://loanpro.simnang…
General. In LoanPro, you can suspend interest on a loan for a time, or later resume that interest. Our article Suspend/Resume Interest Accrual explains the basics and how to use the tool in the UI, a…
General. While not possible inside the LoanPro UI, you can add a system note directly, using the LoanPro API. This is most often helpful when adding customer communication history notes. This article…
General. The Targeted APR feature calculates loan values that will have the APR for a loan be approximately equal to the target APR. The APR estimates will be equal to or less than the target APR. Th…
Getting Tenant Files. To get a list of tenant files, send a GET request to the following URL: https://loanpro.simnang.com/api/public/api/1/files/Tenant Uploading. To add a tenant file, send a POST re…
General. The purpose of transaction warnings it to help users avoid creating duplicate data within the system. The decision to return a transaction warning is based on a comparison of key pieces of d…
Below is a list of transaction types used for Escrow Transactions. transaction.type.deposit – A deposit into a bucket/account. transaction.type.withdrawal – A withdrawal from a bucket/account.
General. Loan alerts are important messages that will always be accessible from the loan header and will be displayed prominently on the Loan Summary tab inside a loan. The purpose of the Loan Alert…
General. This article explains how to use the API to update merchant processor groups. You can also do this through the UI. To update the merchant processor group using the LoanPro API, you simply ne…
General. This article explains how to update payment profiles through the API, but we also have articles show how to make changes within the LoanPro UI or the Secure Payments UI. LoanPro uses Secure…
General. This article covers the basics for updating a customer using the LoanPro API. Update a Customer. To update a customer, send a PUT request to https://loanpro.simnang.com/api/public/api/1/odat…
General. In the API, all updates are done through a PUT request. To update an item, follow the same steps as creating the item with a few additions: In each LoanPro object, you must include the follo…
General. This article assumes you have read the following articles: Payment Defaults. API – Logging a Payment. API – Processing a Payment. API – Updating Entities. When updating a payment, there is o…
General. LoanPro is integrated with tools that can verify with the postal service that an address is real. Our main article on USPS Address Verify & Validate explains how these tools work and how to…
What is an import, and how does it work in the API? Imports let you move a large body of data into LoanPro much faster than the regular user interface would allow (and with a lot less work, as well).
General. LoanPro's Swagger documentation shows each endpoint, an example of how to send a request, and information about payloads and responses. The full site can be accessed at https://loanpro.simna…
Updated 1 month ago by Cole
General. LoanPro enterprise clients have often created their own middleware in order to facilitate servicing for their employees. This middleware often includes is an integration with telephony servi…
Powered by HelpDocs (opens in a new tab)
Updated 1 month ago
by Andy
