Available Variables

General

LoanPro provides variables for use in custom forms, email templates, etc. that let you merge specific customer or loan data in order to make them more specific. This article provides a quick list of the most commonly used variables and a brief explanation of each one.

For a full list of the variables you can use in the context engine, see our Context Engine Glossary.

Variable

Description

loan-id

This is the identification number of the loan assigned by LoanPro.

loan-display-id

This is the displayed identification number assigned by you.

loan-create-time

This is the date and time the loan was created.

setup-active

This is either a 1 or 0 depending on whether the loan has been setup (basic loan data entered and the amortization schedule calculated).

loan-archived

This is either a 1 or 0 depending on whether the loan has been archived.

loan-status

This is that status of the loan

loan-substatus

This is the loan sub-status.

settings-ebilling

This is either a 1 or 0 depending on whether ebilling is set to Yes or No.

settings-ecoa-code

This is the ECOA code setting for the loan formatted like this: loan.ecoacodes.2.

settings-co-buyer-ecoa-code

This is the ECOA code setting for the loan formatted like this: loan.ecoacodes.2.

settings-reporting-type

This is the reporting type setting on the loan formatted like this: loan.reportingtype.I.

settings-account-closed-date

This is the date entered as the date the loan was closed.

settings-liquidation-date

This is the date entered as the liquidation date (date collateral was sold) for the loan.

settings-repossession-date

This is the date entered as the repossession date (date collateral was repossessed) for the loan.

settings-credit-status

The credit status settin for the loan formatted like this: loan.creditstatus.11.

settings-credit-bureau

The credit bureau setting for the loan formatted like this: loan.creditbureau.00

settings-autopay-enabled

This is either a 1 or 0 depending on whether autopays are enabled on the loan.

settings-autopay-enabled

This is either a 1 or 0 depending on whether autopays are enabled on the loan.

settings-secured

This is either a 1 or a 0 depending on whether the loan is secured by collateral.

settings-card-fee-type

This is the card fee setting on the loan formatted like this: loan.cardfee.types.1.

settings-card-fee-amount

This is the card fee amount on the loan.

settings-card-fee-percent

This is the card fee percent on the loan.

collateral-position.id1.collateral-distance

This is the mileage on the collateral vehicle. In the case of multiple collaterals, you can change the position ID to see a different collateral.

collateral-position.id1.collateral-book-value

The book value for the collateral vehicle.

collateral-position.id1.collaterals-custom-fields

The custom fields associated with the collateral item.

setup-loan-amount

The loan amount.

setup-discount

The loan discount amount.

setup-underwriting

The loan underwriting fee.

setup-loan-term

The number of payment periods in the loan term.

setup-payment-frequency 

The frequency with which payments come due on the loan formatted like this: loan.frequency.monthly.

setup-days-in-period 

If the frequency on the loan is custom, this is the number of days in a loan payment period.

setup-interest-rate 

The interest rate on the loan.

setup-interest-rate-type

The period for which the interest rate applies, formatted like this: loan.rateType.annually.

setup-contract-date

The contract date of the loan.

setup-first-payment-date

The first payment due date on the loan.

setup-grace-days 

The grace period on the loan.

setup-residual 

The residual value of a leased asset. This applies to leases only.

setup-money-factor

The money factor on the lease. This applies to leases only.

setup-amount-down

The down-payment amount on the loan collateral.

setup-sales-price

The sales price of the loan collateral.

setup-warranty

The amount paid on a warranty on the loan collateral.

setup-gap

The amount paid of a GAP insurance policy on the loan collateral.

setup-dealer-profit

The dealer profit amount on the sale of the loan collateral.

setup-reserve-amount

The reserve amount held back by the lender when the loan was funded.

setup-credit-limit

The credit limit on the loan.

setup-reporting-credit-limit 

The credit limit reported to credit bureaus on the loan.

setup-loan-type

The type of loan formatted like this: loan.type.installment.

setup-loan-class

The loan class formatted like this: loan.class.carLoan.

setup-calc-type

