Invoice Trigger Type Tags

Page approved.




WARNING icon
Setting up Email Message Templates is an Advanced User feature.

For the list of types of tags available see Email Manager Message Template Tags.

Invoice Trigger Type available tags are used for emails, normally sent automatically as a result of orders moving from one stage to another, in the Sales Invoice Manager, for example How To: Setup 'Your Order has Shipped' Invoice Emails.

The Available Tags are displayed when setting up Email Message Templates; the Trigger Type selected will determine which tags are available for use. The Available Tags inserted into the Message Template will determine what information replaces them when the email is created.

The Tag Description of the majority of the tags explains what information will replace the tag in the email. The INVOICE tags have different coloured backgrounds:

  • Yellow: the tags listed inSystem Data Courier Banding yellow are used with the Item Template and To Follow Item Template fields and are placed in the Message Template body. When the email is sent the information defined in the fields Item Template and To Follow Item Template are listed in the main body of the email located where the yellow tags have been placed.
    Note: the To Follow Item Template does not work with part-shipped items.
  • Blue: the blue tags are used in the Item Template and To Follow Item Template to build up column headings of what and in which order the information will appear in the email.

See How To: Setup Email Templates for how to use the Item Template and To Follow Item Template fields.

Note: when using the Item Template and To Follow Item Template you can add a line break or have the information on a new line by using <br /> where you want the break.

The Available Tags area has the following columns:

  • Tag Desc: the description of the tag.
  • Tag Name: the tag text that will be added into the main Message Template Area and will be replaced by the corresponding data when the email is sent to the addressee.

Tag Desc
Tag Name
Description
Use this Tag to place Items in your message $ITEM_TEXT The $ITEM_TEXT tag is placed in the body of the Message Template. The user then builds the content that will replace the $ITEM_TEXT tag when the message is sent by adding the tags with the blue background in the Item Template field.
Use this Tag to place To Follow Items in your message. $TO_FOLLOW_ITEM_TEXT The $TO_FOLLOW_ITEM_TEXT tag is placed in the body of the Message Template. The user then builds the content that will replace the $TO_FOLLOW_ITEM_TEXT tag when the message is sent by adding the tags with the blue background in the To Follow Item Template field.
Agent Email $AGENT_EMAIL The email address of the Agent stored against the [ System Data | Agents ] list, based on the Agent selected against the Sales Order which has triggered the email to be sent.
Brand Company $BRAND_COMPANY The name of the brand company as setup in [ System Data | Branding ].
Brand Description $BRAND_DESC The brand description as setup in [ System Data | Branding ].
Brand Email $BRAND_EMAIL The brand email address as setup in [ System Data | Branding ].
Brand Telephone Number $BRAND_TELEPHONE The brand telephone number as setup in [ System Data | Branding ]
Brand Website $BRAND_WEB The brand website as setup in [ System Data | Branding ].
Company Name $COMPANY_NAME The company name.
Company Reward Point Balance $COMPANY_REWARD_POINTS The number of reward points held by the customer and seen in their Reward Points area. It does not include any reward points that have been accrued on the current sales order.
Company UDA Item $UDA_COMPANY Allows the user to add the Company UDA into the body of the email, for example this can be used to bring specific customer attributes into the body of the email, see How To: Add Company UDAs into Email Templates.
Company URN $COMPANY_CODE The company ID.
Consignment Ref(s) for Boxes $BOXES_CONSIGNMENT_REF Supersedes the $CONSIGNMENT_REF option below as it adds the Courier URL from [ System Data | Couriers ] and consignment reference in automated despatch emails to customers. Where an invoice has been packed into more than one box, this tag will display the individual consignment references generated (including URLs, if specified in [ System Data | Couriers ]), with a line break between each one, see How To: Setup 'Your Order has Shipped' Invoice Emails and How To: Setup Email Consignment References for Boxes.
Note: the Email Message Template must have the HTML checkbox ticked so that the recipient receives an email with a clean and clear hyperlink to click through in order to track their parcel.
Consignment Reference $CONSIGNMENT_REF The manually entered consignment reference or if using courier integration then this can be automatically imported depending on the courier used. If sending out multiple boxes via a courier then the $BOXES_CONSIGNMENT_REF option should be used, see How To: Setup 'Your Order has Shipped' Invoice Emails.
Courier Code $COURIER_CODE The code listed in the Code column in [ System Data | Couriers ].
Courier Type $COURIER_TYPE The courier service or name from the Service / Courier Name column in [ System Data | Couriers ].
Courier(s) for Boxes $COURIERS_FOR_BOXES When this is used in the body of an E-mail Template, it will list all couriers assigned to any boxes which are against the Sales Order in the following format: COURIER_NAME: CONSIGNMENT_REFERENCE
Customer Order Ref. $CUSTOMER_PO The customer's Purchase Order reference entered in the Payment Fields area in the [ Sales Orders | Payment ] screen.
Delivery Address Telephone $DELIVERY_ADDR_TELEPHONE The delivery telephone number in the [ Sales Orders | Addresses ] tab.
Delivery Contact Email $DELIVERY_CONTACT_EMAIL The delivery contact email in the [ Sales Orders | Addresses ] tab.
Delivery Contact Forename $DELIVERY_CONTACT_FORENAME The delivery contact forename in the [ Sales Orders | Addresses ] tab.
Delivery Contact Mobile $DELIVERY_CONTACT_MOBILE When the email is sent out the mobile number from the delivery address contact will be displayed. If there is no mobile number it will be it blank.
Delivery Contact Surname $DELIVERY_CONTACT_SURNAME The delivery contact surname in the [ Sales Orders | Addresses ] tab.
Delivery Contact Telephone $DELIVERY_CONTACT_TELEPHONE The delivery contact's telephone number.
Delivery Contact Title $DELIVERY_CONTACT_TITLE The delivery contact's title.
Delivery Date $DELIVERY_DATE The date the sales order is expected to be delivered (despatched). It does rely on the delivery date on the sales order being the same as the actual despatch date.
Despatch Date $DESPATCH_DATE The date and time the sales order was despatched to the customer.
Generated Keycode Aliases $KEYCODE_ALIASES This is used to email the customer their unique keycode, see How To: Email Customers with their unique offer codes and How To: Setup an Email Template to send customers their unique offer codes.
Invoice Address $INVOICE_ADDR The invoice address in the [ Sales Orders | Addresses ] tab.
Invoice Address Organsisation $INVOICE_ADDR_ORGANISATION This is the name of the organisation setup in the Organisation field in the Secondary Address Types area in the [ Customer | Address ] screen.
Invoice Address Telephone $INV_ADDR_TELEPHONE The telephone number for the invoice address in the [ Sales Orders | Addresses ] tab.
Invoice Code $INVOICE_CODE The invoice code generated when the invoice is printed, until then ??? will be displayed.
Invoice Contact Email $INVOICE_CONTACT_EMAIL The email address of the invoice contact.
Invoice Contact Forename $FORENAME The first name of the invoice contact.
Invoice Contact Job Title $JOB_TITLE The job title of the invoice contact.
Invoice Contact Mobile $INVOICE_CONTACT_MOBILE When the email is sent out the mobile number from the invoice address contact will be displayed. If there is no mobile number it will be it blank.
Invoice Contact Surname $SURNAME The surname for the invoice contact.
Invoice Contact Telephone $INVOICE_CONTACT_TEL The telephone number for the invoice contact.
Invoice Contact Title $CONTACT_TITLE The title of the invoice contact (Mr, Ms, Miss etc).
Invoice Date $INVOICE_DATE The date the invoice code is generated, usually when the invoice is printed,
Invoice Delivery Address $INVOICE_DELIVERY_ADDR The address listed as the delivery address on the invoice.
Invoice Delivery Net Total $DELIVERY_NET The total cost of delivery excluding VAT.
Invoice Delivery Tax Total $DELIVERY_TAX_TOTAL The total amount of VAT for the delivery.
Invoice Delivery Total $DELIVERY_TOTAL The total cost of delivery including VAT.
Invoice ID $INVOICE_ID The system generated Invoice ID.
Invoice Item Discount Value $DISCOUNT The monetary discount for the item as shown in the Disc L column in the Sales Orders Grid.
Invoice Item Gross Total $GROSS_TOTAL The gross total for the stock item, i.e. including VAT for the total number of items.
Invoice Item Net Disc. Value $NET_DISCOUNT The net value of any discount for the stock item, i.e. total discount excluding VAT for the sales order item line.
Invoice Item Net Total $NET_TOTAL The net total for the stock item, i.e. excluding VAT for the total number of items.
Invoice Item Net Unit $NET_UNIT The unit price per item, i.e. excluding VAT. If an order line has been discounted, the discounted Net Unit price is displayed.
Invoice Item Quantity Sent $QTY_SENT The number of the stock items being shipped in the current consignment.
Invoice Item Stock Code $STOCK_CODE The stock code of the stock item.
Invoice Item Stock Description $ITEM_NAME The name of the stock item on the order.
Invoice Item Tax Total $TAX_TOTAL The total amount of VAT for the stock item.
Invoice Net Total $NET_TOTAL The total for the invoice excluding VAT.
Invoice Tax Total $TAX_TOTAL The total amount of VAT on the invoice.
Invoice Total EXCL Delivery $GROSS_TOTAL The invoice total excluding the delivery charge.
Invoice Total INCL Delivery $INVOICE_TOTAL The invoice total including the delivery charge.
Number of To Follow items $TO_FOLLOW_COUNT The number of outstanding items that will be despatched at a later date.
Quantity On Order $QTY_SOLD The total number of items on the order that the customer has ordered.
Quantity To Follow $QTY_TOFOLLOW The number of items that are not being sent with this consignment, normally because they are out of stock.
Sales Order Code $SORDER_CODE The Sales Order Code as found on the [ Sales Orders | Main ] screen.
Sales Order Date $SORDER_DATE The date the Sales Order Code was created, although this can be amended, found on the [ Sales Orders | Main ] screen.
Sales Order Delivery Timeslot $DELIVERY_TIMESLOT From the Timeslot field on the [ Sales Order | Additional ] screen.
Sales Order Gross Total $SORDER_TOTAL The total on the sales order including delivery and VAT.
Sales Order Grs Total (exDel) $SORDER_EXDEL_TOTAL The total on the sales order including VAT but excluding delivery.
Sales Order Line Gross Total $SOI_GROSS_TOTAL The total cost per stock item line including VAT on the sales order.
Sales Order Line Gross Unit $SOI_GROSS_UNIT The unit cost per stock item line including VAT on the sales order.
Sales Order Line Net Total $SOI_NET_TOTAL The total cost per stock item line excluding VAT on the sales order.
Sales Order Line Net Unit $SOI_NET_UNIT The unit cost per stock item line excluding VAT on the sales order.
Sales Order Line Qty Ordered $SOI_QTY_ORDERED The quantity of stock items that the customer has ordered on the sales order.
Sales Order Net Total $SORDER_NET_TOTAL The total on the sales order excluding VAT and delivery
Sales Order Source $SORDER_SOURCE The Sales Source of the Order Code as found on the [ Sales Orders | Main ] screen.
Sales Order Tax Total $SORDER_TAX_TOTAL The total of tax on a sales order.
Sales Order To Follow Grs Tot $SOI_TOFOLLOW_TOTAL The total cost per stock item line including VAT of out of stock items that will be despatched at a later date.
Sales Order Total $SALES_ORDER_TOTAL The total value of the Sales Order as found on the [ Sales Orders | Main ] screen, this includes the value of any out of stock items.
Stock UDA Item $UDA_STOCK Allows the user to add the Stock UDA for the individual items into the email, for example this can be used to bring URLs into the body of the email, see How To: Add Stock UDAs into Email Templates.
Web Order Ref $ASSOCIATED_REF Normally the customer's web site order reference and found in the Payment Fields area in the [ Sales Orders | Payment ] screen.
Date - Day as 2 digit number $DATE_DD The date as two digit number for example 03, 21, 28.
Date - Day as name $DATE_DNAME Monday, Tuesday, Wednesday etc.
Date - Day as suffixed number $DATE_DNUMBER The date including a suffix for example 3rd, 21st, 28th.
Date - Month as 2 digit number $DATE_MM The month as a two digit number for example 08 (August), 10 (October) etc.
Date - Year as 4 digit number $DATE_YYYY The year in full for example 2014, 2015 etc

See Also

Visit KhaosWikiX at https://support.khaoscontrol.com/wiki_kcx/ to see the following:

Contact the Khaos Team