API - Update Source Company
Updated 10 months ago
Introduction
After creating a source company, you can use the LoanPro API to update the source company information. This article explains 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. In this example, we use a source company with the ID of 12.
PUT https://loanpro.simnang.com/api/public/api/1/odata.svc/SourceCompanies(12)
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.
Parameter | Description |
companyName | The name of the source company you are creating. |
contactPhone | The Phone number of your contact at the source company. |
numPrefix | The common prefix that will be added to the IDs of the 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.
{
"Employees": {
"results": [
{
"userId": 7580
},
{
"userId": 7579
},
{
"userId": 6481
},
{
"userId": 6256
}
]
}
}