API Get Customer Information

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 nested entities.

To get the basic customer information, send a GET request to https://loanpro.simnang.com/api/public/api/1/odata.svc/Customers({ID})

Be sure to replace the {ID} portion of the URL with the ID of the customer you are getting data for.

The return for this call will not show any additional information for the nested entities. Each entity will look like this:

"PrimaryAddress":{ 
"__deferred":{
"uri":"Customers(id=558)/PrimaryAddress"
}
}

In order to see the information for a specific entity, use the $expand token with your URL. Set the expand token equal to any entities you want to expand, separated by commas, no spaces.

Example:

https://loanpro.simnang.com/api/public/api/1/odata.svc/Customers({ID})?$expand=PrimaryAddress,MailAddress,Employer

If you want to expand an entity that is nested inside a nested entity, that can be done by adding a / followed by the entity name. For example, if you want to expand loans connected to a customer and you want to expand the loan setup of those accounts.

Example:

https://loanpro.simnang.com/api/public/api/1/odata.svc/Customers({ID})?$expand=Loans/LoanSetup

If you want to expand multiple entities, you can still include them, separated by commas, with the URL.

Example:

https://loanpro.simnang.com/api/public/api/1/odata.svc/Customers({ID})?$expand=Loans/LoanSetup,PrimaryAddress,Employer

Finally, if you want to see the information for a nested entity only, just use a / and the entity name.

Example:

https://loanpro.simnang.com/api/public/api/1/odata.svc/Customers({ID})/Loans

Nested Entities

The following nested entities are associated with customers:

  • PrimaryAddress - Primary address information of the customer (city, state, zip, etc.)
  •  MailAddress - Mailing address information of the customer (city, state, zip, etc.)
  • Employer - Employer information of the customer
  • References - References of the customer
  • PaymentAccounts - Payment profile information for the customer
  • Phones - Customer phone contact information
  • CustomFieldValues - Custom field information and values for customer custom fields
  • Documents - Information on all customer documents associated with the customer
  • CreditScore - Credit Scores of the customer
  • Loans - Information on loans associated with the customer
  • SocialProfiles - Information on social profiles associated with the customer
  • Notes - Information on Notes associated with the customer


How did we do?


Powered by HelpDocs (opens in a new tab)