The loan calculation type formatted like this: loan.calcType.simpleInterest.

setup-discount-split

This is either a 1 or 0 depending on whether discount income will be recognized over the life of the loan.

setup-discount-calc

This is the discount calculation setting on the loan, formatted like this: loan.discountCalc.straightLine.

setup-days-in-year

This is the days in year setting on the loan, formatted like this: loan.daysInYear.actual.

setup-first-period-days

This is the first period days setting on the loan, formatted like this: loan.firstPeriodDays.actual.

setup-interest-application

This is the interest application setting on the loan, formatted like this: loan.interestApplication.betweenTransactions.

setup-beg-end

This is the begin/end setting on the loan, formatted like this: loan.begend.end.

setup-last-as-final

This is either a 1 or 0 depending on whether the last as final setting on the loan is set to Yes or No.

setup-round-decimals

This is the number of decimal places to which calculation values on the loan should be rounded.

setup-schedule-round

This is the amount added or subtracted from the end of the payment schedule.

setup-first-day-interest

This is either a 1 or 0 depending on whether the first day interest setting on the loan is set to Yes or No.

setup-end-interest

This is the end interest setting on the loan, formatted like this: loan.endInterest.no.

setup-fees-paid-by

This is the fees paid by setting on the loan, formatted like this: loan.feesPaidBy.date.

setup-schedule-template

This is the name of the schedule roll template assigned to the loan.

setup-late-fee-type

This is the late fee type setting on the loan, formatted like this: loan.lateFee.4.

setup-late-fee-percent-base

This is the loan number late fee percentage is based on, formatted like this: loan.latefeepercentbase.regular.

setup-late-fee-calc

This is the late fee calculation type on the loan, formatted like this: loan.lateFeeCalc.standard.

setup-late-fee-percent

This is the late fee percentage on the loan.

setup-late-fee-amount

This is the late fee amount on the loan.

loan-substatus-late-fees

Displays whether the status/sub-status of the loan is eligible for late fees.

setup-payment

This is the standard payment amount on the loan.

setup-til-apr 

This is the APR on the loan.

setup-til-sales-price

This is the sales price of loan collateral.

setup-til-total-plus-down

This is the total of payments plus the amount down on the loan.

setup-til-finance-minus-uwfee

This is the finance charge minus the underwriting fee.

setup-til-finance-charge 

This is the finance charge on the loan.

setup-til-loan-amount 

This is the loan amount.

setup-til-total-of-payments 

This is the total of payments on the loan.

status-principal-balance 

This is the principal balance on the loan.

status-perdiem 

This is the per diem interest accrued on the loan.

status-available-credit 

This is the available credit on the loan.

status-payoff 

This is the payoff on the loan.

status-days-past-due

This is the number of days the loan is past due.

status-amount-due

This is the amount due on the loan.

status-amount-past-due-30

This is the amount that is more than 30 days past due on the loan.

status-due-interest

This is the interest due on the loan.

status-payoff-fees 

This is the amount of payoff fees on the loan.

status-due-principal

This is the principal due on the loan.

status-date-last-current

This is the most recent date on which the loan was current.

status-aging

This is the number of days that have passed since the contract date on the loan.

status-next-payment-date

This is the next date on which a payment will come due on the loan.

status-next-payment-amount 

This is the amount of the next payment that will come due on the loan.

status-total-advancements 

This is the total amount issued in advancements on the loan.

status-total-credits

This is the total amount issued in credits on the loan.

status-percent-paid-off

This is the percentage of the loan principal that has been paid, expressed as a decimal.

status-remaining-interest

This is the total projected interest that has not been paid on the loan.

status-due-to-date

This is the amount that has come due to date on the loan.

status-full-due

This is the full amount that will be due on the next payment date.

customer

This is an array variable of the customers linked to the loan.

payments

This is an array variable of the payments that have been made on the loan.

loan-alert 

This is the loan alert on the loan.

status-due-fees

This is the amount of fees due on the loan.

status-due-escrow

This is the amount of escrow due on the loan.

source-company-gps-lat 

