Modifying the Static text, Data Fields and UDFs
This article provides details on the modification of the static text, data fields and UDFs in the iVend POS Receipt.
Any user with basic XML and programming knowledge can customize the iVend POS receipts.
You can locate the Print Profile and Receipt Print Formats screens in the iVend Management Console in the following menu locations:
· Administration > Retail Configuration > Print Profile
· Administration > Retail Configuration > Receipt Print Formats
1. Select the Print Profile that is attached to the store POS, where the modification is required.
Figure 1 Print Profile Search
Choose the available print profile and click the [F4 Edit] button to edit the record.
You can edit the XML format of any of the following POS receipts however this cannot be performed directly within the Print Profile window. The user must export the design via the Receipt Print Format window (Receipt Designer).:
Administration > Retail Configuration > Receipt Print Formats
Figure 2 Receipt Designer
You can edit the XML format of any of the following POS receipts:
1. Labor Chit
2. Day labor Chit
3. Transaction receipt
4. XTape Report
5. Gift Receipt
6. Quotation Receipt
7. Expense Chit
8. Z Tape Report
9. CashInCashOut
10. Gift Certificate
11. Coupons
12. Customer Display Receipt
13. Payment Receipt
14. Suspended Transaction Receipt
Modifying the Static Text or Labels in the Receipt
Sample XML:
<Row>
<Element colspan="2" align="left" string="Item Sales" />
<Element colspan="2" align="right" string="Cash Memo" />
</Row>
Modify the string attribute of any “Element” element to modify the static text.
Modify the properties/data fields or UDFs in the receipt.
Figure 3 Receipt Designer-Store
Sample XML:
In the iVend POS Receipt XML structure, modify the following attributes of any “Element” element to modify the data field:
· object0: Refers to the object property for which the value needs to be printed. Mathematical calculations can be performed between the object properties.
· object1: Refers to the object property for which the value needs to be printed. Mathematical calculations can be performed between the object properties.
· string: Refers to the value printing of the properties defined in the ‘object0’ to the object<n> attributes. This attribute takes values as defined in the argument pattern ‘{<n>}’. Any Unicode character including Blank Space is allowed to be printed before or after the argument printing. Alternatively, this attribute can be used to print the label values without referring to the object values.
Note: The object<n> attribute can be defined until the nth number.
Click the View Property List link to download an Excel spreadsheet for the full property list supported in the XML receipts. Refer to the 'Pivot' sheet and choose the desired object in the 'B2' cell. Accordingly, it will populate the table structure of the pivot and by further drilldown to the desired sub object you can choose the property in the 'E' column.
The following table lists the frequently used properties in the XML Receipts:
S.No | Section | Property | Description |
1 | Footer | AccountType | Payment account type .e.g. Credit, Debit, Cash, etc |
2 | Footer | Amount | Total Transaction Amount |
3 | Footer | AmountInSpanish | Total Transaction Amount in Spanish language .e.g. "doscientos mil solamente" |
4 | Layaway | ARPayments.LayawayBalanceAmount | Layaway Balance Amount |
5 | Layaway | ARPayments.LayawayOriginalAmount | Layaway Original Amount |
6 | Layaway | ARPayments.PaymentProxy.Amount | Payment Amount |
7 | Detail | ARPayments.PaymentProxy.OriginalDocumentId | transaction id of the document for which the payment is done |
8 | Detail | ARPayments.SaleOrderBalanceAmount | Balance Payment on Special Order in case advance payment is given |
9 | Footer | CardNumber | Credit or debit card number |
10 | Footer | CommentValue | Transaction comments |
11 | Footer | Customer.AccountsReceivable.Balance | AR balance of the customer |
12 | Footer | Customer.BillingAddress.Contact.FirstName | customer Billing Address Contact first name |
13 | Footer | Customer.DefaultContact.FirstName | Customer default Contact first name |
14 | Footer | Customer.DefaultContact.LastName | Customer default Contact first name |
15 | Footer | Customer.FirstName | Customer First Name |
16 | Footer | Customer.Id | Customer code |
17 | Footer | Customer.LastName | Customer Last Name |
18 | Footer | Customer.ShippingAddress.Contact.FirstName | customer Shipping Address Contact first name |
19 | Footer | GiftCertificate.BalanceAmount | Gift Certificate Balance Amount |
20 | Detail | GiftCertificateProxy.Price | Gift Certificate Price |
21 | Detail | GiftCertificateProxy.Product.Description | Gift Certificate Product Description |
22 | Detail | GiftCertificateProxy.Product.Id | Gift Certificate Product Id |
23 | Detail | GiftCertificateProxy.ProductDetailNumber | Gift Certificate Serial Number |
24 | Detail | GiftCertificateProxy.Type | Gift Certificate Type |
25 | Detail | LayawayBalanceAmount | Layaway Balance Amount |
26 | Detail | LayawayItemProxy.DiscountAmount | Layaway Discount Amount |
27 | Detail | LayawayItemProxy.Price | Layaway Price |
28 | Detail | LayawayItemProxy.Product.Description | Layaway Product Description |
29 | Detail | LayawayItemProxy.Product.Id | Layaway Product Id |
30 | Detail | LayawayItemProxy.SurchargeTotal | Layaway Surcharge Total |
31 | Detail | LayawayItemProxy.Total | Layaway Total |
32 | Detail | LayawayOriginalAmount | Layaway Original Amount |
33 | Loyalty | LoyaltyCustomerSummary.AvailableCurrency | Loyalty Customer Available Currency |
34 | Loyalty | LoyaltyCustomerSummary.AvailablePoints | Loyalty Customer Available Points |
35 | Loyalty | LoyaltyCustomerSummary.AwardedCurrency | Loyalty Customer Awarded Currency |
36 | Loyalty | LoyaltyCustomerSummary.AwardedPoints | Loyalty Customer Awarded Points |
37 | Loyalty | LoyaltyCustomerSummary.CurrentSlab | Loyalty Customer Summary Current Slab |
38 | Loyalty | LoyaltyCustomerSummary.FirstName | Loyalty Customer First Name |
39 | Loyalty | LoyaltyCustomerSummary.LastName | Loyalty Customer Last Name |
40 | Loyalty | LoyaltyCustomerSummary.LoyalityId | Loyalty Customer Loyalty Id |
41 | Loyalty | LoyaltyCustomerSummary.RedeemedPoints | Loyalty Customer Summary Redeemed Points |
42 | Detail | OrderItemProxy.DiscountAmount | Special Order Discount Amount |
43 | Detail | OrderItemProxy.Price | Special Order Price |
44 | Detail | OrderItemProxy.Product.Description | Special Order Description |
45 | Detail | OrderItemProxy.Product.Id | Special Order Id |
46 | Detail | OrderItemProxy.SurchargeTotal | Special Order Surcharge Total |
47 | Detail | OrderItemProxy.Total | Special Order Total |
48 | Header | PaymentProxy.OriginalDocumentId | Account Payment Original Document Id |
49 | Header | PrintDate | Transaction Date |
50 | Footer | PrintInformation | Greeting Message |
51 | Detail | Quantity | total sale item count of the transaction |
52 | Footer | ReasonCode.Id | Reason Code |
53 | Header | ReceiptStatus | Receipt label e.g. "Original receipt", "Duplicate receipt" |
54 | Detail | SaleItemProxy.DiscountAmount | Sale Item Product Discount |
55 | Detail | SaleItemProxy.Price | Sale Item Product Price |
56 | Detail | SaleItemProxy.Product.Description2 | Sale Item Product Description |
57 | Detail | SaleItemProxy.Product.Id | Sale Item Product Code |
58 | Detail | SaleItemProxy.Product.ProductGroup.Description | Sale Item Product Group |
59 | Detail | SaleItemProxy.Product.UserDefinedFields!<FieldName> | Sale Item Product User Defined Field |
60 | Detail | SaleItemProxy.ProductDetailNumber | Sale Item Product Serialize and Batch |
61 | Detail | SaleItemProxy.ProductReturnDetailNumber | Sale Item Product Return Detail Number |
62 | Detail | SaleItemProxy.SurchargeTotal | Sale Item Surcharge Total |
63 | Detail | SaleItemProxy.Total | Sale item Total |
64 | Detail | SaleItemProxy.UOMGroupDetail.UOM.Description | Sale Item Product UOM |
65 | Detail | SaleItemProxy.UOMQuantity | Sale Item Product UOM Quantity |
66 | Header | SecurityUser.Id | Security User Id |
67 | Header | SecurityUser.SecurityUserType | Security User Type |
68 | Detail | SequenceNumber | Serial no of the items in the receipt |
69 | Header | Store.Address.PhoneNumber | Store address Phone Number |
70 | Header | StoreInfo | id and description of the store |
71 | Footer | TaxCode.TaxRate | Tax Rate |
72 | Footer | TaxOnAmount | Total Tax Amount on Transaction |
73 | Footer | TenderAmount | Transaction Amount based on Tender Type |
74 | Footer | TenderType | Transaction Tender Type |
75 | Detail | TotalItems | Number of Transaction Items |
76 | Footer | TotalWholeString | Transaction Amount in words in English language |
77 | Header | Transaction.ActualDate | Transaction Date |
78 | Footer | Transaction.Customer.Address.Address1 | Customer Contact Address |
79 | Footer | Transaction.Customer.Address.Address2 | Customer Contact Address |
80 | Footer | Transaction.Customer.Address.Address3 | Customer Contact Address |
81 | Footer | Transaction.Customer.Address.Country.Id | Customer Contact Address |
82 | Footer | Transaction.Customer.Address.State.Id | Customer Contact Address |
83 | Footer | Transaction.Customer.Address.ZipCode | Customer Contact Address |
84 | Footer | Transaction.Customer.BillingAddress.Address1 | Customer Billing Address |
85 | Footer | Transaction.Customer.BillingAddress.Address2 | Customer Billing Address |
86 | Footer | Transaction.Customer.BillingAddress.Address3 | Customer Billing Address |
87 | Footer | Transaction.Customer.BillingAddress.Country.Id | Customer Billing Address |
88 | Footer | Transaction.Customer.BillingAddress.State.Id | Customer Billing Address |
89 | Footer | Transaction.Customer.BillingAddress.ZipCode | Customer Billing Address |
90 | Footer | Transaction.Customer.PaymentType.Id | Customer Payment method |
91 | Footer | Transaction.Customer.ShippingAddress.Address1 | Customer Shipping Address |
92 | Footer | Transaction.Customer.ShippingAddress.Address2 | Customer Shipping Address |
93 | Footer | Transaction.Customer.ShippingAddress.Address3 | Customer Shipping Address |
94 | Footer | Transaction.Customer.ShippingAddress.ShippingAddress.Country.Id | Customer Shipping Address |
95 | Footer | Transaction.Customer.ShippingAddress.ShippingAddress.State.Id | Customer Shipping Address |
96 | Footer | Transaction.Customer.ShippingAddress.ShippingAddress.ZipCode | Customer Shipping Address |
97 | Footer | Transaction.Customer.UserDefinedFields!<FieldName> | UDF on customer |
98 | Footer | Transaction.DiscountAmount | Transaction Discount Amount |
99 | Footer | Transaction.DiscountPercent | Transaction Discount Percent |
100 | Layaway | Transaction.FulFillments.Address.Address1 | Fulfillment Address (Delivery) |
101 | Layaway | Transaction.FulFillments.DeliveryDate | Fulfillment Delivery Date |
102 | Layaway | Transaction.FulFillments.PlanDesc | Fulfillment Plan Description |
103 | Layaway | Transaction.FulFillments.PlanId | Fulfillment Plan Code |
104 | Layaway | Transaction.FulFillments.StoreInfo | Fulfillment Store Info |
105 | Layaway | Transaction.FulFillments.StoreKey | Fulfillment Store Key |
106 | Footer | Transaction.Id | Transaction Id |
107 | Footer | Transaction.Key | Transaction Key |
108 | Footer | Transaction.PayableAmount | Sale Item Transaction Payable Amount |
109 | Footer | Transaction.POS.Id | POS Code |
110 | Footer | Transaction.SalesPersons.User.FirstName | Sales Person Frist Name |
111 | Footer | Transaction.SalesPersons.User.Id | Sales Person ID |
112 | Footer | Transaction.SalesPersons.User.LastName | Sales Person Last Name |
113 | Footer | Transaction.SalesPersons.User.MiddleName | Sales Person Middle Name |
114 | Footer | Transaction.ShippingType.Id | Transaction Shipping Type |
115 | Layaway | Transaction.Status.BalanceAmount | Transaction Balance Amount |
116 | Layaway | Transaction.Status.LayawayBalanceAmount | Layaway Balance Amount in current transaction |
117 | Layaway | Transaction.Status.LayawayPaidAmount | Layaway Paid Amount |
118 | Layaway | Transaction.Status.LayawayPayableAmount | Layaway Payable Amount |
119 | Header | Transaction.Store.Address.Address1 | Store Address1 |
120 | Header | Transaction.Store.Address.Address2 | Store Address2 |
121 | Header | Transaction.Store.Address.Address3 | Store Address3 |
122 | Header | Transaction.Store.Address.City | Store City |
123 | Header | Transaction.Store.Address.State.Description | Store State |
124 | Header | Transaction.Store.Address.ZipCode | Store Zip Code |
125 | Header | Transaction.Store.Description | Store Description |
126 | Header | Transaction.Store.Id | Store Code |
127 | Footer | Transaction.SubTotal | Transaction Sub Total |
128 | Footer | Transaction.SurchargesTotal | Sale Item Transaction Surcharges Total |
129 | Footer | Transaction.Tax | Sale Item Transaction Tax |
130 | Footer | Transaction.Tax.InnerValue | Tax with fixed currency symbol |
131 | Footer | Transaction.TotalChangeDue | Sale Item Transaction Total Change Due |
132 | Footer | Transaction.TotalRoundingAmount | Sale Item Transaction Total Rounding Amount |
133 | Footer | Transaction.TotalTaxableAmount | Total Tax Amount |
134 | Footer | Transaction.TransactionId | Transaction Id |
135 | Footer | TransactionPayments.AccountType | Tender Type |
136 | Footer | TransactionPayments.Amount | Total Payable Amount |
137 | Footer | TransactionPayments.Bank.Description | Bank Name |
138 | Footer | TransactionPayments.Bank.Id | Bank Code |
139 | Footer | TransactionPayments.CardNumber | Tender Card Number |
140 | Footer | TransactionPayments.GiftCertificate.BalanceAmount | Gift certificate balance amount |
141 | Footer | TransactionPayments.PaymentType.Id | Tender Name |
142 | Footer | TransactionPayments.TenderType | Tender Type |