Context engine glossary – line of credit and card
The context engine is a large database of retrievable variables, available for use throughout LoanPro software. These are the variables line of credit accounts and cards.
Variable arrays and indexes
Line of credit context engine variables use arrays and indexes to store and retrieve data. Each array has a selection of indexes, which then use a variable to retrieve a specific data point. Let's look at an example of selecting an array, index, and variable to retrieve the start date of a billing period:
[[v('billing-period-values-array.last.start-date')]]
| Array | Index | Variable |
|
One of several array options. This specific array holds billing period values. |
lastOne of several index options for this array. This specific index option represents the most recent result. |
One of several variable options for this array. This specific variable retrieves the start date of the selected billing period. |
Some index options also require you to provide an ID. For example, let's use the same billing period example but select an index ID instead of the most recent index:
[[v('billing-period-values-array.id3.start-date')]]
Additionally, some array options allow you to provide an ID. For example, let's select the status of a customer's card using the card's ID:
[[v('cards-array.id456.card-status')]]
If an ID and index are not provided, all results within the array will be listed.
Below, this article lists all line of credit context engine variables, as well as their associated arrays and indexes if applicable.
All variables
Account information
The variables listed below generate information about the line of credit account.
| Name | Variable | Description |
| Account system ID | [[v('line-of-credit-id')]] | The system-generated ID of the line of credit account. |
| Account display ID | [[v('loan-display-id')]] | The display ID of the line of credit account. This variable applies to both loan and line of credit accounts. |
| Account creation timestamp | [[v('loan-create-time')]] | The display ID of the line of credit account. This variable applies to both loan and line of credit accounts. |
| Account last human activity date | [[v('loan-human-activity-date')]] | The timestamp of when either a human or a human-created automation adjusted the account. This variable applies to both loan and line of credit accounts. |
| Account status | [[v('loan-status')]] | The currently applied status of the account. This variable applies to both loan and line of credit accounts. |
| Account sub-status | [[v('loan-substatus')]] | The currently applied sub-status of the account. This variable applies to both loan and line of credit accounts. |
| Amount past due | [[v('status-amount-past-due')]] | Generates the current amount past due for the line of credit account. |
| Amount due | [[v('status-amount-due')]] | Generates the currently due amount of the account. |
| Days past due | [[v('status-days-past-due')]] | Generates the current number of days past due on the line of credit account. |
| Next due date | [[v('status-next-due-date')]] | Generates the next due date for the line of credit. |
| Next statement date | [[v('status-next-statement-date')]] | Generates the next statement date for the line of credit account, usually congruent with the end of the current billing cycle. |
| Total balance | [[v('status-total-balance')]] | Generates the current total balance of the line of credit account. |
| Credit limit | [[v('status-total-credit-limit')]] | Generates the total credit limit of the line of credit account taking into account any adjustments. |
| Total paid | [[v('status-total-paid')]] | Generates the sum of payments that have been applied to the line of credit. |
| Total balance | [[v('status-total-balance')]] | Generates the current total balance of the account. |
| Total credit limit | [[v('status-total-credit-limit')]] | Generates the current credit limit of the account. |
| Program ID | [[v('product-id')]] | The ID of the line of credit program with which the account is associated. |
Account linking
Line of credit and installment loan accounts can be linked together within LoanPro. These context engine variables are used to retrieve data from accounts that are linked together.
The account-linking-transactions-array holds information regarding transactions that are posted to accounts linked to a line of credit account. Transactions are grouped on the billing cycle from the main line of credit based on their own apply date. Only current and previous billing cycle data can be retrieved, and only linked loan account data is retrieved via these variables. This array supports the following indexes:
currentlast
Replace {index} with a selection from the list above.
Alternatively, all results can be retrieved by using [[v('account-linking-transactions-array')]].
| Name | Variable | Description |
| Account linking main account ID | [[v('account-linking-main-account-id')]] | Generates the ID of the main line of credit account in a linked pair. |
| Linked account transaction ID | [[v('account-linking-transactions-array.{index}.linked-account-id')]] | Generates the ID of the linked account to which a transaction belongs. |
| Linked account transaction title | [[v('account-linking-transactions-array.{index}.linked-account-title')]] | Generates the title of the linked account to which a transaction belongs. |
| Linked account transaction display ID | [[v('account-linking-transactions-array.{index}.linked-account-title')]] | Generates the display ID of the linked account to which a transaction belongs. |
| Linked account transaction type | [[v('account-linking-transactions-array.{index}.transaction-type')]] | Generates the type of the transaction such as payment, credit, fee, advancement, etc. |
| Linked account transaction date | [[v('account-linking-transactions-array.{index}.transaction-date')]] | Generates the apply date of a transaction. |
| Linked account transaction amount | [[v('account-linking-transactions-array.{index}.transaction-amount')]] | Generates the amount of a transaction. |
| Linked account transaction info | [[v('account-linking-transactions-array.{index}.transaction-info')]] | Generates the info/memo/description of a transaction. |
| Linked account transaction due interest | [[v('account-linking-transactions-array.{index}.transaction-due-interest')]] | If the transaction is a payment or credit, this is the interest that was paid by the transaction. |
| Linked account transaction due principal | [[v('account-linking-transactions-array.{index}.transaction-due-principal')]] | If the transaction is a payment or credit, this is the principal that was paid by the transaction. |
| Linked account remaining principal | [[v('account-linking-transactions-array.{index}.linked-account-remaining-principal')]] | The current remaining principal balance of the linked account that the transaction belongs to. |
| Linked account contract date | [[v('account-linking-transactions-array.{index}.linked-account-contract-date')]] | The contract date of the linked account that the transaction belongs to. |
| Linked account first payment date | [[v('account-linking-transactions-array.{index}.linked-account-first-payment-date')]] | The first payment date of the linked account that the transaction belongs to. |
| Linked account transaction index | [[v('account-linking-transactions-array.{index}.transaction-index')]] | This is an arbitrary index since the array is sorted by loan id. Thus, this will show the Nth transaction in this billing cycle for the linked account. |
Billing period values
These variables are used to retrieve data that was captured during a specific billing period. The billing-period-values-array holds information regarding the values from billing cycles/periods that have come and passed on the account. Each billing cycle/period is stored within its own object. This array supports the following indexes:
generated-statementcurrentlastid
Replace {index} with a selection from the list above.
| Name | Variable | Description |
| Billing period ID | [[v('billing-period-values-array.{index}.id')]] | Generates the ID of the billing period. |
| Billing period starting balance | [[v('billing-period-values-array.{index}.starting-balance')]] | Generates the starting balance of the billing period. |
| Billing period payments and credits total | [[v('billing-period-values-array.{index}.payment-credit-total')]] | Provides a sum of the payments and credits applied during the billing period. |
| Billing period fees total | [[v('billing-period-values-array.{index}.fees-total')]] | Provides a sum of the fees applied during the billing period. |
| Billing period interest total | [[v('billing-period-values-array.{index}.interest-total')]] | Provides a sum of the interest applied during the billing period—including manual adjustments for disputes and payment reversals. |
| Billing period minimum payment value | [[v('billing-period-values-array.{index}.minimum-payment')]] | Generates the minimum payment value of the billing period. |
| Billing period ending balance | [[v('billing-period-values-array.{index}.new-balance')]] | Generates the ending balance of the billing period. |
| Billing period starting available credit | [[v('billing-period-values-array.{index}.previous-available-credit')]] | Generates the available balance of the account at the start of the billing period. |
| Billing period ending available credit | [[v('billing-period-values-array.{index}.new-available-credit')]] | Generates the available balance of the account at the end of the billing period. |
| Billing period start date | [[v('billing-period-values-array.{index}.start-date')]] | Generates the start date of the billing period. |
| Billing period end date | [[v('billing-period-values-array.{index}.end-date')]] | Generates the end date of the billing period. |
| Billing period due date | [[v('billing-period-values-array.{index}.due-date')]] | Generates the due date of the billing period. |
| Billing period # of minimum payment payoff months | [[v('billing-period-values-array.{index}.minimum-payment-payoff-months')]] | The total number of months that it would take to pay the account to zero assuming only the minimum payment is made each billing cycle on the due date. |
| Billing period minimum payment payoff interest | [[v('billing-period-values-array.{index}.minimum-payment-payoff-interest')]] | The total interest paid while paying the account to zero if only paying the minimum payment each billing cycle. |
| Billing period minimum payment payoff total | [[v('billing-period-values-array.{index}.minimum-payment-payoff-total')]] | The total amount paid while paying the account to zero if only paying the minimum payment each billing cycle. |
| Billing period 36-month minimum payment amount | [[v('billing-period-values-array.{index}.36-month-minimum-payment-amount')]] | The minimum payment amount that must be made each billing cycle to pay off the account within 36 months. |
| Billing period 36-month interest paid | [[v('billing-period-values-array.{index}.36-month-total-interest-paid')]] | The minimum payment amount that must be made each billing cycle to pay off the account within 36 months. |
| Billing period 36-month principal paid | [[v('billing-period-values-array.{index}.36-month-total-principal-paid')]] | The total principal paid while only paying the 36-month minimum payment amount each billing cycle (generally just the new balance). |
| Billing period statement PDF | [[v('billing-period-values-array.{index}.statement-pdf-attachment')]] | A LoanPro specific URL to the statement PDF generated for the billing cycle. This can only be accessed in an email type notification, typically to provide the statement within an email. |
| Billing period ending amount past due | [[v('billing-period-values-array.{index}.ending-amount-past-due')]] | The amount past due of the account as of the end of the billing cycle. |
Billing period buckets
Nested within the billing-period-values-array is an additional buckets-array. Extracting data from this nested array is beneficial when you need details not only from a billing period but also the bucket in which those details were captured. This array supports the following indexes:
id
Since this is an array nested within another array, make sure to select an index for the billing-period-values-array as well. Here's an example:
[[v('billing-period-values-array.last.buckets-array.id2.balance')]]
| Name | Variable | Description |
| Billing period bucket balance | [[v('billing-period-values-array.{index}.buckets-array.id{id}.balance')]] | The balance of the bucket as of the end of the billing cycle. |
| Billing period bucket fees total | [[v('billing-period-values-array.{index}.buckets-array.id{id}.fees-total')]] | The sum of charges/fees applied to the bucket during the billing cycle. |
| Billing period bucket interest bearing amount | [[v('billing-period-values-array.{index}.buckets-array.id{id}.interest-bearing-amount')]] | The interest bearing balance of the bucket during the billing cycle. For buckets that use Daily Balance as a calculation type, this is the average for the period. |
| Billing period bucket remaining interest charges | [[v('billing-period-values-array.{index}.buckets-array.id{id}.remaining-interest-charges')]] | The outstanding/unpaid interest charges for the bucket as of the end of the period. |
| Billing period bucket interest charges | [[v('billing-period-values-array.{index}.buckets-array.id{id}.interest-charges')]] | The total interest charges applied to the bucket during the billing cycle. |
| Billing period bucket payments and credits | [[v('billing-period-values-array.{index}.buckets-array.id{id}.payments-and-credits')]] | The sum of payments and credits that were specifically applied to the bucket during the billing cycle. |
| Billing period bucket total swipes | [[v('billing-period-values-array.{index}.buckets-array.id{id}.total-swipes')]] | The sum of swipes applied to the bucket during the billing cycle. |
| Billing period bucket interest accrual boolean | [[v('billing-period-values-array.{index}.buckets-array.id{id}.keep-accruing-interest?')]] | Returns whether or not this bucket was still accruing interest as of the end of the period. |
| Billing period bucket title | [[v('billing-period-values-array.{index}.buckets-array.id{id}.bucket-title')]] | The title of the bucket. |
| Billing period bucket available credit | [[v('billing-period-values-array.{index}.buckets-array.id{id}.available-credit')]] | The available balance/available credit of the bucket as of the end of the period. |
Buckets
These variables retrieve current values for a specified bucket, as stored within the buckets-array. This array supports the following indexes:
id
Alternatively, all buckets can be retrieved by using [[v('buckets-array')]].
| Name | Variable | Description |
| Bucket balance | [[v('buckets-array.id{id}.bucket-balance')]] | The current balance of the bucket. |
| Bucket available credit | [[v('buckets-array.id{id}.available-credit')]] | The current available balance of the bucket. |
| Bucket interest rate | [[v('buckets-array.id{id}.interest-rate')]] | The current interest rate of the bucket. |
| Bucket interest charge method | [[v('buckets-array.id{id}.interest-charge-method')]] | The interest rate charge method of the bucket. |
| Bucket computation method | [[v('buckets-array.id{id}.computation-method')]] | The computation method of the bucket. |
| Bucket carried balance bracket | [[v('buckets-array.id{id}.carried-balance-bracket')]] | If interest charge method is set as Carried Balance Brackets, this returns the bracket used to calculate the finance charge. |
| Bucket total credit limit | [[v('buckets-array.id{id}.total-credit-limit')]] | The current total credit limit of the bucket. |
| Bucket primary | [[v('buckets-array.id{id}.primary')]] | Returns whether the bucket is primary for the account. |
| Bucket title | [[v('buckets-array.id{id}.title')]] | The title of the bucket. |
Cards
An array of information regarding the cards associated with the LOC. These values are stored within the cards-array, with support for the following index:
id
Alternatively, all associated cards can be retrieved by using [[v('cards-array')]].
| Name | Variable | Description |
| Card ID | [[v('cards-array.id{id}.id')]] | The LMS ID of the card. |
| Associated customer ID | [[v('cards-array.id{id}.customer-id')]] | The LMS ID of the customer associated with the card. |
| Associated customer name | [[v('cards-array.id{id}.customer-name')]] | The name of the customer associated with the card. |
| Associated customer role | [[v('cards-array.id{id}.customer-role')]] | The role of the customer associated with the card. |
| Associated cash advance bucket ID | [[v('cards-array.id{id}.cash-advance-bucket-id')]] | The ID of the cash advance bucket associated with the card. |
| Card name | [[v('cards-array.id{id}.card-name')]] | The name of the card. |
| Created timestamp | [[v('cards-array.id{id}.created')]] | The timestamp of when the card was created. |
| Last updated timestamp | [[v('cards-array.id{id}.last-updated')]] | The timestamp of when the card was last updated. |
| Available balance | [[v('cards-array.id{id}.available-balance')]] | The current available balance of the card. |
| Available advance balance | [[v('cards-array.id{id}.available-advance-balance')]] | The current available cash advance balance of the card. |
| Spend limit | [[v('cards-array.id{id}.spent-limit')]] | The spend limit of the card. |
| Spend limit interval | [[v('cards-array.id{id}.spend-limit-interval')]] | The spend limit interval of the card. |
| Card currency | [[v('cards-array.id{id}.card-currency')]] | The currency used by the card. |
| Network | [[v('cards-array.id{id}.network')]] | The network on which the card exists, such as Visa, Mastercard, etc. |
| Card type | [[v('cards-array.id{id}.card-type')]] | The type of the card, such as virtual, physical, or hybrid. |
| Cash advance bucket title | [[v('cards-array.id{id}.cash-advance-bucket-title')]] | The title of the cash advance bucket associated with the card. |
| Card status | [[v('cards-array.id{id}.card-status')]] | The status of the card, such as active, blocked, etc. |
Charges
An array of information regarding the charges or fees that have been applied to an account. These values are stored within the charges-array, which supports the following indexes:
id
Alternatively, all charges can be retrieved by using [[v('charges-array')]].
| Name | Variable | Description |
| Charge ID | [[v('charges-array.id{id}.id')]] | The ID of the charge. |
| Charge apply date | [[v('charges-array.id{id}.apply-date')]] | The date on which the charge applied to the account. |
| Charge status | [[v('charges-array.id{id}.status')]] | The current status of the charge. |
| Charge bucket ID | [[v('charges-array.id{id}.bucket-id')]] | The bucket in which the charge was applied. |
| Charge amount | [[v('charges-array.id{id}.amount')]] | The amount of the charge. |
| Charge description | [[v('charges-array.id{id}.description')]] | The description or memo of the charge. |
| Charge billing cycle | [[v('charges-array.id{id}.billing-cycle')]] | The billing cycle/period in which the charge was applied. |
| Charge interest bearing status | [[v('charges-array.id{id}.interest-bearing')]] | Returns whether the charge is accruing interest or not. |
Checklists
An array containing information about the current values of all checklist items for the account. These values are stored within the checklist-array, which supports the following indexes:
id
Alternatively, all checklist values can be retrieved by using [[v('checklist-array')]].
| Name | Variable | Description |
| Checklist value | [[v('checklist-array.id{id}.value')]] | Returns whether or not the checklist item is checked as “1” or “0”. |
| Checklist last updated datetime | [[v('checklist-array.id{id}.last-updated')]] | The timestamp of when the checklist item was last updated. |
Computation fields
An array containing information about the current computation field values for the account. These values are stored within the computation-fields-array, which supports the following indexes:
id
Alternatively, all values can be retrieved by using [[v('computation-fields-array')]].
| Name | Variable | Description |
| Computation field calculated value | [[v('computation-fields-array.id{id}.value')]] | Returns the calculated value of the computation field. |
Credits
An array of information regarding the credits that have been applied to an account. These values are stored within the credits-array, which supports the following indexes:
id
Alternatively, all credits can be retrieved by using [[v('credits-array')]].
| Name | Variable | Description |
| Credit ID | [[v('credits-array.id{id}.id')]] | The ID of the credit. |
| Credit apply date | [[v('credits-array.id{id}.apply-date')]] | The date on which the credit applied to the account. |
| Credit amount | [[v('credits-array.id{id}.amount')]] | The amount of the credit. |
| Credit description | [[v('credits-array.id{id}.description')]] | The description or memo of the credit. |
| Credit status | [[v('credits-array.id{id}.status')]] | The current status of the credit. |
| Credit billing cycle | [[v('credits-array.id{id}.billing-cycle')]] | The billing cycle/period in which the credit was applied. |
| Credit payment type ID | [[v('credits-array.id{id}.payment-type-id')]] | The payment type ID used to add the credit. This determines how the credit was allocated across components such as interest and principal. |
Customers and users
For details regarding retrieving customer data, see Context engine glossary - customer.
For line of credit accounts, additional users are also available.
| Name | Variable | Description |
| Additional users | [[v('additional-users')]] | A string that contains a csv list of the full names of all "additional" customers assigned to the account (not primary or secondary). |
Finance charges
An array of information regarding the finance charges that have been applied to an account. These values are stored within the finance-charges-array, which supports the following indexes:
idlast
Replace {index} with a selection from the list above.
Alternatively, all finance charges can be retrieved by using [[v('finance-charges-array')]].
| Name | Variable | Description |
| Finance charge ID | [[v('finance-charges-array.{index}.id')]] | The ID of the finance charge. |
| Finance charge apply date | [[v('finance-charges-array.{index}.apply-date')]] | The date on which the finance charge applied to the account. |
| Finance charge status | [[v('finance-charges-array.{index}.status')]] | The current status of the charge. |
| Finance charge bucket ID | [[v('finance-charges-array.{index}.bucket-id')]] | The bucket in which the charge was applied. |
| Finance charge amount | [[v('finance-charges-array.{index}.amount')]] | The amount of the charge. |
| Finance charge description | [[v('finance-charges-array.{index}.description')]] | The description or memo of the charge. |
| Finance charge billing cycle | [[v('finance-charges-array.{index}.billing-cycle')]] | The billing cycle/period in which the charge was applied. |
| Finance charge manually created status | [[v('finance-charges-array.{index}.manually-created')]] | Returns whether the finance charge was manually created. Typically, finance charges are created automatically as billing period calculations are finalized. |
Increase balance transactions
An array of information that pertains to any transaction that increased the balance of the account. This includes swipes, fees, and finance charges. Each transaction is grouped by the billing cycle/period in which it applied. These values are stored within the increase-balance-transactions-array, which supports the following indexes:
idcurrentlast
Replace {index} with a selection from the list above.
Alternatively, all increase balance transactions can be retrieved by using [[v('increase-balance-transactions-array')]].
| Name | Variable | Description |
| Transaction date | [[v('increase-balance-transactions-array.{index}.date')]] | The date on which the transaction applied to the account. |
| Transaction amount | [[v('increase-balance-transactions-array.{index}.amount')]] | The amount of the transaction. |
| Transaction status | [[v('increase-balance-transactions-array.{index}.status')]] | The status of the transaction. |
| Transaction memo | [[v('increase-balance-transactions-array.{index}.memo')]] | The description or memo of the transaction. |
| Transaction billing period start date | [[v('increase-balance-transactions-array.{index}.start-date')]] | The start date of the billing period in which the transaction is applied. |
| Transaction billing period end date | [[v('increase-balance-transactions-array.{index}.end-date')]] | The end date of the billing period in which the transaction is applied. |
| Transaction type | [[v('increase-balance-transactions-array.{index}.type')]] | The type of transaction, whether it be a swipe, fee, or finance charge. |
Interest rate adjustments
An array of information regarding the interest rate adjustments applied to an account. These values are stored within the interest-rate-adjustments-array, which supports the following indexes:
idlast
Replace {index} with a selection from the list above.
Alternatively, all interest rate adjustments can be retrieved by using [[v('interest-rate-adjustments-array')]].
| Name | Variable | Description |
| Interest rate adjustment ID | [[v('interest-rate-adjustments-array.{index}.id')]] | The ID of the interest rate adjustment. |
| Interest rate adjustment bucket ID | [[v('interest-rate-adjustments-array.{index}.bucket-id')]] | The ID of the bucket to which the adjustment was applied. |
| Interest rate adjustment bucket title | [[v('interest-rate-adjustments-array.{index}.bucket-title')]] | The title of the bucket to which the adjustment was applied. |
| Interest rate adjustment date | [[v('interest-rate-adjustments-array.{index}.date')]] | The date on which the adjustment was applied. |
| Interest rate adjustment title | [[v('interest-rate-adjustments-array.{index}.title')]] | The title of the interest rate adjustment transaction. |
| Interest rate adjustment new rate | [[v('interest-rate-adjustments-array.{index}.new-rate')]] | The new rate of an interest rate adjustment transaction. |
| Interest rate adjustment old rate | [[v('interest-rate-adjustments-array.{index}.old-rate')]] | The old rate of an interest rate adjustment transaction. |
| Interest rate adjustment created timestamp | [[v('interest-rate-adjustments-array.{index}.created')]] | The datetime of when the interest rate adjustment was created. |
| Interest rate adjustment created active status | [[v('interest-rate-adjustments-array.{index}.active')]] | Returns whether or not the transaction is currently active and applied to the account. |
| Interest rate adjustment last updated timestamp | [[v('interest-rate-adjustments-array.{index}.last-updated')]] | The datetime of when the interest rate adjustment was last updated. |
Line of credit transactions
An array of information regarding all transactions that have applied to an account, including swipes, fees, finance charges, payments, and credits. These values are stored within the loc-transactions-array, which supports the following indexes:
idcurrentlast
Replace {index} with a selection from the list above.
Alternatively, all transactions can be retrieved by using [[v('loc-transactions-array')]].
| Name | Variable | Description |
| Transaction date | [[v('loc-transactions-array.{index}.date')]] | The date on which the transaction was applied to the account. |
| Transaction amount | [[v('loc-transactions-array.{index}.amount')]] | The amount of the transaction. |
| Transaction status | [[v('loc-transactions-array.{index}.status')]] | The current status of the transaction. |
| Transaction memo | [[v('loc-transactions-array.{index}.memo')]] | The memo or description of the transaction. |
| Transaction billing cycle start date | [[v('loc-transactions-array.{index}.start-date')]] | The start date of the billing cycle in which the transaction was applied. |
| Transaction billing cycle end date | [[v('loc-transactions-array.{index}.end-date')]] | The end date of the billing cycle in which the transaction was applied. |
| Transaction type | [[v('loc-transactions-array.{index}.type')]] | The type of the transaction, whether it's a swipe, fee, finance charge, payment, or credit. |
| Transaction merchant | [[v('loc-transactions-array.{index}.merchant')]] | If the transaction is a swipe, this is the name of the merchant at which the transaction was made. |
| Transaction bucket label | [[v('loc-transactions-array.{index}.bucket-label')]] | If a transaction is assigned to a bucket, this returns the title of the bucket. |
Next Autopay
These variables return information regarding the upcoming AutoPay scheduled for the account.
| Name | Variable | Description |
| Next AutoPay amount | [[v('next-autopay-amount')]] | The amount of the next AutoPay. |
| Next AutoPay apply date | [[v('next-autopay-apply-date')]] | The date on which the next AutoPay is scheduled to apply to the account. |
| Next AutoPay date | [[v('next-autopay-date')]] | The date on which the next AutoPay is scheduled to process on the account. |
| Next AutoPay ID | [[v('next-autopay-id')]] | The ID of the next AutoPay. |
| Next AutoPay payment method ID | [[v('next-autopay-pmt-method-id')]] | The chosen payment method of the next AutoPay. |
| Next AutoPay remaining periods | [[v('next-autopay-remaining-periods')]] | The number of remaining payments for the AutoPay if the AutoPay is set to recur. |
Payments
An array of information regarding all payments that have applied to an account. These values are stored within the payments-array, which supports the following indexes:
idlast-payment
Replace {index} with a selection from the list above.
Alternatively, all payments can be retrieved by using [[v('payments-array')]].
| Name | Variable | Description |
| Payment amount | [[v('payments-array.{index}.payment-amount')]] | The amount of the payment. |
| Payment date | [[v('payments-array.{index}.payment-date')]] | The date on which the payment applied to the account. |
| Payment status | [[v('payments-array.{index}.status')]] | The current status of the payment, whether pending, settled, active, ect. |
| Payment info | [[v('payments-array.{index}.payment-info')]] | The info or memo associated with the payment. |
| Payment ID | [[v('payments-array.{index}.system-id')]] | The ID of the payment. |
| Payment method | [[v('payments-array.{index}.payment-method')]] | The method used to make the payment. |
Portfolios and sub-portfolios
An array of information regarding the portfolios associated with the account. These values are stored within the portfolio-array, which supports the following indexes:
id
Alternatively, all portfolios can be retrieved by using [[v('portfolio-array')]].
| Name | Variable | Description |
| Portfolio title | [[v('portfolio-array.{id}.title')]] | The title of the portfolio. |
| Portfolio active status | [[v('portfolio-array.{id}.active')]] | Returns whether the portfolio is currently associated with the account (active) or not. |
Sub-portfolio information is stored within the sub-portfolio-array which supports the following indexes:
id
Alternatively, all sub-portfolios can be retrieved by using [[v('sub-portfolio-array')]].
| Name | Variable | Description |
| Sub-portfolio title | [[v('sub-portfolio-array.{id}.title')]] | The title of the sub-portfolio. |
| Sub-portfolio active status | [[v('sub-portfolio-array.{id}.active')]] | Returns whether the portfolio is currently associated with the account (active) or not. |
| Sub-portfolio parent ID | [[v('sub-portfolio-array.{id}.parent')]] | Returns the ID of the parent porfolio. |
Settings
These values return information regarding the line of credit settings configurations associated with the account. Loan and line of credit accounts share settings context engine variables. For details regarding retrieving account settings information, see Context engine glossary - settings.
Setup
These values return information regarding the line of credit setup configurations associated with the account.
| Name | Variable | Description |
| Setup Custom Fields array | [[v('setup-custom-fields-array')]] | Returns all setup Custom Fields associated with the account. |
| Setup Custom Field value | [[v('setup-custom-fields-array.id{id}.value')]] | Returns the value stored within a specific setup Custom Field. |
| Draw period expiration date | [[v('setup-draw-period-expiration-date')]] | The date on which swipes are no longer accepted for the account. |
| First due date | [[v('setup-first-due-date')]] | The date on which the first payment is due for the account. |
| First statement date | [[v('setup-first-statement-date')]] | The date on which the first statement is generated for the account. |
| Grace period days | [[v('setup-grace-period-days')]] | The number of days between the first statement date and first due date. |
| Setup ID | [[v('setup-id')]] | The ID that represents the setup configuration on the account. |
| Late fee amount | [[v('setup-late-fee-amount')]] | The static amount used in late fee calculations. |
| Late fee percentage | [[v('setup-late-fee-percent')]] | The percentage amount used in late fee calculations. |
| Open date | [[v('setup-open-date')]] | The date on which the account was opened. |
| Statement frequency | [[v('setup-statement-frequency')]] | The frequency in which statements are generated for the account. |
Source companies and tracking
These values return information regarding the Source Companies associated with the account.
| Name | Variable | Description |
| Source company name | [[v('source-company')]] | The name of the associated Source Company. |
| Source company address 1 | [[v('source-company-address1')]] | The address line 1 of the associated Source Company. |
| Source company address 2 | [[v('source-company-address2')]] | The address line 2 of the associated Source Company. |
| Source company city | [[v('source-company-city')]] | The city of the associated Source Company. |
| Source company contact name | [[v('source-company-contact')]] | The name of the contact for the associated Source Company. |
| Source company contact email | [[v('source-company-contact-email')]] | The email address of the contact for the associated Source Company. |
| Source company contact phone | [[v('source-company-contact-phone')]] | The phone number of the contact for the associated Source Company. |
| Source company country | [[v('source-company-country')]] | The country of the associated Source Company. |
| Source company id | [[v('source-company-id')]] | The ID of the associated Source Company. |
| Source company number prefix | [[v('source-company-num-prefix')]] | The number prefix used in account display IDs associated with this Source Company. |
| Source company number suffix | [[v('source-company-num-suffix')]] | The number suffix used in account display IDs associated with this Source Company. |
| Source company state | [[v('source-company-state')]] | The state of the associated Source Company. |
| Source company zip code | [[v('source-company-zipcode')]] | The zip code of the associated Source Company. |
Swipes
Swipes are purchase transactions made on a card. The swipes-array holds information regarding swipes that have been posted to an account—including data such as swipe date, location, MCC, and more.
These values are stored within the swipes-array, which supports the following indexes:
idlast
Replace {index} with a selection from the list above.
Alternatively, all swipes can be retrieved by using [[v('swipes-array')]].
| Name | Variable | Description |
| Swipe ID | [[v('swipes-array.{index}.id')]] | Generates the ID of the swipe. |
| Swipe apply date | [[v('swipes-array.{index}.apply-date')]] | Generates the date on which the swipe applied to the account. |
| Swipe settled date | [[v('swipes-array.{index}.settled-date')]] | Generates the settled date of the swipe, meaning when the funds have moved and the amount was cleared. |
| Swipe amount | [[v('swipes-array.{index}.amount')]] | Generates amount of the swipe. |
| Swipe memo | [[v('swipes-array.{index}.memo')]] | Generates the memo/descriptor included in the swipe. |
| Swipe status | [[v('swipes-array.{index}.status')]] | Generates the current status of the swipe. |
| Merchant | [[v('swipes-array.{index}.merchant')]] | Generates the name of the merchant that authorized the swipe. |
| Merchant logo | [[v('swipes-array.{index}.merchant-logo-url')]] | Generates the merchant's logo if applicable. |
| Merchant transaction ID | [[v('swipes-array.{index}.merchant-transaction-id')]] | If available, this will generate the ID of the transaction from the merchant's side. |
| Merchant category code | [[v('swipes-array.{index}.merchant-category-code')]] | Generates the merchant category code (MCC) of the corresponding merchant. |
| Merchant categories | [[v('swipes-array.{index}.merchant-categories')]] | Generates a .csv list of merchant categories associated with the corresponding merchant. |
| Merchant information | [[v('swipes-array.{index}.merchant-info')]] | Generates raw information regarding the merchant from the network. |
| Subscriptions and recurring charges | [[v('swipes-array.{index}.merchant-recurring')]] | Indicates whether this is a recurring charge from the same merchant, such as a subscription. |
| Billing cycle | [[v('swipes-array.{index}.billing-cycle')]] | Generates the billing cycle in which the swipe was categorized according to the apply date. |
| Merchant address line 1 | [[v('swipes-array.{index}.merchant-address1')]] | Generates the first line of the merchant's address. |
| Merchant address line 2 | [[v('swipes-array.{index}.merchant-address2')]] | Generates the second line of the merchant's address. |
| Merchant city | [[v('swipes-array.{index}.merchant-city')]] | Generates the city corresponding with the merchant's address. |
| Merchant state | [[v('swipes-array.{index}.merchant-state')]] | Generates the state corresponding with the merchant's address. |
| Merchant country | [[v('swipes-array.{index}.merchant-country')]] | Generates the country corresponding with the merchant's address. |
| Merchant zip code | [[v('swipes-array.{index}.merchant-zip')]] | Generates the zip code corresponding with the merchant's address. |
| Merchant latitude | [[v('swipes-array.{index}.merchant-geo-lat')]] | Generates the latitude value of the merchant's location to 7 decimal places. |
| Merchant longitude | [[v('swipes-array.{index}.merchant-go-lon')]] | Generates the longitude value of the merchant's location to 7 decimal places. |
| Bucket ID | [[v('swipes-array.{index}.bucket-id')]] | Generates the ID of the bucket in which the swipe was categorized. |
| Bucket title | [[v('swipes-array.{index}.bucket-title')]] | Generates the title of the bucket in which the swipe was categorized. |
Was this article helpful?
Unclassified Public Data