This request retrieves loan information.
Loan accounts are represented by the Loans entity, and they are structured to hold vast amounts of information. The information stored within a loan account is separated into nested objects. For example, a history of the payments made on a loan account is stored within the Payments object.
When retrieving loan information, a GET request sent to the Loans endpoint offers a few different options. Note the following when making a request:
{baseUrl}/odata.svc/Loans retrieves a list of loans within the account.
{baseUrl}/odata.svc/Loans({id}) retrieves a single loan account's generic information.
{baseUrl}/odata.svc/Loans({id})?$expand=LoanSetup retrieves a loan account's generic information and the information stored within theLoanSetup object.
{baseUrl}/odata.svc/Loans({id})/LoanSetup retrieves only the information stored within the LoanSetup object.
There are dozens of objects nested within the Loans entity. Here's a list of the nested objects:
| ActionResultNotes | EstimatedDisbursements |
| Advancements | Insurance |
| APDAdjustments | LinkedLoanValues |
| Autopays | LoanChilds |
| Bankruptcies | LoanFunding |
| Charges | LoanSettings |
| ChecklistItemValues | LoanSetup |
| Collateral | Payments |
| Credits | RuleAppliedBankruptcy |
| CurtailmentDates | RuleAppliedChangeDueDates |
| Customers | RuleAppliedChargeOff |
| CustomFieldValues | RuleAppliedChecklists |
| Documents | RuleAppliedCustomerTools |
| DPDAdjustments | RuleAppliedLoanSettings |
| DueDateChanges | RuleAppliedLoanSetup |
| EscrowAdjustments | RuleAppliedStopInterest |
| EscrowCalculatedTx | ScheduleRolls |
| EscrowCalculators | StatusArchive |
| EscrowSubsetOptions | StopInterestDates |
| EscrowSubsets | SubPortfolios |
| EscrowTransactions | Transactions | InterestRateChanges |
For an example of how loans work within the UI, take a look at our Account Manager article.
Database
For information regarding loan database tables, see the following articles:
Database – Loan Table (loan_entity)