This request retrieves a loan's escrow information.
The LoanPro calculator and Loan Management System (LMS) allow a great deal of configuration when it comes to setting up and using escrow. To achieve this, the API uses a combination of multiple escrow objects. Note the following when using this request:
There are 6 separate escrow objects. Here's a breakdown of those objects:
Object Name | Description |
|---|---|
| These two objects both hold Escrow Bucket information. |
| This object holds Escrow Calculator information. |
| This object holds transaction information. Information on payments made to an escrow account is stored here. |
| This object holds information for escrow transactions and how they have affected the escrow account for a loan. |
| This object holds information for adjustments that are made to the escrow portion of a loan. An escrow adjustment consists of two pieces of data: the payment period when the escrow amount will start to be added to payments, and the amount that will come due with each payment. When an escrow adjustment is entered, it will affect all payments from the payment period going forward. |
It's possible to expand multiple objects within a single request. To retrieve all of the escrow information for a loan with one request, format the endpoint like the following:
https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(9114)?$expand=EscrowCalculatedTx,EscrowAdjustments,EscrowTransactions,EscrowSubsets,EscrowSubsetOptions,EscrowCalculatorsDatabase
For information on escrow database tables, see the following articles:
Database – Escrow Subset Entity (escrow_subset_entity)
Database – Escrow Subset Options (escrow_subset_options_entity)
Database – Escrow Calculator (escrow_calculator_entity)
Database – Escrow Transaction (escrow_transaction_entity)
Database – Escrow Adjustment Entity (escrow_adjustment_entity)