Cashier.Name Cashier's full name, first & last
Cashier.Firstname Cashier's first name only
Cashier.ID ID in the cashier table for this cashier
Cashier.Loaded Returns true when a cashier has been loaded.
Cashier.Number Cashier's Number
Store.CityStateZip Combination of CityState and Zip Code
Store.ZipCity Combination of Zip Code and City
Store.VATRregistrationNumber Used only in VAT countries (Europe, Australia...)
Transaction.Balance For internal use only
Transaction.ChangeFoodStamp Amount of change in food stamps to be returned to the customer.
Transaction.Datetime Date and time the transaction was processed.
Transaction.OrderBalance Balance for the layaway, work order, quote or back order at the time it was recalled.
Transaction.OrderBalanceNew Current balance for the layaway, work order, quote or back order including the present transaction.
Transaction.OrderID ID in the order table for this layaway, work order, quote or back order.
Transaction.Deposit Amount of deposit being applied in the current work order, quote, back
order or layaway.
Transaction.DepositPrevious Deposit paid for the layaway, work order, quote or back order at the time it was recalled.
Transaction.DepositTotal Total deposit for the order including present & previous.
Transaction.Discount Discount in currency.
Transaction.DiscountMethod Method of discount being applied for the current transaction:
discountmethodNone = 0
discountmethodDiscountFromRetail = 1
discountmethodDiscountFromCurrentPrice = 2
discountmethodMarkupFromCost = 3
discountmethodProfitMargin = 4
Transaction.DiscountPercent Discount in percentage
Transaction.DiscountPurchased Discount in currency for the amounts being purchased. In a sale this is the total amount, in an order is on the amount being picked up.
Transaction.Name Text for the transaction type, i.e., "Sales", Work Order".
Transaction.Number Indicates the TransactionNumber as stored in the Transaction table. Applicable for sales transactions or pickups on orders.
Transaction.Payment Total payment being applied to A/R's.
Transaction.PriceLevel Price level being applied for the transaction:
pricelevelDefault = 0
priceLevelA = 1
priceLevelB = 2
priceLevelC = 3
Transaction.PurchaseLimitPurchase Total amount being purchased in the current transaction (includes sales tax for VAT tax system).
Transaction.PurchaseLimitPoints Sum of all points (Quantity * Points/Item) for this transaction.
Transaction.PurchaseLimitUnits Sum of all units (Quantity) for this transaction.
Transaction.Recalled Returns True if this transaction has been recalled.
Transaction.ReferenceID Returns the following based on transaction type:
Transaction Type Returns
Transaction.SalesTaxPurchased Sales tax across items being purchased or picked up.
Transaction.SalesTaxOnOrder Sales tax on items still on order.
Transaction.SubreferenceID Returns Order History ID for orders or for other transaction types.
Transaction.SubTotalPurchased SubTotal across items being purchased or picked up.
Transaction.SubTotalOnOrder SubTotal across items still on order.
Transaction.Time Time the transaction was posted.
Transaction.TotalDue Total owed by the customer for the transaction whether for picked up amounts, deposits, payments.
Transaction.TotalPurchased Total across items being purchased or picked up.
Transaction.TotalExclsvPurchased Total across items being purchased or picked up - sales tax on same items.
Transaction.TotalOnOrder Total across items still on order
Transaction.TotalTendered Net total amount tendered for the transaction.
Transaction.TotalTenderIn Amount of tender going into the till.
Transaction.TotalTenderOut Amount of change.
Transaction.TotalWeight Sum of weights for all items on transaction.
Transaction.TotalWeightOnOrder Sum of weights for all items remaining on order.
Transaction.TotalWeightPurchased Sum of all weights across items being purchased or picked up.
Transaction.TotalQuantityOnOrder Total quantity remaining on order.
Transaction.TotalQuantityPurchased Total quantity across all items being picked up or purchased.
Transaction.EntryCount Number of line items in the transaction.
Transaction.PostingStatus Not Implemented
Transaction.ReceiptTransactionName Text value of the transaction type.
Transaction.ReceiptTransactionType Don't use (Use ReceiptReferenceType instead)
Transaction.ReceiptTransactionNumber If the transaction is a purchase or order pick-up this will return the
TransactionNumber in the Transaction table for the transaction. Otherwise returns the OrderID, DropPayoutID, as applicable to the transaction type.
Transaction.ReceipttransacationNumberCaption Returns a caption to be used in conjunction with the ReceiptTransactionNumber such as "Transaction #" "Work Order #".
Transaction.ReceiptReferenceName Returns "Sales Receipt" for sale or order pick-up and returns the text name of the transaction for other orders and transaction types.
Transaction.ReceiptReferenceType Returns TransactionSales for sale or order pick-up and returns the following types otherwise as applicable:
Transaction.ReceiptReferenceNumber If the transaction is an order pick-up will return the ID in the Order
table. Otherwise returns 0.
Transaction.ReceiptReferenceNumberCaption Returns an applicable caption for the Transaction.ReceiptReferenceNumber variable.
Transaction.ReceiptReturningItems TRUE if there are any items with negative quantities on the transaction;FALSE otherwise.
Transaction.ReceiptReturnMode TRUE if the transaction has been explicitly set as a "return" (via CTRL-F4); FALSE otherwise.
Transaction.SalesTaxes.IsTransactionMember Returns TRUE if the indicated tax is non-zero in the current transaction
Transaction.SalesTaxes.OnOrder Returns the total sales tax against items on order.
Transaction.SalesTaxes.Purchased Returns the total sales tax against items being purchased or picked up.
Transaction.SalesTaxes.Total Returns the total sales tax against items purchased or picked up, items still on order and items received to date.
Transaction.SalesTaxes.ShowOnReceipt Returns true if this sales tax should be displayed on the receipt.
Session.Variable1 General purpose variable for use by add-ins.
Session.Variable2 General purpose variable for use by add-ins.
Session.Variable3 General purpose variable for use by add-ins.
Session.Variable4 General purpose variable for use by add-ins.
Session.Variable5 General purpose variable for use by add-ins.
Session.Variable6 General purpose variable for use by add-ins.
Session.Variable7 General purpose variable for use by add-ins.
Session.Variable8 General purpose variable for use by add-ins.
Session.Variable9 General purpose variable for use by add-ins.
Session.Variable10 General purpose variable for use by add-ins.
Entry.ExtendedBasePrice Returns the price (not including tax) * quantity for the entry in VAT tax systems.
Entry.ExtendedPrice Returns Quantity * Price for the transaction entry.
Entry.ExtendedPriceOnOrder Returns Quantity On Order * Price for the transaction entry (applicable for orders only).
Entry.ExtendedPricePurchased Returns the Quantity purchased or picked up * price for the transaction entry.
Entry.Tax Returns the total of all sales taxes that apply to the transaction entry.
Entry.ExtendedFullPrice Returns Quantity Total * Full Price.
Entry.ExtendedFullPriceOnOrder Returns Quantity On Order * Full Price (applicable to orders only).
Entry.ExtendedFullPricePurchased Returns Quantity being picked up or purchased * Full Price.
Entry.ExtendedExclsvPricePurchased For VAT systems, returns the extended price of the entry not including
Entry.Discount Amount of discount for a quantity of 1 in currency for the current entry.
Entry.DiscountPercentage Percentage of discount for the entry.
Entry.ExtendedDiscount Amount of discount for the total quantity in currency for the current entry.
Entry.ExtendedDiscountOnOrder Amount of discount for the quantity on order in currency for the current entry.
Entry.ExtendedDiscountPurchased Amount of discount for the quantity being purchased or picked up in currency for the current entry.
Entry.DiscountNegative Returns the negative of Entry.Discount
Entry.ExtendedDiscountNegative Returns the negative of Entry.ExtendedDiscount.
Entry.ExtendedDiscountOnOrderNegative Returns the negative of Entry.ExtendedDiscountOnOrder.
Entry.ExtendedDiscountPurchasedNegative Returns the negative of Entry.ExtendedDiscountPurchased.
Entry.PriceSource INTERNAL USE ONLY
Entry.Price Price the item is being sold for the current entry.
Entry.Quantity Total quantity for the current entry. For orders this included quantity received to date, quantity remaining on order and quantity currently being picked up.
Entry.QuantityOnOrder Quantity remaining on order for the current entry.
Entry.QuantityPurchased Quantity being purchased or picked up for the current entry.
Entry.QuantityRTD Quantity received to date for the current entry. Only applies to orders.
Entry.Taxable Returns TRUE if the entry is taxable.
Entry.TaxRate INTERNAL USE ONLY
Entry.Item.FootStampable Returns TRUE if the item can be paid for with food stamps. Note the misspelling of FootStampable.
Entry.Item.ItemType Returns the following for the item:
Public Enum ItemTypeEnum
itemtypeStandard = 0
itemtypeSerialized = 1
itemtypeMatrix = 2
itemtypeKit = 3
itemtypeLotMatrix = 4
itemtypeGasoline = 5
itemtypeWeighed = 6
itemtypeNonInventory = 7
itemtypeAssembly = 8
itemtypeVoucher = 9
Entry.Item.MessageAgeLimit Returns the age used in age-limit messages, i.e., you must be 21 to buy this product.
Entry.Item.MessageText Text of the message displayed for the item.
Entry.Item.MessageTitle Title of the message displayed for the item.
Entry.Item.NotDiscountable Returns TRUE if the item may NOT be discounted.
Entry.Item.Onsale Returns TRUE if the item is on sale.
Entry.Salesrep.FixedRate Returns the fixed amount commission to be paid to the sales rep for the current entry.
Entry.Salesrep.Name Returns name of the sales rep for the current entry.
Entry.Salesrep.PercentOfProfit Returns the percentage of profit owed the sales rep as commission for the current entry.
Entry.Salesrep.PercentOfSale Returns the percentage of the sale owed the sales rep as commission for the current entry.
Entry.Salesrep.Number Returns the number for the sales rep for the current entry.
Entry.Serialized.Description NOT IMPLEMENTED
Entry.Serialized.Number1 Serial Number 1 for the current item.
Entry.Serialized.Number2 Serial Number 2 for the current item.
Entry.Serialized.Number3 Serial Number 3 for the current item.
Entry.Serialized.Sold Returns TRUE if this S/N has been sold
Entry.Serialized.SN1 Return the text: "SN: "
Entry.Serialized.SN2 Return the text: "SN: "
Entry.Serialized.SN3 Return the text: "SN: "
Entry.ReasonTaxChange.Description Returns the description for the tax change reason code if one has been
applied to the current entry.
Entry.ReasonDiscount.Description Returns the description for the discount reason code if one has been applied to the current entry.
Entry.ReasonReturn.Description Returns the description for the return reason code if one has been applied to the current entry.
Entry.ReasonTaxChange.Code Returns the code for the tax change reason code if one has been applied to the current entry.
Entry.ReasonDiscount.Code Returns the code for the discount reason code if one has been applied to the current entry.
Entry.ReasonReturn.Code Returns the code for the return reason code if one has been applied to
the current entry.
Entry.ReasonTaxChange.Type Valid values for all three .Type variables are:
Entry.Item.Kit.Count Returns the number of items in the kit for the current entry.
Kititem.Quantity Returns the quantity of the particular kit component that goes into the make up of the kit (for 1 kit).
Kititem.Description Returns the description of the particular kit component that goes into
the make up of the kit.
Customer.ChargeAccount Returns TRUE if the customer has a charge account.
Customer.CreditLimit Currency amount of credit limit for the customer.
Customer.CurrentDiscount Discount percentage defined for the customer.
Customer.DaysoverDue Returns the maximum number of days overdue for any outstanding Account
Receivable for the customer.
Customer.Employee Returns TRUE if the customer is an employee.
Customer.GlobalCustomer Returns TRUE if the customer is Global (only applies in an HQ environment).
Customer.HomeAddress.CityStateZip Returns "City, State Zip" on one text line for the customer's home address.
Customer.HomeAddress.Zipcity Returns "ZipCity" on one text line for the customer's home address.
Customer.ID Returns the ID in the Customer table for the customer.
Customer.LastclosingDate Returns the last closing date the account was closed for this customer.
Customer.Lastvisit Date of the customer's last visit to the store.
Customer.PreviousAccountBalance Customer's account balance as of the last time his account was closed.
Customer.PriceLevel Returns the customer's price level.
Customer.PurchaseLimitEnabled Returns TRUE if purchase limits apply to this customer.
Customer.PurchaseLimitTotalPoints Sum of all points (Quantity * Points/Item) allowed for this customer.
Customer.PurchaseLimitTotalPurchases Total currency amount allowed for purchase by this customer.
Customer.PurchaseLimitTotalUnits Total units (points * quantity) allowed for purchase by this customer.
Customer.ShiptoAddress.CityStateZip Returns "City, State Zip" on one text line for the customer's ship to address.
Customer.ShiptoAddress.Zipcity Returns "zip city" for this customer's ship to address.
Customer.TaxExempt Returns TRUE if this customer is exempt from taxes.
Customer.AccountReceivable.Pay Returns TRUE if part of the payment is being applied to the A/R indicated by the KEY value.
Customer.AccountReceivable.OriginalDate Original date for the A/R indicated by the KEY value.
Customer.AccountReceivable.DueDate Due date for the A/R indicated by the KEY value.
Customer.AccountReceivable.ID ID in AccountReceivable table for the A/R indicated by the KEY value.
Customer.AccountReceivable.TransactionNumber Transaction Number for the A/R indicated by the KEY value when the A/R
is a charge.
Customer.AccountReceivable.OriginalAmount Original amount for the A/R indicated by the KEY value.
Customer.AccountReceivable.Balance Current balance for the A/R indicated by the KEY value.
Customer.AccountReceivable.PreviousBalance Previous balance (before the current payment being applied) for the A/R indicated by the KEY value.
Customer.AccountReceivable.Payment Returns the amount of payment being applied to the A/R indicated by the KEY value.
Customer.AccountReceivable.Reference Returns the Transaction Number or Account Receivable ID for the A/R indicated by the KEY value prefixed with "DC -" for a Debit/Credit A/R, "TR - " for a transactional charge and "FC-" for a finance charge. Also includes store ID in the prefix for HQ environment.
Customer.AccountReceivables.TotalPayments Total payment being applied across all A/R's for this customer.
Customer.AccountReceivables.AppliedCredits Total existing credits being applied in this payment for the customer.
Tender.AmountIn Amount being paid by the customer for the tender indicated by the Key value.
Tender.AmountOut Amount being paid out to the customer for the tender indicated by the Key value.
Tender.AmountInlocal Amount converted to local currency being paid by the customer for the tender indicated by the Key value.
Tender.AmountOutlocal Amount converted to local currency being paid out to the customer for the tender indicated by the Key value.
Tender.AmountInRounding Rounding amount in local currency required to make an exact conversion
between the tender being paid by the customer in native vs. local format. Also applies for currencies with RoundTo values.
Tender.AmountOutRounding Rounding amount in local currency required to make an exact conversion
between the tender paid back to the customer in native instead of local
format. Also applies to currencies with RoundTo values.
Tender.AccountNumber Full account Number
Tender.AccountNumberMasked Account Number with all but last 4 digits replaced with "X".
Tender.ApprovalCode Approval card for credit and debit cards.
Tender.Expiration Expiration date for credit cards
Tender.StateCode State Code for this tender.
Tender.Swiped Returns TRUE if the credit card or debit card was read by a magnetic stripe reader instead of manually entered.
Tender.Track1 Returns track 1 data read from the magnetic stripe on the card.
Tender.Track2 Returns track 2 data read from the magnetic stripe on the card.
Tender.VoucherPreviousBalance Balance on the voucher prior to the present transaction.
Tender.VoucherNewBalance Balance on the voucher including the present transaction.
Tender.VoucherPreviousBalanceLocal Balance on the voucher converted to local currency prior to the present transaction (only applies for vouchers that have a currency other than the local one).
Tender.VoucherNewBalanceLocal Balance on the voucher converted to local currency including the present transaction (only applies for vouchers that have a currency other than the local one).
Tender.Descriptor.Description Description of the tender
Tender.Descriptor.ExchangeRate Exchange rate for the tender
Tender.Descriptor.RequireSig Returns TRUE when the tender requires a signature
Shipping.Carrier Shipping carrier defined for the present transaction.
Shipping.Service Shipping service defined for the present transaction.
Shipping.Charge Amount owed for shipping for the present transaction.
Shipping.TrackingNumber Tracking number for the shipping on the present transaction.
Shipping.Notes Any notes entered for the shipping in the current transaction.
ShippingEdit.Carrier Values entered in the shipping edit form invoked by Ctrl-Shift F8.
Report.RegisterNumber These map to the values created on X and Z reports.
Report.Batch.BatchNumber These values apply to the batch indicated by the passed key value for X and Z reports.
Report.Hour.Hour These values apply to the hour indicated by the passed key value for X
and Z reports.
Report.Department.Name These values apply to the department indicated by the passed key value
for X and Z reports.
Report.Tax.Description These values apply to the tax indicated by the passed key value for X and Z reports.
Report.Tender.CloseTotal These values apply to the tender indicated by the passed key value for
X and Z reports.
Batch.Number Returns the number of the batch currently being processed.