API Get Loan Information

General

The odata.svc/Loans endpoint is one of the most important in LoanPro. Through this endpoint, you can create, read, or update loans, but you can also do the same for the loan nested entities.

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

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

Note: It used to be possible to pull all results by omitting the ID. If you do this, you will get the following response:

{
    "error": {
    "message": "Access to retrieve all entities has been deprecated.",
     "type": "ODataException",
     "code": 410
    }
}

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

"Payments":{ 
"__deferred":{
"uri":"Loans(id=667)/Payments"
}
}

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.

Note: OData tokens ($skip, $top, $filter, etc.) do not affect the results returned in an expanded entity. For example, if you use the odata.svc/Loans() endpoint and choose to expand Transactions (i.e. odata.svc/Loans(667)?$expand=Transactions), you can not use the $top token to specify how many Transactions results will be returned. This is not supported by OData.

Example:

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

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 customers on a loan and you want to expand the primary addresses of those customers.

Example:

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

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/Loans({ID})?$expand=Customers/PrimaryAddress,LoanSetup,Payments

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/Loans({ID})/Payments

Nested Entities

The following nested entities are associated with loans:

  • Insurance - Information on any insurance policy on loan collateral
  • CustomFieldValues - Values for custom fields
  • ChecklistItemValues - Values for checklist items (checked, not checked, date)
  • Documents - Documents uploaded to the loan
  • Collateral - Collateral securing the loan
  • LoanSettings - Settings and grouping selections for the loan
  • LoanSetup - Primary loan numbers
  • Notes - Loan notes
  • Promises - Customer promises for the loan
  • Bankruptcies - Bankruptcy information for the loan
  • Charges - Loan charges
  • Payments - Loan payments
  • LoanFunding - Funding transactions for the loan
  • Advancements - Advancements (usually money given) on the loan (does not include the initial loan amount)
  • Credits - Loan credits, which decrease the loan balance (though not necessarily the principal balance)
  • DueDateChanges - Changed loan payment due dates
  • CurtailmentDates - Curtailment dates (payment dates for flooring loans)
  • StatusArchive - Daily status record of the loan (includes things like principal balance, payoff, accrued interest, flags, etc.)
  • Transactions - The up-to-date amortization schedule for the loan, including logged transactions and forecast transactions
  • EscrowCalculatedTx - Calculated escrow transactions on the loan
  • ScheduleRolls - Schedule roll adjustments that apply to the loan
  • StopInterestDates - Dates when interest accrual is stopped or restarted
  • APDAdjustments - Adjustments of the amount past due that apply to the loan
  • DPDAdjustments - Adjustments of the days past due that apply to the loan
  • LoanModifications - Loan modifications, changes to specific core loan information, that apply to the loan
  • EscrowAdjustments - Addition of or changes to escrow amounts that are added to payments on the loan
  • EscrowTransactions - Deposits or withdrawals from collected escrow amounts on the loan
  • EscrowSubsetOptions - Options applying to escrow accounts or buckets on the loan
  • EscrowCalculators - Escrow calculators, calculations of the escrow that will apply in each payment period based on the total escrow, that apply to the loan
  • EstimatedDisbursements - Disbursements of escrow to the organizations to which escrow funds are due
  • Loans - Loans linked to the queried loan
  • LinkedLoanValues - Settings for loans linked to the queried loan
  • LoanChilds - Loan that are children of the queried loan
  • RecurrentCharges - Recurring charges, or charges that recur base on a loan trigger
  • PayNearMeOrders - Accounts or orders set up to pay this loan through PayNearMe
  • Customers - Customers linked to the loan
  • Portfolios - Portfolios the loan is assigned to
  • SubPortfolios - Sub-Portofolios the loan is assigned to
  • EscrowSubsets - Escrow buckets that are active for the loan
  • RuleAppliedLoanSettings - Information on loan settings rules applied that the loan is enrolled for
  • RuleAppliedChargeOff - Information on charge off rules applied that the loan is enrolled for
  • RuleAppliedAPDReset - Information on amount past due reset rules applied that the loan is enrolled for
  • RuleAppliedChecklists - Information on checklist rules applied that the loan is enrolled for
  • RuleAppliedChangeDueDates - Information on change due date rules applied that the loan is enrolled for
  • RuleAppliedStopInterest - Information on stop interest accrual rules applied that the loan is enrolled for
  • RuleAppliedAccountTools - Information on account tools rules applied that the loan is enrolled for
  • RuleAppliedCustomerTools - Information on customer tools rules applied that the loan is enrolled for
  • RuleAppliedAutopay - Information on AutoPay rules applied that the loan is enrolled for
  • RuleAppliedLoanSetup - Information on loan setup rules applied that the loan is enrolled for
  • RuleAppliedBankruptcy - Information on bankruptcy rules applied that the loan is enrolled for
  • Autopays - Information about automatic payments set up on the loan
  • ActionResultNotes Action and result notes logged on the loan


How did we do?


Powered by HelpDocs (opens in a new tab)