Loan detail with collateral folded in

Returns the complete loan read - status, terms, timeline, summary, the full repaymentSchedule, transactions, notes, delinquency and the option lists - with associations defaulting to all, then adds these keys: monthlyPaymentAmount, finalPaymentDueAtMaturity and interestRateType (always), and, when includeCollateral resolves true, collateralPledges (the rollup plus the ACTIVE pledged items), originationFeeAmount and originationFeePercentage (only when the caller also holds READ_LOAN_FINANCED_ORIGINATION_FEE) and loanHealthStatus (the blended-LTV escalation tier as a traffic-light color - not a lifecycle status; lifecycle status is the status object). When collateral is folded in, the base read's own collateral array (permanently empty) is removed so it cannot be mistaken for collateralPledges; with includeCollateral=false it stays. Blocks that depend on the loan's data (charges, guarantors, linkedAccount, meeting, originalSchedule, interestRecalculationData, group, rates, interestRatesPeriods) are present only when the loan has them. See api_contracts.md, "Embarc Loan Read Wrapper", for permission rationale and why the added key is collateralPledges and not collateral.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The numeric loan id, not the loan account number - see api_contracts.md, "Loan number vs loan id". An unknown id returns 404 from the underlying loan read.

Query Params
boolean
Defaults to true

Defaults to true, which requires READ_COLLATERAL. false skips the collateral lookup and the permission check and omits collateralPledges, originationFeeAmount, originationFeePercentage and loanHealthStatus; the other added fields are still returned.

string
Defaults to all

Comma-separated blocks to include (for example repaymentSchedule, transactions, charges, guarantors, collateral, notes, linkedAccount, multiDisburseDetails, collection, loanTermVariations, futureSchedule, originalSchedule). Defaults to all. Narrowing it removes the matching blocks, and finalPaymentDueAtMaturity is then absent whenever repaymentSchedule is not included.

string

Comma-separated association names to remove from the expanded set, for example exclude=transactions,repaymentSchedule.

string

Restricts the base loan payload to the named keys. It applies to the base read only - collateralPledges and the other added keys are attached afterwards and are not subject to it. Only keys the underlying read allows can be named, and combining fields with the default associations=all may be rejected with HTTP 400 because some association blocks are not nameable - pass an explicit associations when you use fields.

boolean

When true, limits staff options to the loan's office. Passed through unchanged.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json