This is the latitude of the source company location

source-company-gps-lon

This is the longitude of the source company location.

loan-modified

This is a 1 or 0 value depending on whether the loan has been modified.

next-autopay-id 

This is the ID of the next autopay that will process on the loan.

next-autopay-date

This is the date the next autopay will process on the loan.

next-autopay-amount

This is the amount of the next scheduled autopay on the loan.

next-autopay-remaining-periods

This is the remaining number of periods that the scheduled autopay will run.

stop-interest-dates

This is an array of the stop-interest dates on the loan.

status-uncollected-discount

This is the uncollected discount amount on the loan.

status-days-in-first-period

This is the number of days in the first loan period.

status-first-period-interest 

This is the amount of accrued interest from the first loan period.

tx-forecast-terms-remaining

This is the forecasted remaining terms on the loan.

status-terms-remaining

This is the remaining terms of the loan.

status-scheduled-payments

This is the number of scheduled payments on the loan.

status-loan-recency 

This is the number of days since a payment was made on the loan.

status-orig-maturity-date

This is the originally calculated maturity date on the loan.

status-yearly-breakdown

This is an array variable that gives the breakdown of payments made by year.

status-total-paid-interest 

This is the total amount paid in interest on the loan.

status-total-paid-fees

This is the total amount paid in fees on the loan.

status-total-paid-escrow

This is the total amount paid in escrow on the loan.

status-total-paid-discount

This is the total amount paid in discount on the loan.

status-total-paid-principal

This is the total amount paid in principal on the loan.

status-total-paid 

This is the total amount paid on the loan.

status-next-payment-interest

This is the interest portion of the next payment that will come due on the loan.

status-next-payment-principal

This is the principal portion of the next payment that will come due on the loan.

status-next-payment-discount 

This is the discount portion of the next payment that will come due on the loan.

status-next-payment-escrow 

This is the escrow portion of the next payment that will come due on the loan.

status-next-payment-fees

This is the fees portion of the next payment that will come due on the loan.

next-scheduled-payment-date

This is the date of the next scheduled payment on the loan.

next-scheduled-payment-amount 

This is the amount of the next scheduled payment on the loan.

next-scheduled-payment-interest 

This is the interest portion of the next scheduled payment on the loan.

next-scheduled-payment-principal 

This is the principal portion of the next scheduled payment on the loan.

next-scheduled-payment-discount

This is the discount portion of the next scheduled payment on the loan.

next-scheduled-payment-escrow

This is the escrow portion of the next scheduled payment on the loan.

next-scheduled-payment-fees

This is the fees portion of the next scheduled payment on the loan.

unfulfilled-promises

This is an array variable of the unfulfilled promises on the loan.

last-payment-date 

This is the date on which the last payment was made on the loan.

last-payment-amount 

This is the amount of the last payment made on the loan.

last-payment-interest

This is the interest portion of the last payment made on the loan.

last-payment-principal 

This is the principal portion of the last payment made on the loan.

last-payment-escrow

This is the escrow portion of the last payment made on the loan.

last-payment-fees

This is the fees portion of the last payment made on the loan.

current-date

This is the current date, formatted like this: 2016-09-21.

current-time

This is the current time, formatted like this: 18:33:55

first-delinquency-date

This is the first date when the loan was delinquent.

status-net-charge-off

This is the total amount charged off the loan.

status-due-discount

This is the total amount of discount due on the loan.

status-remaining-discount

This is the remaining discount on the loan.

portfolio-list

A list of the active portfolios on a loan.

sub-portfolio-list

A list of the active sub-portfolios on a loan.

loan-modification-count 

This is the number of modifications on the loan.

scheduled-payments

This is an array of the scheduled payments on the loan.

til-forecast-payment

This is an array of forecast payments as originally calculated on the loan. These values are captured at the time the loan is activated.

til-scheduled-payments

This is an array of scheduled payments as originally calculated on the loan. In other words, it’s the schedule of payments as if no time had passed since the contract date and no payments had been made on the loan.

status-final-payment-date

