API - Update Source Company

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

After creating a source company, you can use the LoanPro API to update the source company information. This article will explain how to update source companies and source company employees. You can also try this yourself on our ReadMe site where you can find more information about our API documentation.

Updating a Source Company

To update a source company, send a PUT request to the following URL.

PUT  https://loanpro.simnang.com/api/public/api/1/odata.svc/SourceCompanies(<id>)

Just remember to replace <id> with the ID of the source company you'd like to update.

Below is a sample of the body of the request.

{
"companyName": "Source Company ABC",
"ContactPhone": "8888888888",
"numPrefix": null,
"numSuffix": null,
"CustomFieldValues": {
"results": [
{
"customFieldId": 1,
"customFieldValue": 123,
"__update": true
},
{
"customFieldID": 2,
"customFieldValue": "0.00",
"__update": true
}
]
}
}

Here are descriptions of each parameter used in the request.

  • companyName - The name of the source company you are creating.
  • contactPhone - Phone number of your contact at the source company.
  • 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.
  • 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.

You can also update the primary contact, address, and cash drawer transaction limits.

Updating Source Company Employees

The API can also be used to update source company employees. To do so, use the same endpoint URL listed above and the following body.

When updating any source company employees, you must include ALL users that you want to be linked to the source company. Leaving a userId out of the request will unlink them if they were previously linked.
{
"Employees": {
"results": [
{
"userId": 7580
},
{
"userId": 7579
},
{
"userId": 6481
},
{
"userId": 6256
}
]
}
}

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)