API – Create a Source Company

General

This article explains how to create a Source Company using the LoanPro API. You can also try this yourself on our ReadMe documentation site by clicking the button below.

To create a source company through the API, send a POST request to the following URL.

POST https://loanpro.simnang.com/api/public/api/1/odata.svc/SourceCompanies

The payload should look something like this:

{
"companyName": "Lenders R Us",
"numSuffix": "1",
"numPrefix": "LRU",
"contactPhone": "8005554444",
"CustomFieldValues": {
"results": [
{
"customFieldId": 83,
"customFieldValue": "4"
}
]
},
"Employees": {
"results": [
{
"userId": "2296"
},
{
"userId": "6"
}
]
},
"PrimaryContact": {
"__id": "2296"
},
"Address": {
"country": "company.country.usa",
"state": "geo.state.CA",
"zipcode": "90210",
"address1": "129 N Stump St",
"city": "BEVERLY HILLS"
}
}

  • companyName - The name of the source company you are creating.
  • numPrefix - The common prefix that will be added to the id's of loans created with this company assigned as the source company.
  • numSuffix - The common suffix that will be added to the id's of loans created with this company assigned as the source company.
  • contactPhone - Phone number of your contact at the source company.
  • CustomFieldValues - This object will contact all of the custom fields you have set up for source companies. You can find a full list of your custom fields and their IDs within Settings > Source Company > Custom Fields.
  • Employees - The LoanPro user ID for each employee linked to the source company.
  • PrimaryContact - The LoanPro user ID of the employee listed as the primary contact.
  • Address - This object contains all of the information for the source company address. Note that the two-letter state code needs to be capitalized.
Please note that you cannot update Notes and Documents through the API. In addition, Vault information, Cash Drawers, Terminal Numbers, and Notifications cannot be altered via the API.


How did we do?


Powered by HelpDocs (opens in a new tab)