This is the originally calculated date of the final payment on the loan.

collateral-insurance-agent-phone

This is the insurance agent’s phone number.

settings-linked-to

This is the ID of the loan the current loan is linked to.

settings-linked-from

This is the ID of the loan the current loan is linked from.

loan-human-activity-date 

This is the last date when human activity occurred on the loan.

today-minus-dpd

This is the current date minus the days past due, displayed as a date.

status-unique-delinquencies 

This is the number of unique delinquencies on the loan.

status-delinquency-percentage 

This is the percentage of time the loan has been delinquent.

status-delinquent-days

This is the number of days the loan is delinquent.

next-autopay-apply-date 

This is the apply date of the next scheduled autopay on the loan.

tenant-primary-contact-id

This is the numeric ID of your company contact.

tenant-live-loans

This is the number of live loans in your company account.

tenant-archived-loans

This is the number of archived loans in your company account.

tenant-status

This is your company’s status, formatted like this: company.status.active.

tenant-theme

This is your company’s chosen theme, formatted like this: company.theme.car.

tenant-name

This is your company name.

tenant-full-address

This is you company’s full address, complete with city and state.

tenant-address1 

This is your company’s primary address.

tenant-address2 

This is your company’s second address line.

tenant-city

This is your company’s city.

tenant-state 

This is the two-letter abbreviation of your company’s state/province.

tenant-zipcode

This is your company ZIP/postal code.

tenant-domain

This is your company’s web domain (e.g. example.com).

tenant-timezone

This is your company timezone, formatted like this: company.timezone.americaDenver.

tenant-loan-count 

This is the number of loans in your company account.

tenant-support-minutes 

This is the number of support minutes your company has left.

company-phone-primary

This is your company’s primary phone number.

company-phone-billing

This is your company’s billing phone number.

company-phone-custserv

This is your company’s customer-service phone number.

company-phone-fax 

This is your company’s fax number.

company-phone-human

This is your company’s human-resources phone number.

company-phone-main

This is your company’s main phone number.

company-phone-sales

This is your company’s sales phone number.

company-phone-servicing 

This is your company’s servicing phone number.

company-email-primary

This is the your company’s primary email address.

company-email-billing

This is your company’s billing email.

company-email-custserv

This is your company’s customer-service email.

company-email-human

This is your company’s human-resources email.

company-email-main

This is your company main email address.

company-email-sales

This is your company sales email address.

tenant-servicers

This is an array-style variable that gives information on the servicing users within your company

source-company-id

This is the ID for the source company assigned to the loan.

source-company

This is the source company assigned to the loan.

source-company-contact-phone 

This is the contact phone number for the source company.

source-company-contact-email

This is the contact email for the source company.

source-company-num-prefix

This is the loan-numbering prefix for the source company.

source-company-num-suffix

This is the loan-numbering suffix for the source company.

source-company-address1 

This is the primary address for the source company.

source-company-address2 

This is the second address line for the source company.

source-company-city 

This is the city where the source company is located.

source-company-state

This is the state/province where the source company is located.

source-company-zipcode

This is the ZIP/postal code where the source company is located.

source-company-country

This is the country where the source company is located, formatted like this: company.country.usa.

source-company-bank-address1 

This is the primary address for the source company bank.

source-company-bank-address2

This is the second address line for the source company bank.

source-company-bank-city

This is the city where the source company bank is located.

source-company-bank-state

This is the state/province where the source company bank is located.

source-company-bank-zipcode

This is the ZIP/postal code where the source company bank is located.

source-company-bank-country

This is the country where the company bank is located, formatted like this: company.country.usa.

portfolio

This is an array-style variable that gives information about all of the portfolios assigned to the loan.

sub-portfolio

This is an array-style variable that gives information about each of the sub-portfolios assigned to the loan.

checklist

This is an array-style variable that gives information about each of the checklist items on the loan, including if they are checked and the date and time when they were checked.

escrow

This is an array-style variable that gives information about each of the escrow accounts on the loan.

agent-first-name

This is the first name of the agent assigned to the loan.

agent-last-name 

This is the last name of the agent assigned to the loan.

agent-full-name

This is the full name of the agent user assigned to the loan.

agent-email

This is the email of the agent user assigned to the loan.

agent-phone

This is the phone number of the agent user assigned to the loan.

agent-job-title

This is the job title of the agent user assigned to the loan.

tenant-customer-website

This is the domain of your company’s customer-facing website.

status-escrow-balance-breakdown

This is the breakdown, by escrow account, of the due escrow balance on the loan. Add the ID of any escrow bucket to the end of the variable (e.g. status-escrow-balance-breakdown.9) to make this variable output its balance.

status-delinquent-bucket-date

This is the date of the delinquency bucket with the largest amount on an account.

status-delinquent-bucket-amount 

This is the amount of the delinquency bucket with the largest amount on an account.

status-delinquent-bucket-balance

This variable may be used to display different properties of a selected delinquency bucket on an account.

status-delinquent-bucket

This is the current number of delinquency buckets on an account.

status-period-end 

This is the end date of the current payment period of an account.

status-period-start

This is the start date of the current payment period of an account.

bankruptcy-closed-reason

This is the value of the Closed Reason field for the active bankruptcy on an account

bankruptcy-case-number

This is the value of the Case Number field for the active bankruptcy on an account.

bankruptcy-petition-status

This is the Petition Status of the active bankruptcy on an account.

bankruptcy-chapter

This is the Chapter type of the active bankruptcy on an account.

status-24-dpd-history

Generates the amount past due codes for the same day of the month, per month, for the last 24 months. For more information see: Delinquency History Table.

status-24-dpd-180

Generates the number of times the account has been 180+ days past due in the last 24 months.

status-24-dpd-150

Generates the number of times the account has been 150+ days past due in the last 24 months.

status-24-dpd-120

Generates the number of times the account has been 120+ days past due in the last 24 months.

status-24-dpd-90

Generates the number of times the account has been 90+ days past due in the last 24 months.

status-24-dpd-60

Generates the number of times the account has been 60+ days past due in the last 24 months.

status-24-dpd-30

Generates the number of times the account has been 30+ days past due in the last 24 months.

funding-total-nonmerchantservices-transactions

This is the variable for funding the total nonmerchant transactions.

funding-total-nonmerchantservices-amount

This is the variable for funding the total nonmerchant amount.

funding-total-settledsuccessfully-transactions

This is the variable for funding the total for successful transactions.

funding-total-settledsuccessfully-amount

This is the variable for funding the total for successful amounts.

funding-total-failed-transactions

This is the variable for funding the total of failed transactions.

funding-total-failed-amount

This is the variable for funding total failed amounts.

funding-total-voided-transactions

This is the variable for funding total voided transactions on an account.

funding-total-voided-amount

This is the variable total for a voided account.

funding-total-processing- transactions

This is the variable for the total processing transactions.

funding-total-processing-amount

This is the variable for funding the total of the processing amount on an account.

funding-total-pending-transactions

This is the variable for funding a total on a pending transaction.

funding-transaction-source-company-name

This is the variable for funding a transaction with a source company name.

funding-transaction-customer-name

This is the variable for funding a transaction with a customer name.

funding-transaction-amount

This is the variable for funding a transaction amount on an account.

funding-transaction-check-number

This is the variable for funding a transaction and the check number on that transaction.

funding-transaction-memo

This is the funding transaction memo on an account.

funding-transaction-date

This is the date that funding the transaction was done on.

last-funding-check-number

This is the last funding check number on an account.

last-funding-method

This is the last method used for funding on a loan.

last-funding-name

This is the last funding transaction name.

last-funding-memo

This is the last funding transaction memo on an account.

last-funding-amount

This is the last funding transaction amount.

companyFormatDateTime('last-funding-date')

This is the last funding transaction date on an account.

last-funding-lms-status

This is the last funding transaction LMS status on an account.

last-funding-securepayments-status

This is the last funding transaction secure payment status.


How did we do?


Powered by HelpDocs (opens in a new tab)