Template Variables: Difference between revisions

These variables (short codes) will be replaced by the relevant information from each booking. They can be used in every text settings that allows their use . Copy them exactly as shown, including the square brackets and upper case.

[PROPERTYDIRECTIONS] - property directions from ({#fas:cog}} (SETTINGS) CHANNEL MANNAGER > PROPERTY CONTENT)

[PROPERTYHOUSERULES] - property house rules ({#fas:cog}} (SETTINGS) CHANNEL MANAGER > PROPERTY CONTENT)

[CHECKINSTART] - check-in start time in 24hr format (From {#fas:cog}} (SETTINGS) CHANNEL MANAGER > PROPERTY CONTENT 'Check-in start')

[CHECKINEND] - check-in end time  in 24hr format (From {#fas:cog}} (SETTINGS) CHANNEL MANAGER > PROPERTY CONTENT 'Check-in end')

[CHECKOUTEND] - check-out end time in 24hr format (From {#fas:cog}} (SETTINGS) CHANNEL MANAGER > PROPERTY CONTENT 'Check-out end')

[CHECKINSTART12] - check-in start time in am/pm format (From {#fas:cog}} (SETTINGS) CHANNEL MANAGER > PROPERTY CONTENT 'Check-in start')

[CHECKINEND12] - check-in end time in am/pm format (From {#fas:cog}} (SETTINGS) CHANNEL MANAGER > PROPERTY CONTENT 'Check-in end')

[CHECKOUTEND12] - check-out end time in am/pm format (From {#fas:cog}} (SETTINGS) CHANNEL MANAGER > PROPERTY CONTENT 'Check-out end')

[PROPERTYDESCRIPTION1] - Property Description 1 from {#fas:cog}} (SETTINGS) BOOKING ENGINE > PROPERTY BOOKING PAGE > CONTENT

[PROPERTYDESCRIPTION2] - Property Description 2 from {#fas:cog}} (SETTINGS) BOOKING ENGINE > PROPERTY BOOKING PAGE > CONTENT

[PROPERTYDESCBOOKPAGE1] - Property Description Booking Page 1 from {#fas:cog}} (SETTINGS) BOOKING ENGINE > PROPERTY BOOKING PAGE > CONTENT

[PROPERTYDESCBOOKPAGE2] - Property Description Booking Page 1 from{#fas:cog}} (SETTINGS) BOOKING ENGINE > PROPERTY BOOKING PAGE > CONTENT

[PROPERTYGUESTDETAILSHEADER] - Guest Details Header from {#fas:cog}} (SETTINGS) BOOKING ENGINE > PROPERTY BOOKING PAGE > CONTENT

[PROPERTYGUESTENQUIRYHEADER] - Guest Enquiry Header from {#fas:cog}} (SETTINGS) BOOKING ENGINE > PROPERTY BOOKING PAGE > CONTENT

[PROPERTYCONFIRMBOOKBUTTON] - Confirm Booking Button Message  from {#fas:cog}} (SETTINGS) BOOKING ENGINE > PROPERTY BOOKING PAGE > CONTENT

[PROPERTYROOMNOTAVAIL]  - Room Not Available Message from {#fas:cog}} (SETTINGS) BOOKING ENGINE > PROPERTY BOOKING PAGE > CONTENT

[PROPERTYROOMNOPRICE]  - Room No Price Message from {#fas:cog}} (SETTINGS) BOOKING ENGINE > PROPERTY BOOKING PAGE > CONTENT

[PROPERTYNOROOMSAVAIL] - No Rooms Available Message  from {#fas:cog}} (SETTINGS) BOOKING ENGINE > PROPERTY BOOKING PAGE > CONTENT

[ROOMNAME] - room names of all booked rooms (not for cancelled bookings use ROOMNAMEINC if used for cacelled bookings)

[ROOMNAMEOFFERINC]  room names of all booked rooms with offer name inkl. cancelled bookings

[ROOMMETAAUXTEXT] - room meta text setting for first booked room

[ROOMMETAAUXTEXTS] - room meta text setting for all booked rooms

[ROOMMETAAUXTEXTSINC] - room auxiliary text setting for all booked rooms

[OFFERID]  - ID of the boked offer

[OFFERNAMEINC]  - offer name for this booked room only inluding cancelled bookings  

[OFFERDESCRIPTION1INC] - offer description 1 for all booked rooms inkl. cancelled

[OFFERDESCRIPTION2INC] - offer description 2 for all booked rooms inkl. cancelled

[UNITNAME:1] - additional information about the unit for all the assigned room types in the booking group (cancelled bookings are not shown)

[ROOMDESCRIPTION] - Room description  from {#fas:cog}} (SETTINGS) CHANNEL MANAGER > PROPERTY CONTENT > ROOM CONTENT

[ROOMDESCRIPTION1] - Room description 1 from {#fas:cog}} (SETTINGS) PROPERTIES > ROOMS > SETUP

[ROOMRACKRATENUM] - Rack Rate from {#fas:cog}} (SETTINGS) CHANNEL MANAGER > PROPERTY CONTENT > ROOM CONTENT

[ROOMCLEANINGFEENUM]  - Cleaning fee from {#fas:cog}} (SETTINGS) CHANNEL MANAGER > PROPERTY CONTENT > ROOM CONTENT

[ROOMSECURITYDEPOSITNUM]  - Securty deposit from {#fas:cog}} (SETTINGS) CHANNEL MANAGER > PROPERTY CONTENT > ROOM CONTENT

[ROOMTAXPERCENTNUM]  - Tax percentate from from {#fas:cog}} (SETTINGS) CHANNEL MANAGER > PROPERTY CONTENT > ROOM CONTENT

[ROOMTAXPERSONNUM]  - Tax per Person Night from from {#fas:cog}} (SETTINGS) CHANNEL MANAGER > PROPERTY CONTENT > ROOM CONTENT

[BOOKINGINFOCODEDATE:infoCode]- the most recent date value of the specified Booking Info Code, "infoCode" in this example  

[BOOKINGDATE] - booking date

[BOOKINGTIMEDATE] - booking date and time

 

[COMMISSIONGROUP]  - Value of the commission of the complete group booking

[GUESTEMAIL] - guest's Email address on the "summary" tab of the booking

[BOOKNAMELIST] - create a table with guest names and info for a booking / Tabelle mit Gastname und Informationen für diese Gruppenbuchung

[CANCELURL] - URL to view and cancel bookings

[CANCELDATE] - date until when the booking is cancellable displaying a phrase

[CANCELDATEYYYY-MM-DD] - date until when the booking is cancellable displaying a date. If the date is in the past 00-00-0000 will be shown

[GUESTLOGIN] - URL to view bookings

[CURRENTDATE] - current date

[CURRENTDATEYYYY-MM-DD] - current date  in YYYY-MM-DD format

[CURRENTTIME] - current time

[DAYSTOCHECKIN] - number of days until check-in

[INADVANCE] - number of days between booking and check-in

You can use PHP strftime format strings to create custom time formats. Information on PHP strftime strings is available at [http://php.net/manual/en/function.strftime.php http://php.net/manual/en/function.strftime.php]

[DAYSBETWEEN:2019-11-01:2019-11-10] - this template variable will calculate the number of days between the :: the dates need to be in yyyy-mm-dd format. Template variables can be used for calculation.

Example:  [[DAYSBETWEEN:[FIRSTNIGHT:+5 days{%G-%m-%d}]:[CURRENTDATE:{%G-%m-%d}]] will calculate the days between 5 days after check-in and today.

[FIRSTNIGHT:{%A, %e %B, %Y}] - first night booked

[FIRSTNIGHT:+1day{%A, %e %B, %Y}] - optional date offset and display format. The offset can be any plus or minus any number of days and the display can be any valid PHP strftime format string.

[LASTNIGHT:{%A, %e %B, %Y}] - last night booked

[LASTNIGHT:+1day{%A, %e %B, %Y}] - optional date offset and display format. The offset can be any plus or minus any number of days and the display can be any valid PHP strftime format string.

[LEAVINGDAY:{%A, %e %B, %Y}] - check-out

[LEAVINGDAY:+1day{%A, %e %B, %Y}] - optional date offset and display format. The offset can be any plus or minus any number of days and the display can be any valid PHP strftime format string.

[CURRENTDATE:{%A, %e %B, %Y}] - current date

[CURRENTDATE:+1day{%A, %e %B, %Y}] - optional date offset and display format. The offset can be any plus or minus any number of days and the display can be any valid PHP strftime format string.

[BOOKINGDATE:{%A, %e %B, %Y}] - booking date

[BOOKINGDATE:+1day{%A, %e %B, %Y}] - optional date offset and display format. The offset can be any plus or minus any number of days and the display can be any valid PHP strftime format string.

[MODIFYDATE:{%A, %e %B, %Y}] - last booking modification date/time, the display can be any valid PHP strftime format string.

[PAYMENTDATE:{%A, %e %B, %Y}] - most recent payment date

[PAYMENTDATE:+1day{%A, %e %B, %Y}:1:1000] - optional date offset and display format. The offset can be any plus or minus any number of days and the display can be any valid PHP strftime format string. The second parameter specifies the payment to show, 0 or missing means the most recent payment. The third parameter specifies the invoicee.

create your own booking group list by specifying the columns in the order you want them to appear.

for example: [BOOKGROUP:PROP_ROOM_BREF_NAME]  

ADUL= the number of adults

ARIV = Arrival date

BREF = Booking number

CHIL = the number of children

FLAG = Booking flag text

LNAM = Booking last name

ONLY = Just show the one booking

PEOP = the number of guests

POST = Booking postcode

RDE1 = Room description 1 from {#fas:cog}} (SETTINGS) PROPERTIES> ROOMS > SETUP

RNAM = Room Display Name

STAT = Booking state

TOTA = Total price

UNI2 = Unit first additional information

UNIT = Unit name

[BOOKGROUP:PROP_ROOM_BREF_NAME] will display the property name, room name,  booking number and guest name in this order.

[BOOKGROUP:BREF_NAME_PROP_ROOM] will display the booking number, guest name property name and  room name in this order.

=== Booking Group Table with fixed content===

[BOOKGROUPROOMLISTTOTAL] - create a table of guest names including room type for a group booking with guest totals

[BOOKGROUPNAMELIST] - create a table of guest names including room type and unit for a group booking

== Invoice Variables ==

[INVOICEPARTCHARGESNUM:status1,status2,status4:10%] - As per INVOICEPARTCHARGES but the value is displayed with a decimal point and no thousands separator (for calculation).

[INVOICEPAYMENTS:50%] - invoice sum of all payments with percentage multiplier

[INVOICEPAYMENTSNUM] - As per [INVOICEPAYMENTS] but the value is displayed with a decimal point and no thousands separator (for calculation)

[INVOICEPAYMENTSNUM:50%] - As per [INVOICEPAYMENTS:50%] but the value is displayed with a decimal point and no thousands separator.

[INVOICEPENDPAYAUTONUM] - auto pending payments before due date but the value is displayed with a decimal point and no thousands separator (for calculation).

[INVOICEPENDPAYAUTO1234]  auto pending payments before due date for the specified invoicee but the value is displayed with a decimal point and no thousands separator (for calculation)

[INVOICEPENDPAYAUTONUM1234] auto pending payments before due date for the specified invoicee but the value is displayed with a decimal point and no thousands separator (for calculation)

[INVOICEPENDPAYFAILNUM234] - failed pending payments (all also past) for the specified invoicee but the value is displayed with a decimal point and no thousands separator (for calculation)

[INVOICECREDITSNUM:] - As per [INVOICECREDITS:] but the value is displayed with a decimal point and no thousands separator (for calculation)

[INVOICEDEBITS:50%] - invoice sum of all debit items with percentage multiplier

[INVOICEDEBITSNUM] - As per [INVOICEDEBITS] but the value is displayed with a decimal point and no thousands separator (for calculations) (for calculations)

[INVOICEDEBITSNUM:] - As per [INVOICEDEBITS:] but the value is displayed with a decimal point and no thousands separator (for calculations)

[INVOICEVAT] - invoice sum of all vat value

[INVOICEVATNUM] - invoice sum of all vat value for calculations)

[INVOICEFIRSTITEM] - price of the item listed first in the invoice

[INVOICEFIRSTITEMNUM] - price of the item listed first in the invoice but the value is displayed with a decimal point and no thousands separator (for calculations)

[INVOICESECONDITEM] - price of the item listed second in the invoice

[INVOICESECONDITEMNUM] - price of the item listed second in the invoice but the value is displayed with a decimal point and no thousands separator (for calculations)

[INVOICETHIRDITEM] - price of the item listed third in the invoice

[INVOICETHIRDITEMNUM] - price of the item listed third in the invoice but the value is displayed with a decimal point and no thousands separator (for calculations)

[INVOICEUPSELL0] - base price without upsell items or other charges added later

[INVOICEUPSELLNUM0] - as per [INVOICEUPSELL1] but the value is displayed with a decimal point and no thousands separator (for calculations)

[INVOICEUPSELL1] - value of upsell item 1 (number can be between 0 to 20)

[INVOICEUPSELLNUM1] - as per [INVOICEUPSELL1] but the value is displayed with a decimal point and no thousands separator (for calculations)

[INVOICEUPSELLQTY1] - quantity of upsell item 1 (number can be between 1 to 20)

[INVOICEUPSELLHEADLINE1] - headline of upsell item 1 (number can be between 1 to 20)

[INVOICEEXTRAITEMDESC1] - Name of extra invoice item 1 (number can be between 0 to 20)

[INVOICEEXTRAITEM1] - value of extra invoice item 1 (number can be between 0 to 20) Note: the order goes by the order in the dropdown list not by the order the items are entered.

[INVOICEEXTRAITEM1] - value of extra invoice item 1 (number can be between 0 to 20) Note: the order goes by the order in the dropdown list not by the order the items are entered.  

[INVOICEEXTRAITEMNUM1] - as per [INVOICEEXTRAITEM1] but the value is displayed with a decimal point and no thousands separator (for calculations).

[INVOICEEXTRAITEMQTY1] - quantity of extra invoice item 1 (number can be between 0 to 20)  Note: the order goes by the order in the dropdown list not by the order the items are entered.

[INVOICEGROSS:1] - gross amount of the inserted VAT rate (number is the VAT rate), value is displayed with a decimal point and no thousands separator (for calculations)

[INVOICENET:1] - net amount of the inserted VAT rate (number is the VAT rate)

[INVOICENETNUM:1] - net amount of the inserted VAT rate (number is the VAT rate), value is displayed with a decimal point and no thousands separator (for calculations)

[INVOICEVAT:1] - VAT amount of the inserted VAT rate (number is the VAT rate)

[INVOICEVATNUM:1] VAT amount of the inserted VAT rate (number is the VAT rate), value is displayed with a decimal point and no thousands separator (for calculations)

[INVOICEITEMBYDESC:Searchterm] - searches the invoice for items with  this search term and adds them up

[INVOICEITEMBYDESCNUM:Searchterm] -  searches the invoice for items with  this search term and adds them up, value is displayed with a decimal point and no thousands separator (for calculations)

[INVOICEPAYMENTBYDESC:Searchterm] -  searches the payments for items with  this search term and adds them up

[INVOICEPAYMENTBYDESCNUM:Searchterm] -  searches the payments for items with  this search term and adds them up, value is displayed with a decimal point and no thousands separator (for calculations)

[UPSELLTABLE] - table with all upsell items

[UPSELLTABLEVAT] - table with all upsell items with vat information and vat summary

[UPSELLTABLENOREFUND] - table with all upsell items except refundable items

[INVOICETABLE] - invoice table

[INVOICETABLEVAT] - invoice table with vat information and vat summary

AMO - shows the net value (price x quantity)

CEX - charges excluded (charges will not be shown)

CON - currency conversion. Example: CONEURUSD will convert the first currency (Euros) to the second currency (USD). CON1.234 would multiply the prices by 1.234

CUA - currency symbol showing after the numbers. Example: CUA€ will show € after the figures

CUB - currency symbol showing before the numbers. Example: CUB€ will show € before the figures

DAT - adds a date column

DEC - Decimal points. Example: DEC, will show a comma as decimal point. If nothing is set the system will use the default for the language

DP0 - no decimal places

DP1 - 1  decimal place

GRP  -  Group Totals. Displays the same items as a total

GRT - Grand Total

INV - invoicee, add the invoicee number at the end. Example: INV20 to show invoicee number 20, INV0 will show items not assigned to an invoicee, INV-1 will show all items from the booking regardless of invoicee. You can combine INV[BOOKINGINVOICEEID]] to add the invoicee from the booking

LAN - language. Example LANDE will force the language to German

MUL - multiplier. Example: MUL1.2 will multiply all prices by 1.2

NIN - do not show invoice number and invoice date on locked invoices

NOC - charges will not be displayed but their vat values are still calculated for the vat summary (VAT)

NOP - payments will not be displayed

ONE - shows only items from the specified booking (not the booking group)

PAA - shows a column with payment amounts

PAY - shows payments

PEN - shows pending payments description

PPA - shows pending payments amount 

PRI - shows prices in a column

QTY - shows quantity

SEX - status excluded. Calculate the balance of all invoice items except for the ones with these status, the status items can be a comma separated list. Example:  SEX status1,status2,status4 will not show items with this status.

SIN - status included.  Calculate the balance of all invoice items with matching status, the status items can be a comma separated list. Example: SIN status1,status2,status4 will only show items with this status.

STA- shows staus

THO - thousands separator. THO. will show a dot as thousand separator. If nothing is set the system will use the default for the language

TOT - shows total amounts

VAA - shows VAT amounts

VAP - shows VAT percents

VAT - VAT summary

Connect the variables with an underscore.  

[INVOICE:PRI_QTY_CUA€] will create an invoice table with price and quantity in Euros.

[INVOICE:PAY_TOT_CEX] will create an invoice table which will only show payments.

[INVOICEEBALANCE] - invoice balance for unassigned invoice items.

[INVOICEEBALANCENUM] - invoice balance for unassigned invoice items displayed with a decimal point and no thousands separator.

[INVOICEEBALANCE1234] - invoice balance for invoice items assigned to invoicee 1234 (change 1234 to the required Invoicee Id number).

[INVOICEEBALANCENUM1234] - invoice balance for invoice items assigned to invoicee 1234 (change 1234 to the required Invoicee Id number) displayed with a decimal point and no thousands separator.

[INVOICEECHARGES] - invoice charges for unassigned invoice items.

[INVOICEECHARGESNUM] - invoice charges for unassigned invoice items displayed with a decimal point and no thousands separator.

[INVOICEECHARGES1234] - invoice charges for invoice items assigned to invoicee 1234  (change 1234 to the required Invoicee Id number).

[INVOICEECHARGESNUM1234] - invoice charges for invoice items assigned to invoicee 1234 (change 1234 to the required Invoicee Id number) displayed with a decimal point and no thousands separator.

[INVOICEEPAYMENTS] - invoice payments for unassigned invoice items.

[INVOICEEPAYMENTSNUM] - invoice payments for unassigned invoice items displayed with a decimal point and no thousands separator.

[INVOICEEPAYMENTS1234] - invoice payments for invoice items assigned to invoicee 1234  (change 1234 to the required Invoicee Id number)

[INVOICEEPAYMENTSNUM1234] - invoice payments for invoice items assigned to invoicee 1234  (change 1234 to the required Invoicee Id number)

[INVOICEENAME] - name of the invoicee account the invoice is assigned to or blank

[INVOICEECODE] - code of the invoicee account the invoice is assigned to or blank

[INVOICEECURRENCY] - currency of the invoicee account the invoice is assigned to if it is not the property default or blank

[INVOICEETEMPLATE1] - template value 1 of the invoice account the invoice is assigned to or blank

[INVOICEETEMPLATE2] - template value 2 of the invoice account the invoice is assigned to or blank

[INVOICEETEMPLATE3] - template value 3 of the invoice account the invoice is assigned to or blank

[INVOICEETEMPLATE4] - template value 4 of the invoice account the invoice is assigned to or blank

[INVOICEETEMPLATE5] - template value 5 of the invoice account the invoice is assigned to or blank

[INVOICEETEMPLATE6] - template value 6 of the invoice account the invoice is assigned to or blank

[INVOICEETEMPLATE7] - template value 7 of the invoice account the invoice is assigned to or blank

[INVOICEETEMPLATE8] - template value 8 of the invoice account the invoice is assigned to or blank

[ICALURL] - Calendar link

[ICALURL:16] - Calendar link with check-in hour. Replace '16' with the hour check-in starts.

[ICALURL::10] - Calendar link with check-out hour. Replace '10' with the hour with the hour check-out ends.

[ICALURL:::summary text] - Calendar link with a summary text

[ICALURL::::description text] - Calendar link with a descriptive text

Calendar link with check-in time 16:00, check-out time 10:00, the summary text "Booking" and the description text "Sunny Hotel":

[ICALURL:16:10:Booking:Sunny Hotel]

[GUESTIDS] - comma separated list of guest Id's connected to the booking

[GUESTFLAGTEXTS] - comma separated list of flag text values for each guest (when not empty) connected to the booking

[PAYURL] - Creates a  payment url for the payment request for the amount in the booking deposit field if non zero, otherwise the outstanding balance.

[PAYURL:25%] - Creates a payment url for the payment request for a percentage of the outstanding balance. Use 100% to specify the full outstanding balance.

[PAYURL:200] - Creates a payment url for the payment request url for a fixed amount. nt.

[PAYLINK] - Creates a  payment link (HTML A tag) for the payment request for the amount in the booking deposit field if non zero, otherwise the outstanding balance.

[PAYLINK:25%] -Creates a  payment link (HTML A tag) for the payment request for a percentage of the outstanding balance. Use 100% to specify the full outstanding balance.

[PAYLINK:200] - Creates a payment link (HTML A tag) for the payment request) for a fixed amount.

[PAYBUTTON] - Creates a payment button for the payment request for the amount in the booking deposit field if non zero, otherwise the outstanding balance. Not recommended for emails.

[PAYBUTTON:25%] - Creates a payment button for the payment request for a percentage of the outstanding balance. Use 100% to specify the full outstanding balance. Not recommended for emails.

[PAYBUTTON:200] - Creates a payment button for the payment request for a fixed amount.

[PAYPALURL] - Creates a Paypal payment url for the amount in the booking deposit field if non zero, otherwise the outstanding balance.

[PAYPALURL:25%] - Creates a Paypal payment url for a percentage of the outstanding balance. Use 100% to specify the full outstanding balance.

[PAYPALURL:200] - Creates a Paypal payment url for a fixed amount. A zero amount will cause paypal to provide a field to enter an amount.

[PAYPALLINK] - Creates a Paypal payment link (HTML A tag) for the amount in the booking deposit field if non zero, otherwise the outstanding balance.

[PAYPALLINK:25%] - Creates a Paypal payment link (HTML A tag) for a percentage of the outstanding balance. Use 100% to specify the full outstanding balance.

[PAYPALLINK:200] - Creates a Paypal payment link (HTML A tag) for a fixed amount. A zero amount will cause paypal to provide a field to enter an amount.

[REPLACE|searchForThisText|replaceWithThisText|textToSearch] - replace "searchForThisText" with "replaceWithThisText" within the text "textToSearch"

[+] - Example: 2 [+] 3 = 5

[-] - Example: 5 [-] 1 = 4

[*] - Example: 3 [*] 4 = 12

[/] - Example: 15 [/] 5 = 3

[MIN] - Example: 2 [MIN] 3 = 2

[MAX] - Example: 2 [MAX] 3 = 3

Brackets are not supported as a way to control processing order, the processing order is fixed as *, /, +, -, MIN, MAX

=== Rounding and controlling decimal places ===

2 [/] 3 = 0.66666666666667

==== Rounding to the nearest integer ====

2 [/.0] 3 = 1

2 [/.1] 3 = 0.7

2 [/.2] 3 = 0.67

2 [/.3] 3 = 0.667

2 [/.4] 3 = 0.6667

<b>This works on all operators including [MIN] and [MAX]</b>

Note: Always use the template variables ending with NUM. The math functions will only work with numbers with a decimal point (not a decimal comma) and no thousands separator and no currency symbol.

[CONVERT:EUR-USD] - get the actual conversion rate between two currencies, this can be used with math functions to show alternative currency values. All currencies supported by the booking page currency selector can be used.

Example: [INVOICECHARGESNUM] [*.2]  [CONVERT:EUR-USD] will convert the invoice charge value from Euros to USD with two decimal points.

If you use the multiplier to convert currencies for channels: For example hotel id 123456 and a multiplier to convert USD to EUR at todays rate: