Variables for customized content

You can use variables in any position of the customized content. This section provides the lists of variables that you can include in receipts and endorsement.

To gain a visual understanding on how the variables affect the generated receipt or endorsement, see Example of customized content.

Variable Description
$businessDate$ The date of payment.
$contactName$ The contact name of the payer who makes the payment.
$contactType The contact type of the contact.
$permitNBR$ The record number.
$refContactID$ The reference contact ID number.
$todayDate$ The current date.
$transNBR$ The transaction number.
Variable Description
$adminFeeDue$ The administrator fee. This value is always 0.
$balance$ The difference between the amount of money invoiced and the amount of money paid; the balance due.
$businessDate$ The date of payment.
$cashDrawerID$ The cashier's drawer ID number.
$changeDue$ The balance if the payment amount is more than the amount due.
$checkAmount$ The check amount.
$checkTendered$ The money received from check.
$operateID$ The cashier's user ID.
$payerContactType$ The contact type of the payer.
$payerName$ The payer name.
$payerRefContactID$ The reference contact ID of the payer.
$paymentMethodAndAmount$ The payment method and payment amount.
Pemit Fee Due

The value can be Permit, Licenses or Gen/Var.

Note: Unlike other variables, this variable uses no “$$” delimiters.
$permitFeeDue$ The fee due in the record.
$permitNBR$ The record number.
$receiptNbr$ The receipt number.
$refNBR$ If the payment method was a check or some other document, such as a money order, this is the check number or number that appears on the document.
$sessionNbr$ The cashier session sequence number.
$todayDate$ The current date.
$totalAmtPaid$ The total payment amount.
$totalInvoice$ The total invoice amount.
$totalPaid$ The total amount already paid.
$transNBR$ The transaction number.
Variable Description
$authorizationCode$ The check authorization code.
$batchNumber$ The batch number of the invoice.
$businessDate$ The date of payment.
$cashDrawerID$ The cashier's drawer ID number.
$checkNumber$ The check number.
$checkType$ The check type.
$convenienceFee$ A fee assessed to cover the cost of processing.
$feeDue$ The fee due.
$hostCode$ The authorization code returned from third party
$objectID$ The ID of the record or set for which a user is processing payment.
$objectType$ The entity type (such as record) for which a user is processing payment.
$operatorID$ The cashier's user ID.
$processingFee$ The processing fee.
$referenceID$ If the payment method was a check or some other document, such as a money order, this is the check number or number that appears on the document.
$totalAmount$ The total payment amount.
$transactionID$ The transaction ID.
Variable Description
$authorizationCode$ The credit card authorization code.
$batchNumber$ The batch number of the invoice.
$businessDate$ The date of payment.
$cardNumber$ The credit card number.
$cardType$ The credit card type.
$cashDrawerID$ The cashier's drawer ID number.
$convenienceFee$ A fee assessed to cover the cost of processing.
$feeDue$ The fee due.
$hostCode$ The authorization code returned from third party
$objectID$ The ID of the record or set for which a user is processing payment.
$objectType$ The entity type for which a user is processing payment. Allowable values are: SET, Permit, POS, Trust account, Transaction, or Group.
$operatorID$ The cashier's user ID.
$processingFee$ The processing fee.
$referenceID$ If the payment method was a check or some other document, such as a money order, this is the check number or number that appears on the document.
$totalAmount$ The total payment amount.
$transactionID$ The transaction ID.
Variable Description
$adminFeeDue$ The administrator fee. This value is always 0.
$balance$ The difference between the amount of money invoiced and the amount of money paid; the balance due.
$businessDate$ The date of payment.
$cashDrawerID$ The cashier's drawer ID number.
$changeDue$ The balance if the payment amount is more than the amount due.
$checkAmount$

The check amount.

Note: You can replace “check” with another payment method in the variable name, such as, $cashAmount$. The variable stands for the amount by the payment method.
$checkTendered$ The money received from check.
$feeItems$ The fee items.
$operateID$ The cashier's user ID.
$paymentMethodAndAmount$ The payment method and payment amount.
Pemit Fee Due

The value can be Permit, Licenses or Gen/Var.

Note: Unlike other variables, this variable uses no “$$” delimiters.
$permitNBR$ The record number.
$receiptNbr$ The receipt number.
$receivedType$ The form of payment.
$refNBR$ If the payment method was a check or some other document, such as a money order, this is the check number or number that appears on the document.
$sessionNbr$ The cashier session sequence number.
$todayDate$ The current date.
$totalAmtPaid$ The total payment amount.
$totalInvoice$ The total invoice amount.
$totalPaid$ The total amount already paid.
$transNBR$ The transaction number.
Variable Description
$adminFeeDue$ The administrator fee. This value is always 0.
$balance$ The difference between the amount of money invoiced and the amount of money paid; the balance due.
$businessDate$ The date of payment.
$cashDrawerID$ The cashier's drawer ID number.
$changeDue$ The balance if the payment amount is more than the amount due.
$checkAmount$ The check amount.
$checkAmount$

The check amount.

Note: You can replace “check” with another payment method in the variable name, for example, $cashAmount$. The variable stands for the amount by the payment method.
$checkTendered$ The money received from check.
$feeItems$

The fee items.

Note: This variable is applicable in SET_RECEIPT_SUMMARY, not in SET_CHECK_ENDORSEMENT.
$operateID$ The cashier's user ID.
$paymentMethodAndAmount$ The payment method and payment amount.
$permitFeeDue$ The fee due in the record.
$receiptNbr$ The receipt number.
$receivedType$

The form of payment.

Note: This variable is applicable in SET_RECEIPT_SUMMARY, not in SET_CHECK_ENDORSEMENT.
$refNBR$ If the payment method was a check or some other document, such as a money order, this is the check number or number that appears on the document.
$sessionNbr$ The cashier session sequence number.
$setId$ The identification number of the set for which you are processing payment.
$setName$ The name of the set for which you are processing payment.
$todayDate$ The current date.
$totalAmtPaid$ The total payment amount.
$totalInvoice$ The total invoice amount.
$totalPaid$ The total amount already paid towards the set invoice.
$transNBR$ The transaction number.
Variable Description
$businessDate$ The date of payment.
$cashierDrawID$ The cashier's drawer ID number.
$forPermitNbr$ The record number for which a user is processing payment.
$forPOSTransNbr$ The POS transaction number for which a user is processing payment.
$paymentMethodAndAmount$ The payment method and payment amount.
$receiptNbr$ The receipt number.
$sessionNbr$ The cashier session sequence number.
$todayDate$ The current date.
$totalAmtPaid$ The total payment amount.
Variable Description
$adminFeeDue$ The administrator fee. This value is always 0.
$ATMTendered$ The money received from ATM.
$balance$ The difference between the amount of money invoiced and the amount of money paid; the balance due.
$billedTendered$ The money received from bill.
$businessDate$ The date of payment.
$cashierDrawID$ The cashier's drawer ID number.
$cashTendered$ The money received from cash.
$changeDue$ The balance if the payment amount is more than the amount due.
$checkTendered$ The money received from check.
$couponTendered$ The money received from a coupon.
$creditCardTendered$ The money received from a credit card.
$currentAmtPaid$ The current amount paid.
$debitCardTendered$ The money received from a debit card.
$feeItems$ The fee items.
$forPermitNbr$ The record number for which a user is processing payment.
$forPOSTransNbr$ The POS transaction number for which a user is processing payment.
$internalTransferTendered$ The money received from internal transfer.
$journalEntryTendered$ The money received from journal entry.
$lockboxTendered$ The money received from a lock box.
$miscCreditTendered$ The money received from miscellaneous credit.
$moneyOrderTendered$ The money received from money order.
$multipleTendersTendered$ The money received from multiple tenders.
$operatorID$ The cashier's user ID.
$otherTendered$ The money received from other payment methods.
$permitFeeDue$ The fee due in the record.
$receiptNbr$ The receipt number.
$receivedType$ The form of payment.
$sessionNbr$ The cashier session sequence number.
$todayDate$ The current date.
$totalAmtPaid$ The total payment amount.
$totalInvoiceAmount$ The total invoice amount.
$totalPayment$ The total amount already paid.
$trustAccountTendered$ The money received from trust account.
$unapplied$ The credit that has not been applied.
$waiverTendered$ The money received from waiver.
$writeOffTendered$ The money received from write off.
Variable Description
$accountBalance$ The balance of the trust account.
$accountNBR$ The trust account ID number for the trust account.
$amount$ The payment amount.
$businessDate$ The date of payment.
$cashDrawerID$ The cashier's drawer ID number.
$refNBR$ If the payment method was a check or some other document, such as a money order, this is the check number or number that appears on the document.
$sessionNbr$ The cashier session sequence number.
$tenderType$ The payment type.
$todayDate$ The current date.
$transComments$ The comments added in the transaction.
$transNBR$ The transaction number.
$transType$ The transaction type.

This code snippet is an example of the content for the RECEIPT_SUMMARY content type:

The functioning variables for RECEIPT_SUMMARY are as following:  
--------------- 
Record Receipt Summary Template  
 
Session Nbr: $sessionNbr$ 
Trans NBR: $transNBR$ 
For Permit Nbr: $permitNBR$ 
Business Date: $businessDate$ 
Today Date: $todayDate$ 
Permit Fee Due: $permitFeeDue$ 
Admin Fee Due: $adminFeeDue$ 
Total Amt Paid: $totalAmtPaid$ 
Operate ID: $operateID$ 
 
CashDrawerID: $cashDrawerID$ 
 
Fee Items  
$feeItems$ 
 
Total Invoice Amount: $totalInvoice$ 
Total Payment: $totalPaid$ 
Balance: $balance$ 
---------------- 
$paymentMethodAndAmount$ 
Change Due: $changeDue$ 
Cash Tendered: $cashAmount$ 
Check Tendered: $checkAmount$ (Ref#$checkTendered$)  
Ref: $refNBR$ 
 
payor:$payor$

With this example, Civic Platform generates the receipt summary for a record as shown below: