17,548
edits
Changes
Jump to navigation
Jump to search
[[Category:Booking Page]]
Below is <div class="heading">Template variables</div> On this page you find a List list of '''''Template Variables'''''template variables and information on how they are used.
[BOOKINGIP] - ip address of booker's computerRDE0 = Room description from {{#fas:cog}} (SETTINGS) CHANNEL MANAGER > PROPERTY CONTENT > ROOM CONTENT
[VIEWBOOKING] - create a URL to log into the control panel and view this booking RDE1 = Room description 1 from {{#fas:cog}} (for hosts, not intended to be sent to guestsSETTINGS)PROPERTIES> ROOMS > SETUP
[EMAIL:00] - Status of an Auto Action email. Replace 00 with the number of the Auto Action. This shows if the email has been sent and if so, the time it was sent.RNAM = Room Display Name ROOM = Room name
[BOOKIDLAST1] - Last 1 digit RQTY = shows the number of rooms for each booking numberand a total at the bottom
[BOOKIDLAST2] - Last 2 digits of booking numberSTAT = Booking state
[BOOKIDLAST3] - Last 3 digits of booking numberSTUS = Status
[BOOKIDLAST4] - Last 4 digits of booking numberTOTA = Total price
[BOOKIDLAST5] - Last 5 digits of booking numberUNI2 = Unit first additional information UNI3 = Unit second additional information
[BOOKIDLAST6] - Last 6 digits of booking numberUNIT = Unit name
[BOOKIDLAST7] - Last 7 digits of booking number
[BOOKIDLAST8] - Last 8 digits of booking numberConnect the parameters with an underscore.
[RANDOM1] - a 1 digit random number seeded from the booking numberExamples:
[RANDOM3] - a 3 digit random number seeded from the booking number
[INVOICEEXTRAITEMNUM1INVOICEGROSSNUM:1] - as per [INVOICEEXTRAITEM1] but gross amount of the value inserted VAT rate (number is displayed with a decimal point and no thousands separator.the VAT rate)
== Math Variables ==[PAYLINK:200] - Creates a payment link (HTML A tag) for the payment request) for a fixed amount.
Place math variables between two numbers[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. Math variables can operate on template variables that return a number
[*.2] - will multiply the two numbers either side of the template variable and round to 2 decimal places== Text Operators ==
[*.4] - will multiply the two numbers either side of the template variable and round to 4 decimal places
[/.0] - will divide the number left of the template variable by the number right and round to the nearest integer
[/.2] - This will divide test for the number left first 4 characters of the template variable by the Guest phone number right and round to 2 decimal places.
[/.3] - will divide the number left of the template variable by the number right and round to 3 decimal places
[Calendar link with check-.0] in time 16:00, check- will subtract out time 10:00, the number right of the template variable from the number left summary text "Booking" and round to the nearest integerdescription text "Sunny Hotel":
[-.2] - will subtract the number right of the template variable from the number left and round to 2 decimal places== Mathematical Operators ==
[-.3] - will subtract the number right of the Place mathematical operators between two numbers <b>or between two template variable from the variables</b> that return a number left and round to 3 decimal places.
[Brackets are not supported as a way to control processing order, the processing order is fixed as *, /, +, -, MIN.4] - will show the lowest of the numbers left and right of the template variable and round to 4 decimal places, MAX
[MAX.<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> Property Template 1] - will show the highest of the numbers left 8 and right of the template variable and round Room Template 1-8 can be used to set calculations. If using Room Templates to 1 decimal placemake a calculation, then use Room Template 8 before Room Template 7.
[MAXYou can set a calculation in Room Templates to show in Property Templates, but not the other way around.3] - will show So "Property Template1" could pull the highest calculation of the numbers left [ROOMTEMPLATE6] and right of the template variable and round to 3 decimal placesresult = 10.
[MAX.4] - will show the highest of the numbers left and right of the template variable and round to 4 decimal places
Note: The math functions will only work with numbers with a decimal point and no thousands separator and no currency symbol2 [/] 3 = 0.66666666666667
Example: [INVOICECHARGESNUM] [*.==== Rounding to 1,2] [CONVERT:EUR-USD] will convert the invoice charge value from Euros to USD with two ,3 or 4 decimal points.place(s) ====
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:2 [/.1] 3 = 0.7
123456*2 [CONVERT:USD-EUR/.2]*3 = 0.67
or this to convert EUR to USD2 [/.3] 3 = 0.667
123456*2 [CONVERT:EUR-USD/.4]3 = 0.6667
== Custom Date Format Variables ==
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]
[FIRSTNIGHT Note:+1day{%A, %e %B, %Y}] - optional date offset and display format Always use the template variables ending with NUM. The offset can be any plus or minus any number of days math functions will only work with numbers with a decimal point (not a decimal comma) and no thousands separator and the display can be any valid PHP strftime format stringno currency symbol.
[LASTNIGHT:{%A, %e %B, %Y}] - last night booked== Currency Conversion ==
[LEAVINGDAYIf you use the multiplier to convert currencies for channels:+1day{%A, %e %B, %Y}] - optional date offset For example hotel id 123456 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.a multiplier to convert USD to EUR at todays rate:
[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.this to convert EUR to USD
no edit summary
[[Category:Guest_Management]]
[[Category:Messaging]]
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.
[PROPERTYNAME] - property name
[PROPERTYADDRESS] - property full address
[PROPERTYCITY] - property city
[PROPERTYFAX] - property fax
[PROPERTYCONTACTLASTNAME] - property contact last name
[PROPERTYCONTACTFIRSTNAME] - property contact first name
[PROPERTYID] - property id number
[PROPERTYLOCATIONDESCRIPTION] - property location description
[PROPERTYLOCATIONDESCRIPTIONBR] - property location description with line break [PROPERTYDIRECTIONS] - property directions from (Settings > Channel Manager {{#fas:cog}} (SETTINGS) CHANNEL MANNAGER > Property ContentPROPERTY CONTENT)
[PROPERTYHEADLINE] - property headline
[PROPERTYDESCRIPTION] - property description
[PROPERTYGENERALPOLICY] - property rental policy [PROPERTYGENERALPOLICYBR] - property rental policy with line break [PROPERTYLEGALPOLICY] - property rental policy/ obsolete
[PROPERTYCANCELPOLICY] - property cancellation policy
[PROPERTYCANCELPOLICYBR] - property cancellation policy with line breaks [PROPERTYHOUSERULES] - property house rules (Settings {{#fas:cog}} (SETTINGS) CHANNEL MANAGER > Channel Manager PROPERTY CONTENT) [PROPERTYHOUSERULESBR] - property house rules ({{#fas:cog}} (SETTINGS) CHANNEL MANAGER > Property ContentPROPERTY CONTENT)with line break
[PROPERTYTEMPLATE1] - Property Template 1
[PROPERTYTEMPLATE4] - Property Template 4
[PROPERTYTEMPLATE5] - Property Template 5
[PROPERTYTEMPLATE5] - Property Template 6
[PROPERTYTEMPLATE7] - Property Template 7
[PROPERTYTEMPLATE8] - Property Template 8
[PROPERTYTEMPLATE1BR] - Property Template 1 with line breaks
[PROPERTYTEMPLATE2BR] - Property Template 2 with line breaks
[PROPERTYTEMPLATE3BR] - Property Template 3 with line breaks
[PROPERTYTEMPLATE4BR] - Property Template 4 with line breaks
[PROPERTYTEMPLATE5BR] - Property Template 5 with line breaks
[PROPERTYTEMPLATE6BR] - Property Template 6 with line breaks
[PROPERTYTEMPLATE7BR] - Property Template 7 with line breaks
[PROPERTYTEMPLATE8BR] - Property Template 8 with line breaks
[BOOKINGCOMHOTELID] - booking.com hotel id
[EXPEDIACOMHOTELID] - expedia.com hotel id
[PERMITID] - the permit ID
[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
[PROPERTYGROUP] - shows the group keywords
== Room Variables ==
[ROOMID] - room id number
[ROOMNAME] - room names of all booked rooms(not for cancelled bookings use ROOMNAMEINC if used for cacelled bookings) [ROOMNAMEBR] - room names with line break [ROOMNAMEINC] room names of all booked rooms including for cancelled bookings [ROOMNAMEINCBR] room names with line break
[ROOMNAME1] - room name of first booked room
[ROOMNAMES] - room names including quantity of each booked room
[ROOMNAMESNC] - room names including quantity of each booked room without cancelled rooms
[ROOMNAMESBR] - room names with line break
[ROOMNAMESNCBR] room names with line break without cancelled rooms
[ROOMNAMEOFFER] - room names of all booked rooms with offer name
[ROOMNAMEOFFERBR] - room names of all booked rooms with offer name with line break
[ROOMNAMEOFFERINC] room names of all booked rooms with offer name incl. cancelled bookings
[ROOMNAMEOFFERINCBR] - room names of all booked rooms with offer name with line break
[ROOMTYPEDESC] - room accommodation type first booked room
[ROOMTYPEDESCS] - room accommodation type all booked rooms
[ROOMIDROOMTYPEDESCSINC] - room id numberaccommodation type all booked rooms including cancelled bookings [ROOMSIZE] - size of the room
[ROOMTEMPLATE1] - ROOM Template 1
[ROOMTEMPLATE4] - ROOM Template 4
[ROOMTEMPLATE5] - ROOM Template 5
[ROOMTEMPLATE6] - ROOM Template 6
[ROOMTEMPLATE7] - ROOM Template 7
[ROOMTEMPLATE8] - ROOM Template 8
[ROOMTEMPLATE1BR] - ROOM Template 1 with linkbreak
[ROOMTEMPLATE2BR] - ROOM Template 2 with linkbreak
[ROOMTEMPLATE3BR] - ROOM Template 3 with linkbreak
[ROOMTEMPLATE4BR] - ROOM Template 4 with linkbreak
[ROOMTEMPLATE5BR] - ROOM Template 5 with linkbreak
[ROOMTEMPLATE6BR] - ROOM Template 6 with linkbreak
[ROOMTEMPLATE7BR] - ROOM Template 7 with linkbreak
[ROOMTEMPLATE8BR] - ROOM Template 8 with linkbreak
[ROOMMETAAUXTEXT] - room meta text setting for first booked room
[ROOMMETAAUXTEXTS] - room meta text setting for all booked rooms [ROOMMETAAUXTEXTSINC] - room meta auxiliary text setting for all booked rooms
[INTERNALROOMNAME] - internal room name as used in the control panel, this is not the translated room name shown on the booking page
[OFFERID] - ID of the boked offer
[OFFERNAME] - booked offer name for all booked rooms
[OFFERNAME1] - offer name for this booked room only
[OFFERNAMEINC] - offer name for this booked room only including cancelled bookings
[OFFERDESCRIPTION1] - offer description 1 for all booked rooms
[OFFERDESCRIPTION1INC] - offer description 1 for all booked rooms incl. cancelled
[OFFERDESCRIPTION2] - offer description 2 for all booked rooms
[UNITNAMEOFFERDESCRIPTION2INC] - unit names of offer description 2 for all the assigned room typesbooked rooms incl. cancelled
[UNITNAME:OFFERDESCRIPTION1-1] - additional information about the unit offer description 1 for all the assigned this booked room types
[UNITNAME1OFFERDESCRIPTION2-1] - unit name of the first assigned offer description 2 for this booked room
[UNITNAME1:1OFFERSUMMARY] - additional information about the first assigned room / add the additional information on each line after a | symbol where you set the unit namessummary offers
[ROOMDESCRIPTIONOFFERSUMMARYINC] - Room description (Settings > Channel Manager > Property Content > Room Content)summary offers including cancelled bookings
[UNITID] - ID of the unit (number) [UNITNAME] - unit names of all the assigned room types in the booking group (cancelled bookings are not shown) [UNITNAMEINC] - unit names of all the assigned room types in the booking group including cancelled bookings [UNITNAME:1] - additional information (first) about the unit for all the assigned room types in the booking group (cancelled bookings are not shown) [UNITNAME:2] - additional information (second) about the unit for all the assigned room types in the booking group (cancelled bookings are not shown) [UNITNAME1] - unit name of the assigned room for this booking number [UNITNAME1:1] - additional information about the assigned room for this booking number / add the additional information on each line after a | symbol where you set the unit names [UNITSTATUS1] - the status of the unit [ROOMDESCRIPTION] - Room description from {{#fas:cog}} (SETTINGS) CHANNEL MANAGER > PROPERTY CONTENT > ROOM CONTENT [ROOMDESCRIPTION1] - Room description 1 from {{#fas:cog}} (Settings SETTINGS) PROPERTIES > Properties ROOMS > Rooms SETUP [LEAVINGDAYAVAIL] - returns yes or no, can be used to trigger an Auto Action [NUMROOMSAVAIL] - returns the number of available rooms (-1 if overbooked), can be used to trigger an Auto Action [ROOMRACKRATENUM] - Rack Rate from {{#fas:cog}} (SETTINGS) CHANNEL MANAGER > SetupPROPERTY 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
== Booking Variables ==
[BOOKIDVIEWBOOKING] - create a URL to log into the control panel and view this booking reference (for hosts, not intended to be sent to guests)
[BOOKID] - booking reference number [BOOKIDS] - booking reference numbers of all bookings in a group [BOOKIDSINC] - booking reference of all bookings in a group including cancelled bookings [GROUPID] - booking reference of the master booking [REFERENCENUMBER] - booking reference (same as [BOOKID]) [BOOKIDLAST1] - Last 1 digit of booking number [BOOKIDLAST2] - Last 2 digits of booking number [BOOKIDLAST3] - Last 3 digits of booking number [BOOKIDLAST4] - Last 4 digits of booking number [BOOKIDLAST5] - Last 5 digits of booking number [BOOKIDLAST6] - Last 6 digits of booking number [BOOKIDLAST7] - Last 7 digits of booking number [BOOKIDLAST8] - Last 8 digits of booking number [BEDDING] - displays bedding info codes [RANDOM1] - a 1 digit random number seeded from the booking number [RANDOM2] - a 2 digit random number seeded from the booking number [RANDOM3] - a 3 digit random number seeded from the booking number [RANDOM4] - a 4 digit random number seeded from the booking number [RANDOM5] - a 5 digit random number seeded from the booking number [RANDOM6] - a 6 digit random number seeded from the booking number [RANDOM7] - a 7 digit random number seeded from the booking number [RANDOM8] - a 8 digit random number seeded from the booking number [VOUCHERPHRASE1] - Voucher Phrase - change the nubmer to the voucher you want to print out. [VOUCHERAMOUNT1] - Voucher Amount - change the nubmer to the voucher you want to print out. === Content from "Info" tab ===[BOOKINGINFOITEMS] - Booking Info Codes - Codes and text [BOOKINGINFOITEMSBR] - Booking Info Codes - Codes and text with line break [BOOKINGINFOTEXTS] - Booking Info Codes - Text only [BOOKINGINFOTEXTSBR] Booking Info Codes - Text only with line break [BOOKINGINFOCODES] - Booking Info Codes - Codes only [BOOKINGINFOCODESBR] - Booking Info Codes - Codes and text with line break [BOOKINGINFOCODETEXT:infoCode] - the most recent Text value of the specified Booking Info Code, "infoCode" in this example [BOOKINGINFOCODEDATE:infoCode]- the most recent date value of the specified Booking Info Code, "infoCode" in this example, supports custom date/time formats {%A, %e %B, %Y} after the infoCode [INTERNALNOTES] - content from "Internal Notes" on the Info Tab [INTERNALNOTESBR] - content from "Internal Notes" on the Info Tab with line break [INTERNALNOTESHR] - content from "Internal Notes" on the Info Tab with separating line === Content from "Summary" tab see also under "Room" and "Property" ===[STATUS] - status of booking [SUBSTATUS] - sub status of the booking
[FIRSTNIGHT] - first night booked
[LEAVINGDAYYYYY-MM-DD] - check-out day in YYYY-MM-DD format
[NUMROOMNUMNIGHT] - number of nights [NUMNIGHTS] - number of nights sum across group booking [NUMNIGHTSINC] - number of nights sum across group booking incl. cancelled [GUESTTITLE] - guest title on the quantity "summary" tab of rooms booked (the booking [GUESTFIRSTNAME] - first room type only) name on the "summary" tab of the booking [GUESTNAME] - last name on the "summary" tab of the booking
[NUMROOMSGUESTNAMES] - name of all guests in the booking on the quantity "summary" tab of rooms booked (sum of all rooms and room types) the booking
[NUMNIGHTGUESTNAMESINC] - number name of nights all guests in the booking on the "summary" tab of the booking incl. cancelled bookings
[NUMADULTGUESTNAMESINCBR] - number name of adults all guests in this room or in group if master the booking on the "summary" tab of the booking incl. cancelled bookings with line break on the "summary" tab of the booking
[NUMADULT1GUESTFULLNAME] - number title, first name, last name on the "summary" tab of adults in this roomthe booking
[NUMCHILDGUESTFULLNAMES] - number titles, first names, last names of children all guests in this room or in group if master the booking on the "summary" tab of the booking
[NUMCHILD1GUESTFULLNAMESBR] - number titles, first names, last names of children all guests in this roomthe booking with line break on the "summary" tab of the booking
[NUMPEOPLEGUESTFULLNAMESINC] - number titles, first names, last names of all guests in this room or in group if master the booking on the "summary" tab of the bookingincl. cancelled
[NUMPEOPLE1GUESTFULLNAMESINCBR] - number titles, first names, last names of people all guests in this roomthe booking with line break on the "summary" tab of the booking incl. cancelled
[RATEDESCGUESTCOMMENTS] - rate descriptioncomments in the booking
[RATEDESCBRGUESTCOMMENTSBR] - name of comments in the rate booking with HTML <line breaks <BR> to force new lines>
[PRICENOTES] - Value in price field (number entered in the price field of the booking) with currency symbolnotes
[PRICENCNOTESBR] - Value in price field (number entered in the price field of the booking) without currency symbolnotes with line breaks <BR>
[PRICE:10%GUESTARRIVALTIME] - Percentage value of Price arrival time
[PRICE:-10NUMADULT] - Price with offset amountnumber of adults in this room or in group if master booking (not for cancelled bookings use NUMADULTINC if used for cacelled bookings)
[PRICENUMNUMADULTINC] - As per [PRICE] but the value is displayed with a decimal point and no thousands separator and no currency symbolsnumber of adults in this room or in group if master booking incl. cancelled bookings
[PRICENUM:NUMADULT1] - As per [PRICE:] but the value is displayed with a decimal point and no thousands separator and no currency symbols. number of adults in this room
[PRICELESSTAXNUMCHILD] - Value number of children in price field less value this room or in tax field with currency symbolgroup if master booking (not for cancelled bookings use NUMCHILDINC if used for cacelled bookings)
[PRICELESSTAXNUMNUMCHILDINC] - As per [PRICELESSTAX] but the value is displayed with a decimal point and no thousands separator and no currency symbols.number of children in this room or in group if master booking including cancelled bookings
[AVPRICENUMCHILD1] - Average Nightly Price with currency symbolnumber of children in this room
[AVPRICENUMNUMPEOPLE] - Average Nightly Price with a decimal point and no thousands separator and no currency symbols. number of guests in this room or in group if master booking
[AVPRICE:20%NUMPEOPLEINC] - Percentage value number of Average Nightly Price guests in this room or in group if master booking incl. cancelled bookings
[AVPRICE:15NUMPEOPLE1] - Average Nightly Price with offset amountnumber of people in this room
[DEPOSITGUESTPHONE] - Value in deposit field with currency symbolguests phone number
[DEPOSITNUMGUESTPHONENUM] - As per [DEPOSIT] but the value is displayed guests phone number with a decimal point and no thousands separator and no currency symbols. all non-numeric characters removed
[TAXGUESTMOBILE] - Value in tax field with currency symbolguests mobile number
[TAXNUMGUESTMOBILENUM] - As per [TAX] but the value is displayed guests mobile number with a decimal point and no thousands separator and no currency symbols.all non-numeric characters removed
[COMMISSIONMOBILELAST1] - Value in commission field with currency symbollast digit of the guests mobile number, if mobile is empty the guests phone number will be used.
[COMMISSIONNUMMOBILELAST2] - As per [COMMISSION] but last 2 digits of the value guests mobile number, if mobile is displayed with a decimal point and no thousands separator and no currency symbolsempty the guests phone number will be used.
[PAYPALURLMOBILELAST3] - Creates a Paypal payment url for last 3 digits of the amount in the booking deposit field guests mobile number, if non zero, otherwise mobile is empty the outstanding balanceguests phone number will be used.
[PAYPALURL:25%MOBILELAST4] - Creates a Paypal payment url for a percentage last 4 digits of the outstanding balanceguests mobile number, if mobile is empty the guests phone number will be used.
[PAYPALURL:200MOBILELAST5] - Creates a Paypal payment url for a fixed amount. A zero amount last 5 digits of the guests mobile number, if mobile is empty the guests phone number will cause paypal to provide a field to enter an amountbe used.
[PAYPALLINKMOBILELAST6] - Creates a Paypal payment link (HTML A tag) for last 6 digits of the amount in the booking deposit field guests mobile number, if non zero, otherwise mobile is empty the outstanding balanceguests phone number will be used.
[PAYPALLINK:25%PHONELAST1] - Creates a Paypal payment link (HTML A tag) for a percentage last digit of the outstanding balance.guests phone number if guest phone is empty it will use the guests mobile number
[PAYPALLINK:200PHONELAST2] - Creates a Paypal payment link (HTML A tag) for a fixed amount. A zero amount last 2 digits of the guests phone number if guest phone is empty it will cause paypal to provide a field to enter an amount.use the guests mobile number
[PAYPALBUTTONPHONELAST3] - Creates a Paypal payment button for last 3 digits of the amount in the booking deposit field guests phone number if non zero, otherwise guest phone is empty it will use the outstanding balance. Not recommended for emails.guests mobile number
[PAYPALBUTTON:25%PHONELAST4] - Creates a Paypal payment button for a percentage last 4 digits of the outstanding balance. Not recommended for emails.guests phone number if guest phone is empty it will use the guests mobile number
[PAYPALBUTTON:200PHONELAST5] - Creates a Paypal payment button for a fixed amount. A zero amount last 5 digits of the guests phone number if guest phone is empty it will cause paypal to provide a field to enter an amount. Not recommended for emails.use the guests mobile number
[GUESTTITLEPHONELAST6] - last 6 digits of the guests phone number if guest titlephone is empty it will use the guests mobile number
[GUESTFIRSTNAMEGUESTSMS:49] - first name attempt to convert the guest mobile number into a format suitable for SMS, if country code is missing add the one supplied in the template variable, if mobile number is empty use guest phone number instead.
[GUESTNAMEGUESTCOMPANY] - last company name
[GUESTFULLNAMEGUESTCOMPANYBR] - title, first name, last company namewith line breaks
[GUESTEMAILGUESTFAX] - guest's Email addressguests fax number
[GUESTPHONEGUESTFAXNUM] - guests phone fax number with all non-numeric characters removed
[GUESTADDRESS] - guests address
[GUESTADDRESSBR] - guests address with line breaks
[GUESTSADDRESSSBR1INC] - guests address with line breaks incl. cancelled bookings
[GUESTPOSTCODE] - guests postcode
[GUESTCITY] - guests city
[GUESTSTATE] - guests state
[GUESTCOUNTRY] - guests country from free text field is not empty, otherwise from selector list
[GUESTCOUNTRYHL] - guests country from free text field is not empty, otherwise from selector list in hosts language
[GUESTCOUNTRYGL] - guests country from free text field is not empty, otherwise from selector list in guests language
[GUESTCOUNTRYSELECT] - guests country from selector list
[GUESTCOUNTRYTEXTGUESTCOUNTRYSELECTHL] - guests country from free text fieldselector list in hosts language
[GUESTMOBILEGUESTCOUNTRYSELECTGL] - guests mobile number country from selector list in guests language
[GUESTFAXGUESTCOUNTRYTEXT] - guests fax numbercountry from free text field
[GUESTARRIVALTIMEGUESTCOUNTRY2] - arrival time guests country from selector list as two letter code
=== Content from "Details" tab ===[GUESTCOMMENTSMESSAGE] - comments in the content of the booking message field
[GUESTCOMMENTSBRMESSAGEBR] - comments in the content of the booking message field with line breaks <BR>
[GUESTCUSTOMQ1] - answer to custom question 1
[GUESTCUSTOMQ1BR] - answer to custom question 1 with line breaks <BR>
[GUESTCUSTOMQ2] - answer to custom question 2
[GUESTCUSTOMQsBR] - answer to custom question 2 with line breaks <BR>
[GUESTCUSTOMQ3] - answer to custom question 3
[GUESTCUSTOMQ3BR] - answer to custom question 3 with line breaks <BR>
[GUESTCUSTOMQ4] - answer to custom question 4
[GUESTCUSTOMQ4BR] - answer to custom question 4 with line breaks <BR>
[GUESTCUSTOMQ5] - answer to custom question 5
[GUESTCUSTOMQ5BR] - answer to custom question 5 with line breaks <BR>
[GUESTCUSTOMQ6] - answer to custom question 6
[GUESTCUSTOMQ6BR] - answer to custom question 6 with line breaks <BR>
[GUESTCUSTOMQ7] - answer to custom question 7
[GUESTCUSTOMQ7BR] - answer to custom question 7 with line breaks <BR>
[GUESTCUSTOMQ8] - answer to custom question 8
[GUESTCUSTOMQ8BR] - answer to custom question 8 with line breaks <BR>
[GUESTCUSTOMQ9] - answer to custom question 9
[GUESTCUSTOMQ9BR] - answer to custom question 9 with line breaks <BR>
[GUESTCUSTOMQ10] - answer to custom question 10
[GUESTLANGUAGEGUESTCUSTOMQ10BR] - guest languageanswer to custom question 10 with line breaks <BR> [REFERENCE] - content of the booking reference field [NUMROOM] - the quantity of rooms booked (first room type only) [NUMROOMS] - the quantity of rooms booked (sum of all rooms and room types) [NUMROOMSINC] - the quantity of rooms booked (sum of all rooms and room types) inc. cancelled
[REFERRERFLAG] - Referrer Flag
[REFERRER2STATUSCODE] - Referrer2 'Status Code' (Under tab 'Detail'. Can be a value between 0-100.)
[ORIGINALREFERRER] - Original referrer
[REFERRER] - Referrer
[APIREF] - the booking number at the originating channel
[APISOURCE] - Beds24 channel number
[APISOURCETEXT] - human readable name of the channel
[BOOKINGIP] - ip address of booker's computer
[APIMESSAGE] - api message sent by originating channel
[NOTESBOOKINGDATE] - notes booking date in guests language [BOOKINGTIMEDATE] - booking date and time in guests language [BOOKINGDATEYYYY-MM-DD] - booking date in YYYY-MM-DD format see date and time variables below for custom time formats. === Content from "Charges and Payments" tab (also see "Invoice/Invoicee/Room") ===[BOOKINGINVOICEEID] - invoicee id assigned to this booking, this comes from the booking invoicee setting, not from the bookings invoice items [RATEDESC] - rate description (in the booking popup under the tab 'Charges & Payments') [RATEDESCBR] - name of the rate with HTML <BR> to force new lines [PRICE] - Value in price field (number entered in the price field of the booking) with currency symbol [PRICENC] - Value in price field (number entered in the price field of the booking) without currency symbol (do not use in calculations, use PRICENUM) [PRICE:10%] - Percentage value of Price [PRICE:-10] - Price with offset amount [PRICENUM] - As per [PRICE] but the value is displayed with a decimal point and no thousands separator and no currency symbols (for calculation). [PRICENUM:] - As per [PRICE:] but the value is displayed with a decimal point and no thousands separator and no currency symbols (for calculation) [PRICELESSCOMMISSION] - Value in price field less value in commission field with currency symbol [PRICELESSCOMMISSIONNUM] - As per [PRICELESSCOMMISSION] but the value is displayed with a decimal point and no thousands separator and no currency symbols (for calculation) [PRICELESSTAX] - Value in price field less value in tax field with currency symbol [PRICELESSTAXNUM] - As per [PRICELESSTAX] but the value is displayed with a decimal point and no thousands separator and no currency symbols (for calculation) [AVPRICE] - Average Nightly Price with currency symbol [AVPRICENUM] - Average Nightly Price with a decimal point and no thousands separator and no currency symbols (for calculation) [AVPRICE:20%] - Percentage value of Average Nightly Price [AVPRICE:15] - Average Nightly Price with offset amount [BASEPRICE] - Lodging Price [BASEPRICENUM] - same as [BASEPRICE] with a decimal point and no thousands separator and no currency symbols (for calculation) [BASEGROUPPRICE] - Lodging Price for Group [BASEGROUPPRICENUM] - same as BASEGROUPPRICE] with a decimal point and no thousands separator and no currency symbols (for calculation) [BASEVAT] - Lodging Price vat amount [BASEVATNUM] - same as [BASEVAT] with a decimal point and no thousands separator and no currency symbols (for calculation) [BASEGROUPVAT] - Lodging Price vat amount for Group [BASEGROUPVATNUM] - same as BASEGROUPVAT] with a decimal point and no thousands separator and no currency symbols (for calculation) [AVBASEPRICE] - Average Nightly Lodging Price [AVBASEPRICENUM] - same as [AVBASEPRICE] with a decimal point and no thousands separator and no currency symbols (for calculation) [AVBASEGROUPPRICE] Average Nightly Lodging Price for Group [AVBASEGROUPPRICENUM] - same as [AVBASEGROUPPRICE] with a decimal point and no thousands separator and no currency symbols (for calculation) [DEPOSIT] - Value in deposit field with currency symbol [DEPOSITNUM] - As per [DEPOSIT] but the value is displayed with a decimal point and no thousands separator and no currency symbols (for calculation) [TAX] - Value in tax field with currency symbol [TAXNUM] - As per [TAX] but the value is displayed with a decimal point and no thousands separator and no currency symbols (for calculation). [COMMISSION] - Value in commission field with currency symbol [COMMISSIONNUM] - As per [COMMISSION] but the value is displayed with a decimal point and no thousands separator and no currency symbols (for calculation) [COMMISSIONGROUP] - Value of the commission of the complete group booking [GUESTVOUCHER] - voucher code used with booking [CARDLASTFOUR] - last 4 digits of card [CARDFIRSTSIX] - first 6 digits of card ===Content from Invoice" tab===[BOOKINGINVOICEEID] - invoicee id assigned to this booking, this comes from the booking invoicee setting, not from the bookings invoice items [BOOKINGINVOICEENAME] - invoicee name assigned to this booking, this comes from the booking invoicee setting, not from the bookings invoice items ===Content from "Group Invoice" tab===[GROUPNOTE] - group note === Content from "Mail & Actions" tab ===[GUESTEMAIL] - guest's Email address on the "summary" tab of the booking [GUESTLANGUAGE] - guest language [EMAIL:00] - Status of an Auto Action email. Replace 00 with the number of the Auto Action. This shows if the email has been sent and if so, the time it was sent. === Content from "Guests" tab ===[GUESTSID] - all IDs of this booking [GUESTSID1] - ID of the first guest [GUESTSIDS] - all IDs for all bookings in the group [GUESTSNAME] - name of all guests listed on the "guests" tab of this booking [GUESTSNAMES] - name of all guests listed on the "guests" tab of the booking of the group booking [GUESTSNAMESINC] - name of all guests listed on the "guests" tab of the booking of the group booking incl. cancelled [GUESTSFIRSTNAMES] - first name of all guests listed on the "guests" tab of this booking last separated by an & [GUESTSFIRSTNAMESINC] - first name of all guests listed on the "guests" tab of this booking incl. cancelled [GUESTSLASTNAMES] - last name of all guests listed on the "guests" tab of this booking [GUESTSLASTNAMESINC] - last name of all guests listed on the "guests" tab of this booking incl. cancelled [GUESTSADDRESSSBR1] - address of the first guest on the "guests" tab of this booking group [GUESTSADDRESSSBR1INC] - address of the first guest on the "guests" tab of this booking group incl. cancelled [GUESTSAFULLADDRESSSBR1INC] - the first address including city, postcode, sate and country from the guests tab of the booking including cancelled bookings in international format [GUESTSAFULLADDRESSSBR1] - the first address including city, postcode, sate and country from the guests tab of the booking in International format [GUESTSBFULLADDRESSSBR1INC] - the first address including city, postcode, sate and country from the guests tab of the booking including cancelled bookings in European format [GUESTSBFULLADDRESSSBR1] - the first address including city, postcode, sate and country from the guests tab of the booking in European format [GUESTSNUMBOOKINGS1] - the total number of bookings made by the first guest, a group booking counts as one booking. [GUESTSNUMSTAYS1] - the total number of bookings not cancelled and not in the future made by the first guest, a group booking counts as one booking. [GUESTSCUSTOMQ1S] - answer to custom question 1 for all guests [GUESTSCUSTOMQ1SINC] - answer to custom question 1 for all guests including cancelled bookings [GUESTSCUSTOMQ2S] - answer to custom question 2 for all guests [GUESTSCUSTOMQ2SINC] - answer to custom question 2 for all guests including cancelled bookings [GUESTSCUSTOMQ3S] - answer to custom question 3 for all guests [GUESTSCUSTOMQ3SINC] - answer to custom question 3 for all guests including cancelled bookings [GUESTSCUSTOMQ4S] - answer to custom question 4 for all guests [GUESTSCUSTOMQ4SINC] - answer to custom question 4 for all guests including cancelled bookings [GUESTSCUSTOMQ5S] - answer to custom question 5 for all guests [GUESTSCUSTOMQ5SINC] - answer to custom question 5 for all guests including cancelled bookings [GUESTSCUSTOMQ6S] - answer to custom question 6 for all guests [GUESTSCUSTOMQ6SINC] - answer to custom question 6 for all guests including cancelled bookings [GUESTSCUSTOMQ7S] - answer to custom question 7 for all guests [GUESTSCUSTOMQ7SINC] - answer to custom question 7 for all guests including cancelled bookings [GUESTSCUSTOMQ7S] - answer to custom question 8 for all guests [GUESTSCUSTOMQ8SINC] - answer to custom question 8 for all guests including cancelled bookings
[NOTESBRGUESTSCUSTOMQ9S] - notes with line breaks <BR>answer to custom question 9 for all guests
[MESSAGEGUESTSCUSTOMQ9SINC] - the content of the booking message fieldanswer to custom question 9 for all guests including cancelled bookings
[MESSAGEBRGUESTSCUSTOMQ10S] - the content of the booking message field with line breaks <BR>answer to custom question 10 for all guests
[REFERENCEGUESTSCUSTOMQ10SINC] - content of the booking reference fieldanswer to custom question 10 for all guests including cancelled bookings
===Cancellation, Management and Guest Login===[STATUSCANCELLEDTIME] - status of date when the booking was cancelled
[FLAGCANCELLEDTIME:] - Flagdate when the booking was cancelled display can be any valid PHP strftime format string
[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
[DAYSTOCANCEL] - number of days until booking can be cancelled
[CANCELUNTIL] - shows the number of days between check-in and the last day which can be cancelled. If guest can always cancel it shows 0, if guest can never cancel it shows 9999
[GUESTLOGIN] - URL to view bookings
[TURNOVERDAYS] - days until next arrival into the same unit
[VACANTDAYS] days from previous checkout to check in of current booking
==Date and Time==
[CURRENTDATE] - current date
[CURRENTDATEYYYY-MM-DD] - current date in YYYY-MM-DD format
[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 in a custom format. [CURRENTTIME] - current timeand the display can be any valid PHP strftime format string. [CURRENTTIME:+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 in a custom format. [DAYSTOCHECKIN] - number of days until check-in [INADVANCE] - number of days between booking and check-in [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 in a custom format. [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 in a custom format. [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 in a custom format. [BOOKINGDATE:{%A, %e %B, %Y}] - booking date
[BOOKINGDATE:+1day{%A, %e %B, %Y}] - booking optional dateoffset and display format. The offset can be any plus or minus any number of days and the display can be in a custom format.
[BOOKINGTIMEDATEMODIFYDATE:{%A, %e %B, %Y}] - last booking modification date and /time, the display can be any valid PHP strftime format string.
[BOOKINGDATEYYYYPAYMENTDATE:{%A, %e %B, %Y}] - most recent payment date [PAYMENTDATE:+1day{%A, %e %B, %Y}:1:1000] -MMoptional date offset and display format. The offset can be any plus or minus any number of days and the display can be in a custom format. The second parameter specifies the payment to show, 0 or missing means the most recent payment. The third parameter specifies the invoicee. [AUTHORIZEUNTIL] -DDdate until which a card is authorized, this is extracted from the most recent authorize booking info code. [AUTHORIZEUNTIL{%A, %e %B, %Y}] - custom format date until which a card is authorized, this is extracted from the most recent authorize booking info code. [FORMATDATE:[any template variable that creates a date ]{%A, %e %B, %Y}] - custom format the date. The date value could be included by inserting a different template variable containing a date. The following codes can be used in YYYYany order between the {} brackets to create custom time and date formats. %a An abbreviated textual representation of the day Sun through Sat %A A full textual representation of the day Sunday through Saturday %d Two-MMdigit day of the month (with leading zeros) 01 to 31 %e Day of the month, with a space preceding single digits. 1 to 31 %j Day of the year, 3 digits with leading zeros 001 to 366 %u ISO-DD 8601 numeric representation of the day of the week 1 (for Monday) through 7 (for Sunday) %w Numeric representation of the day of the week 0 (for Sunday) through 6 (for Saturday) %U Week number of the given year, starting with the first Sunday as the first week 13 (for the 13th full week of the year) %V ISO-8601:1988 week number of the given year, starting with the first week of the year with at least 4 weekdays, with Monday being the start of the week 01 through 53 (where 53 accounts for an overlapping week) %W A numeric representation of the week of the year, starting with the first Monday as the first week 46 (for the 46th week of the year beginning with a Monday) %b Abbreviated month name, based on the locale Jan through Dec %B Full month name, based on the locale January through December %h Abbreviated month name, based on the locale (an alias of %b) Jan through Dec %m Two digit representation of the month 01 (for January) through 12 (for December) %C Two digit representation of the century (year divided by 100, truncated to an integer) 19 for the 20th Century %g Two digit representation of the year going by ISO-8601:1988 standards (see %V) Example: 09 for the week of January 6, 2009 %G The full four-digit version of %g Example: 2008 for the week of January 3, 2009 %y Two digit representation of the year Example: 09 for 2009, 79 for 1979 %Y Four digit representation for the year Example: 2038 %H Two digit representation of the hour in 24-hour format 00 through 23 %k Hour in 24-hour format, with a space preceding single digits 0 through 23 %I Two digit representation of the hour in 12-hour format 01 through 12 %l (lower-case 'L') Hour in 12-hour format, with a space preceding single digits 1 through 12 %M Two digit representation of the minute 00 through 59 %p UPPER-CASE 'AM' or 'PM' based on the given time Example: AM for 00:31, PM for 22:23 %P lower-case 'am' or 'pm' based on the given time Example: am for 00:31, pm for 22:23 %r Same as "%I:%M:%S %p" Example: 09:34:17 PM for 21:34:17 %R Same as "%H:%M" Example: 00:35 for 12:35 AM, 16:44 for 4:44 PM %S Two digit representation of the second 00 through 59 %T Same as "%H:%M:%S" Example: 21:34:17 for 09:34:17 PM %X Preferred time representation based on locale, without the date Example: 03:59:16 or 15:59:16 %z The time zone offset. Example: -0500 for US Eastern Time %Z The time zone abbreviation. Example: EST for Eastern Time %c Preferred date and time stamp based on locale Example: Tue Feb 5 00:45:10 2009 for February 5, 2009 at 12:45:10 AM %D Same as "%m/%d/%y" Example: 02/05/09 for February 5, 2009 %F Same as "%Y-%m-%d" (commonly used in database datestamps) Example: 2009-02-05 for February 5, 2009 %s Unix Epoch Time timestamp (same as the time() function) Example: 305815200 for September 10, 1979 08:40:00 AM %x Preferred date representation based on locale, without the time Example: 02/05/09 for February 5, 2009 %n A newline character ("\n") %t A Tab character ("\t") %% A literal percentage character ("%") == Booking Group variables ===== Custom Booking Group Table ===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] column parameters 100% = 100% width ADDR = Booking address ADUL= the number of adults ARIV = Arrival date BOPR = Bold prices BREF = Booking number CITY = Booking city CHAC = Charges with currency symbol CHAR = Charges CHIL = Number of children COUN = Booking country DEPT = Departure date EMAI = Booking Email EXSP = extra space between rows FLAG = Booking flag text FNAM = Booking first name GADD = Guest address GCIT = Guest city GCOM = Guest company GCOU = Guest country GFLA = Guest flag text GFNA = Guest first name GLNA = Guest last name GMOB = Guest mobile GNAM = Guest full name GEMA = Guest Email GNOT = Guest note GPOS = Guest postcode GREF = Guest Id GSTA = Guest state GTEL = Guest phone ICAN = Include cancelled bookings LNAM = Booking last name MOBI = Booking mobile NAME = Booking full name NOHE = no header NOTE = Booking note ONAM = Offer Name ONLY = Just show the one booking PAIC = Payment amount with currency symbol PAID = Paid amount PEOP = Number of guests PHON = Booking phone POST = Booking postcode PROP = Property name
[RANDOM2BOOKGROUP:PROP_ROOM_BREF_NAME] - a 2 digit random number seeded from will display the property name, room name, booking numberand guest name in this order.
[RANDOM4BOOKGROUP:BREF_NAME_PROP_ROOM] - a 4 digit random number seeded from will display the booking number, guest name property name and room name in this order.
=== Booking Group Table with fixed content===[RANDOM5BOOKGROUPROOMLIST] - create a 5 digit random number seeded from the table of guest names including room type for a group booking number
[RANDOM6BOOKGROUPROOMLISTTOTAL] - create a 6 digit random number seeded from the table of guest names including room type for a group booking numberwith guest totals
[RANDOM7BOOKGROUPROOMLISTCHARGETOTAL] - create a 7 digit random number seeded from the table of guest names including room type and charge for a group booking numberwith guest totals
[RANDOM8BOOKGROUPNAMELIST] - create a 8 digit random number seeded from the table of guest names including room type and unit for a group booking number
[BOOKINGINFOITEMSBOOKGROUPNAMELISTTOTAL] - Booking Info Codes - Codes create a table of guest names including room type and textunit for a group booking with guest totals
[BOOKINGINFOTEXTSBOOKGROUPNAMELISTCHARGETOTAL] - Booking Info Codes - Text onlycreate a table of guest names including room type and unit and charge for a group booking with guest totals
[BOOKINGINFOCODESBOOKGROUPUNITLIST] - Booking Info Codes - Codes onlycreate a table of guest names including unit for a group booking
[BOOKINGINFOCODE:THIS_INFO_CODEBOOKGROUPUNITLISTTOTAL] - the most recent Text value create a table of the specified Booking Info Code guest names including unit for a group booking with guest totals
[CARDLASTFOURBOOKGROUPUNITLISTCHARGETOTAL] - last 4 digits create a table of cardguest names including unit and charge for a group booking with guest totals
== Invoice Variables ==
[INVOICENUMBER] - invoice number
[INVOICENUMBERINVOICENUMBERS] - invoice numberif invoicees are involved
[INVOICEDATE] - invoice date
[INVOICEDATES] - invoice date invoice number if invoicees are involved
[INVOICEDATE:+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.
[INVOICEDATES:+1day{%A, %e %B, %Y}] - optional date offset and display format - invoice date invoice number if invoicees are involved, The offset can be any plus or minus any number of days and the display can be any valid PHP strftime format string.
=== Invoice Values ===
These template variables will display a value form the invoice.
==== Custom Invoice Values====
You have the option to create a custom invoice variable to display a value from an invoice. [INVOICEVAL with a selection of the following variables specifies the calculation:
CHA - charges
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
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
DP2 - 2 decimal places
DP3 - 3 decimal places
DP4 - 4 decimal places
DES - used as "DESsome description" - gives the sum of values containing the description "some description"
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
IT1 - item 1 in the invoice
IT2 - item 2 in the invoice
IT3 - item 3 in the invoice
IT4 - item 4 in the invoice
IT5 - item 5 in the invoice
MUL - multiplier. Example: MUL1.2 will multiply all prices by 1.2
NUM - show with decimal place (for scripts)
THO - thousands separator. THO. will show a dot as thousand separator. If nothing is set the system will use the default for the language
UPS1 - upsell 1
UPS2 - upsell 2
UPS3 - upsell 3
UPS4 - upsell 4
UPS5 - upsell 5
ONE - shows only items from the specified booking (not the booking group)
PAY - shows payments
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.
VAT - VAT summary
Connect the variables with an underscore.
Examples:
[INVOICEVAL:PAY_THO] will show payments with a thousands separator
[INVOICEVAL:UPS1_UPS2] will show the sum of upsell 1 and upsell 2
==== Standard Invoice Values====
[INVOICEBALANCE] - invoice balance
[INVOICEBALANCE:-100] - invoice balance with offset amount
[INVOICEBALANCENUM] - As per [INVOICEBALANCE] but the value is displayed with a decimal point and no thousands separator(for calculation). [INVOICEBALANCENUM:] - As per [INVOICEBALANCE:] but the value is displayed with a decimal point and no thousands separator (for calculation). [INVOICEPARTBALANCE:status1,status2,!status4:10%] - Calculate the balance of all invoice items with matching status and apply optional multiplier or offset. The status items can be a comma separated list. To exclude status items prefix them with an exclamation mark, for example !status1. The offset is optional and can be specified after a second colon (:) and it can be a percentage by ending the number with the percent (%) symbol or a numeric value offset.
[INVOICEBALANCENUMINVOICEPARTBALANCENUM:status1,status2,status4:10%] - As per [INVOICEBALANCE:] INVOICEPARTBALANCE but the value is displayed with a decimal point and no thousands separator(for calculation).
[INVOICEPARTBALANCE:status1,status2,status4:10%INVOICEBALANCE1] - Calculate the invoice balance of all invoice items with matching status and apply optional multiplier or offset. The status items can be a comma separated list. To exclude status items prefix them with an exclamation markone booking only, for example !status1. The offset optional and can be specified after a second colon (:) and it can be a percentage by ending the number with not the percent (%) symbol or a numeric value offset.booking group
[INVOICEPARTBALANCENUM:status1,status2,status4:10%INVOICEBALANCE1NUM] - As per INVOICEPARTBALANCE [INVOICEBALANCE1] but the value is displayed with a decimal point and no thousands separator.(for calculation)
[INVOICECHARGES] - invoice sum of all charges
[INVOICECHARGES:-100] - invoice sum of all charges with offset
[INVOICECHARGESNUM] - As per [INVOICECHARGES] but the value is displayed with a decimal point and no thousands separator.(for calculation) [INVOICECHARGESNUM:] - As per [INVOICECHARGES:] but the value is displayed with a decimal point and no thousands separator (for calculation)
[INVOICECHARGESNUMINVOICEPARTCHARGES:status1,status2,!status4:10%] - As per Calculate the balance of all invoice charges with matching status and apply optional multiplier or offset. The status items can be a comma separated list. To exclude status items prefix them with an exclamation mark, for example !status1. The offset optional and can be specified after a second colon (:) and it can be a percentage by ending the number with the percent (%) symbol or a numeric value offset. [INVOICECHARGESINVOICEPARTCHARGESNUM:status1,status2,status4:10%] - As per INVOICEPARTCHARGES but the value is displayed with a decimal point and no thousands separator(for calculation).
[INVOICEPAYMENTS] - invoice sum of all payments
[INVOICEPAYMENTS:-100] - invoice sum of all payments with offset
[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.
[INVOICEPARTPAYMENTS:status1,status2,!status4:10%] - Calculate the balance of all invoice payments with matching status and apply optional multiplier or offset. The status items can be a comma separated list. To exclude status items prefix them with an exclamation mark, for example !status1. The offset optional and can be specified after a second colon (:) and it can be a percentage by ending the number with the percent (%) symbol or a numeric value offset.
[INVOICEPARTPAYMENTSNUM:status1,status2,status4:10%] - As per INVOICEPARTCHARGES but the value is displayed with a decimal point and no thousands separator (for calculation).
[INVOICEPENDPAY] - all (auto and manual) pending payments including failed
[INVOICEPENDPAYNEXTDATE] - date of the next pending payment
[INVOICEPENDPAYNEXTDATE:] - date of the next pending payment display can be any valid PHP strftime format string. Information about PHP strftime Strings can be find found here: http://php.net/manual/de/function.strftime.php
[INVOICEPENDPAYNUM] - all (auto and manual) pending payments including failed but the value is displayed with a decimal point and no thousands separator (for calculation).
[INVOICEPENDPAY1234] - all (auto and manual) pending payments including failed for the specified invoicee (-1 will include all items regardless of invoicee)
[INVOICEPENDPAYNUM1234] - all (auto and manual) pending payments including failed for the specified invoicee (-1 will include all items regardless of invoicee) The value is displayed with a decimal point and no thousands separator (for calculation).
[INVOICEPENDPAYAUTO] - auto pending payments before due date
[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) (-1 will include all items regardless of invoicee)
[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) (-1 will include all items regardless of invoicee)
[INVOICEPENDPAYFAIL] - failed pending payments (all also past)
[INVOICEPENDPAYFAILNUM] - failed pending payments (all also past) but the value is displayed with a decimal point and no thousands separator (for calculation)
[INVOICEPENDPAYFAIL234] - failed pending payments (all also past) for the specified invoicee (-1 will include all items regardless of invoicee)
[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) (-1 will include all items regardless of invoicee)
[INVOICEPENDPAYRULE1] - shows all pending payment for this rule (exchange 1 for the rule number)
[INVOICEPENDPAYRULENUM1] - shows all pending payment for this rule (exchange 1 for the rule number) displayed with a decimal point and no thousands separator (for calculation)
[INVOICEPENDPAYMANUAL] - manual pending payments
[INVOICEPENDPAYMANUALNUM] - manual pending payments but the value is displayed with a decimal point and no thousands separator (for calculation).
[INVOICEPENDPAYMANUALNOTDUE] manual pending payments before due date
[INVOICEPENDPAYMANUALNOTDUENUM] manual pending payments before due date but the value is displayed with a decimal point and no thousands separator (for calculation).
[INVOICEPENDPAYMANUALOVERDUE] manual pending payments after due date
[INVOICEPENDPAYMANUALOVERDUENUM] manual pending payments after due date but the value is displayed with a decimal point and no thousands separator (for calculation)
[INVOICECREDITS] - invoice sum of all credit items (negative items)
[INVOICECREDITS:-100] - invoice sum of all credit items with offset
[INVOICECREDITSNUM] - As per [INVOICECREDITS] 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] - invoice sum of all debit items (positive items)
[INVOICEDEBITS:-100] - invoice sum of all debit items with offset
[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
[INVOICEUPSELL1INVOICEVATNUM] - 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 upsell the item 1 listed third in the invoice but the value is displayed with a decimal point and no thousands separator (for calculations) [INVOICEFOURTHITEM] - price of the item listed fourth in the invoice [INVOICEFOURTHITEMNUM] - price of the item listed fourth in the invoice but the value is displayed with a decimal point and no thousands separator (number can be between 1 to 20for calculations)
[INVOICEFIFTHITEM] - price of the item listed fifth in the invoice [INVOICEFIFTHITEMNUM] - price of the item listed fifth 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)
[INVOICEUPSELLNAME1] - name of the headline field of upsell item 1 (number can be between 1 to 20) [INVOICEUPSELLSTATUS1] - stautus of the headline field of upsell item 1 (number can be between 1 to 20) [INVOICEUPSELLHEADLINE1] - headline (name and status if used of upsell item 1 (number can be between 1 to 20) [INVOICEUPSELLDESCRIPTION1] - description of upsell item 1 (number can be between 1 to 20) [INVOICEUPSELLAMOUNTNUM1] - amout of upsell item 1 [INVOICEUPSELLTYPE1] - type of upsell item 1 [INVOICEUPSELLPER1] - per of upsell item 1 [INVOICEUPSELLPERIOD1] - period of upsell item 1 [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)
[INVOICEEXTRAITEMQTY1INVOICENET:1] - quantity net amount of extra invoice item 1 the inserted VAT rate (number can be between 1 to 20is the VAT rate)
[UPSELLTABLEINVOICENETNUM:1] - table net amount of the inserted VAT rate (number is the VAT rate), value is displayed with all upsell 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 itemswith this search term and adds them up
[UPSELLTABLEVATINVOICEPAYMENTBYDESCNUM:Searchterm] - table searches the payments for items with all upsell items this search term and adds them up, value is displayed with vat information a decimal point and vat summary no thousands separator (for calculations)
=== Invoice Table ===
These template varibles will display an invoice table.
==== Standard Invoice Tables ====
[INVOICETABLE] - invoice table
[INVOICETABLEVAT] - invoice table with vat information and vat summary
[INVOICETABLE:$1.1$] - invoice table and currency multiplier with optional new currency symbol before or after price.
[INVOICETABLEPART:status1,status2,!status4] - Invoice table showing only items with matching status. The status items can be a comma separated list. To exclude status items prefix them with an exclamation mark, for example !status1.
[INVOICETABLE2] - invoice table with status field
[INVOICETABLECHARGES] - invoice table showing charges only
[INVOICETABLECHARGESINVOICEE1234] - invoice table showing charges only assigned to the specified invoicee, specify the invoicee Id number.
[INVOICETABLENOTOT] - invoice table without grand total
[INVOICETABLENOTOT2:$1.1$] - invoice table with status field without grand total and currency multiplier with optional new currency symbol before or after price.
[INVOICETABLEVAT:$1.1$] - invoice table with vat information and currency multiplier with optional new currency symbol before or after price. [INVOICETABLEVATCOMPACT] - compact version of invoice table with vat information and vat summary [INVOICETABLEVATCOMPACT:$1.1$] - compact version of invoice table with vat information and vat summary and currency multiplier with optional new currency symbol before or after price. [INVOICETABLEVATCOMPACTNOSUM] - compact version of invoice table with vat information without vat summary
[INVOICETABLEVATINVOICETABLEVATCOMPACTNOSUM:$1.1$] - compact version of invoice table with vat information without vat summary and currency multiplier with optional new currency symbol before or after price.
[INVOICETABLEVATNOSUM] - invoice table with vat information without vat summary
[INVOICETABLEVAT2NOSUM:$1.1$] - invoice table with vat information and status field without vat summary and currency multiplier with optional new currency symbol before or after price.
[INVOICEACCOUNTNAMEINVOICETABLEVATCHARGES] - name of the invoice account the invoice is assigned to or blanktable showing charges only with vat information and vat summary
[INVOICEACCOUNTCODEINVOICETABLENOPRICE] - code of the invoice account the invoice is assigned to or blanktable with no price information
[INVOICEACCOUNTTEMPLATE1INVOICETABLEINVOICEE] - template value 1 of the invoice account the invoice is table excluding items assigned to or blankan invoicee.
[INVOICEACCOUNTTEMPLATE2INVOICETABLEINVOICEE1234] - template value 2 of the invoice account table for a specific invoicee, specify the invoice is assigned to or blankinvoicee Id number.
[INVOICEACCOUNTTEMPLATE3UPSELLTABLE] - template value 3 of the invoice account the invoice is assigned to or blanktable with all upsell items
[INVOICEACCOUNTTEMPLATE4UPSELLTABLEVAT] - template value 4 of the invoice account the invoice is assigned to or blanktable with all upsell items with vat information and vat summary
[UPSELLTABLENOREFUND] - table with all upsell items except refundable items
==== Custom Invoice Table ====
You have the option to create a custom invoice table. Available content variables are:
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 - you have the option to control the format of the date using [[Template_Variables#Date_and_Time|date and time variables]] for example DAT{%d-%m-%Y}
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
DP2 - 2 decimal places
DP3 - 3 decimal places
DP4 - 4 decimal places
GAT - sum for each column
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)
ORB - order by booking, this keeps the items for each booking (room) together in the table
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.
Examples:
[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.
[INVOICE:PRI_QTY_CUA_TOT_VAT_QTY_PAY_GRT_AMO_VAA] will create an invoice table with more information.
[INVOICE:SIN TRANSPORT] will create an invoice table with the Invoice item description for any items with the Status = Transport.
== Invoicee Variables ==
[INVOICEEBALANCE] - invoice balance for unassigned invoice items.
[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
[INVOICEENOTES] - value of the "Notes" field for the invoicee
[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
[INVOICEETEMPLATE1BR] - template value 1 of the invoice account the invoice is assigned to or blank with linkebreak
[INVOICEETEMPLATE2BR] - template value 2 of the invoice account the invoice is assigned to or blank with linkebreak
[INVOICEETEMPLATE3BR] - template value 3 of the invoice account the invoice is assigned to or blank with linkebreak
[INVOICEETEMPLATE4BR] - template value 4 of the invoice account the invoice is assigned to or blank with linkebreak
[INVOICEETEMPLATE5BR] - template value 5 of the invoice account the invoice is assigned to or blank with linkebreak
[INVOICEETEMPLATE6BR] - template value 6 of the invoice account the invoice is assigned to or blank with linkebreak
[INVOICEETEMPLATE7BR] - template value 7 of the invoice account the invoice is assigned to or blank with linkebreak
[INVOICEETEMPLATE8BR] - template value 8 of the invoice account the invoice is assigned to or blank with linkebreak
== Payment Request Variables ==
[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.
[+PAYBUTTON:25%] - will add Creates a payment button for the two numbers either side payment request for a percentage of the template variableoutstanding balance. Use 100% to specify the full outstanding balance. Not recommended for emails.
[-PAYBUTTON:200] - will subtract the number right of the template variable from Creates a payment button for the number leftpayment request for a fixed amount.
[*PAYPALURL] - will multiply Creates a Paypal payment url for the two numbers either side of amount in the template variablebooking deposit field if non zero, otherwise the outstanding balance.
[/PAYPALURL:25%] - will divide the number left Creates a Paypal payment url for a percentage of the template variable by outstanding balance. Use 100% to specify the number rightfull outstanding balance.
[MINPAYPALURL:200] - Creates a Paypal payment url for a fixed amount. A zero amount will show the lowest of the numbers left and right of the template variablecause paypal to provide a field to enter an amount.
[MAXPAYPALLINK] - 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 show cause paypal to provide a field to enter an amount. [PAYPALBUTTON] - Creates a Paypal payment button for the highest of amount in the numbers left and right of booking deposit field if non zero, otherwise the template variableoutstanding balance. Not recommended for emails.
[PAYPALBUTTON:25%] - Creates a Paypal payment button for a percentage of the outstanding balance. Use 100% to specify the full outstanding balance. Not recommended for emails.
[*.0PAYPALBUTTON:200] - Creates a Paypal payment button for a fixed amount. A zero amount will multiply the two numbers either side of the template variable and round cause paypal to the nearest integerprovide a field to enter an amount. Not recommended for emails.
Add a H to exclude a gateway from displaying. Example: [*.1PAYURL:200:HST] - will multiply the two numbers either side of the template variable and round to 1 decimal placehide Stripe
[*.3REPLACE|searchForThisText|replaceWithThisText|textToSearch] - will multiply replace "searchForThisText" with "replaceWithThisText" within the two numbers either side of the template variable and round to 3 decimal placestext "textToSearch"
[SUBSTR|startCharacterNumber|numberOfCharacters|textToGetSubstringFrom] - get a sub string from "textToGetSubstringFrom" starting at character "startCharacterNumber" (integer, 0 is the first char) with a length of "numberOfCharacters" (integer)
1. [SUBSTR|0|4|[/.1GUESTPHONENUM]] - will divide the number left of the template variable by the number right and round to 1 decimal place
[/.4TRIM| string to trim ] - will divide remove whitespace from the number left start and end of the template variable by the number right and round " string to 4 decimal placestrim "
== iCal Links ==
These template variables will create iCal links which allow the booking to be added to a calendar.
[+.0ICALURL] - will add the two numbers either side of the template variable and round to the nearest integerCalendar link
[+.1ICALURL:16] - will add Calendar link with check-in hour. Replace '16' with the two numbers either side of the template variable and round to 1 decimal placehour check-in starts.
[+.2ICALURL::10] - will add Calendar link with check-out hour. Replace '10' with the two numbers either side of hour with the template variable and round to 2 decimal placeshour check-out ends.
[+.3ICALURL:::summary text] - will add the two numbers either side of the template variable and round to 3 decimal placesCalendar link with a summary text
[+.4ICALURL::::description text] - will add the two numbers either side of the template variable and round to 4 decimal placesCalendar link with a descriptive text
Example:
[-.1ICALURL:16:10:Booking:Sunny Hotel] - will subtract the number right of the template variable from the number left and round to 1 decimal place
[+] -.4Example: 2 [+] - will subtract the number right of the template variable from the number left and round to 4 decimal places3 = 5
[-] - Example: 5 [-] 1 = 4
[MIN.0*] - will show the lowest of the numbers left and right of the template variable and round to the nearest integerExample: 3 [*] 4 = 12
[MIN.1/] - will show the lowest of the numbers left and right of the template variable and round to 1 decimal placeExample: 15 [/] 5 = 3
[MIN.] - Example: 2[MIN] - will show the lowest of the numbers left and right of the template variable and round to 3 = 2 decimal places
[MIN.3MAX] - will show the lowest of the numbers left and right of the template variable and round to Example: 2 [MAX] 3 = 3 decimal places
If you want to use * and - in the same calculation, for example you need 20% of the result, then you will need to use the calculation below as a * calculation will be calculated first.
[MAXINVOICECHARGESNUM][*]0.2[-][INVOICESECONDITEMNUM][*]0.2[-][COMMISSIONNUM] - will show the highest of the numbers left and right of the template variable and round to the nearest integer[*]0.2
If you want to see the value 10. Set Room template 6 = [ROOMTEMPLATE7][+][MAX.2ROOMTEMPLATE8] - will show the highest of the numbers left and right of the enter 4 in Room template variable 7 and round to 2 decimal places6 in Room template 8.
=== Rounding and controlling decimal places ===
==== Default ====
== Currency Conversion == Rounding to the nearest integer ====
2 [CONVERT:EUR-USD/.0] - 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.3 = 1
<b>This works on all operators including [FIRSTNIGHT:{%A, %e %B, %Y}MIN] - first night bookedand [MAX]</b>
[LASTNIGHTCONVERT:+1day{%A, %e %B, %Y}EUR-USD] - optional date offset and display format. The offset get the actual conversion rate between two currencies, this can be any plus or minus any number of days and used with math functions to show alternative currency values. All currencies supported by the display booking page currency selector can be any valid PHP strftime format stringused.
Example: [INVOICECHARGESNUM] [LEAVINGDAY:{%A, %e %B, %Y}*.2] - check[CONVERT:EUR-out USD] will convert the invoice charge value from Euros to USD with two decimal points.
123456*[CURRENTDATECONVERT:{%A, %e %B, %Y}USD-EUR] - current date*
123456*[BOOKINGDATECONVERT:{%A, %e %B, %Y}EUR-USD] - booking date
123456*[BOOKINGDATECONVERT:+1day{%A, %e %B, %Y}USD-EUR][/] - optional date offset and display format0. The offset can be any plus or minus any number of days 85 will convert to Euros and divides the display can be any valid PHP strftime format stringprice by 0.85 which raises it by circa 15%
==Account Variables (account of the booking) ==
[ACCOUNTUSERNAME] - Username of the account owning the booking
[LOGGEDINACCOUNTUSERNAME] - Username of the person logged in
[ACCOUNTID] - account id of the booked property
[ACCOUNTTEMPLATE4] - Account Template 4
[COMMISSIONLIMIT] - shows the available commission amount for the owner account of the booking
[MASTERACCOUNTTEMPLATE1] - Account Template 1 from master account
[MASTERACCOUNTTEMPLATE4] - Account Template 4 from master account
==Account Variables (logged in account, only for display in control panel, not for auto actions or emails etc.) ==These variables can for example used by resellers who added a custom tab to the bookings.
[LOGGEDINACCOUNTID] - account id of the logged in user
[MASTERLOGGEDINACCOUNTTEMPLATE4] - Account Template 4 from master account
== Smart Logic Template Variables ==
IF style template variables will compare two values and display a text if the comparison is true and an alternative text if the comparison is false.
Colons : are used between the two comparison values and the first text, a pipe | is used between the two texts.
Empty text is allowed if you do not want to display anything for a condition.
[IF=:if this:equals this:display this text|otherwise display this text]
[IFIN:if this:is contained in this:display this text|otherwise display this text]
[IFLIKE:if this:is like this:display this text|otherwise display this text]
[IF>:if this:is greater than this:display this text|otherwise display this text]
[IF>=:if this:is greater than or equal to this:display this text|otherwise display this text]
[IF<:if this:is less than this:display this text|otherwise display this text]
[IF<=:if this:is less than or equal to this:display this text|otherwise display this text]
[IFBETWEEN:if this:is between this:and this:display this text|if it is lower display this text|if it is higher display this text]
You can use IF variables inside other IF variables to create complex logic but the internal IF: must be processed before the external IF
There are special versions of each IF constructed with ^ and ~ separators like [IF=^this^this^same~different]
<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span>Only one IF of each type can be used to create complex logic.
The special versions are processed first so should be used as the internal IF so it's result can be processed by the outer if.
The special versions can also be used if you expect : or | characters within your data.
IF's are processed in the following order.
i.e. all the [IF=^ will be processed first, then all the [IFIN^ etc.
[IF=^
[IFIN^
[IFLIKE^
[IF>^
[IF>=^
[IF<^
[IF<=^
[IFBETWEEN^
[IF=:
[IFIN:
[IFLIKE:
[IF>:
[IF>=:
[IF<:
[IF<=:
[IFBETWEEN:
=== Examples ===
Template variables can be used inside this template variable as per the examples <span style="color: #019cde">comparison in blue</span>, <span style="color: #75d5ad">positive result in green</span>, <span style="color: #fe746c">negative result in red</span>:
1. [<span style="color: #019cde">IF=:[GUESTNAME]</span><span style="color: #75d5ad">:Miller</span><span style="color: #75d5ad"><span style="color: #75d5ad">:yes</span> <span style="color: #fe746c">|no</span>]
If the guestname is Miller the text "yes" will display. If the guest name is not Miller the text "no" will display
2.[<span style="color: #019cde"> IF>:[NUMADULT]:2</span><span style="color: #75d5ad">:please contact us about you bedding requirements|</span>]
If the number of adults is higher than 2 the text"please contact us about you bedding requirements" will display. If the number of adults is lower than or equal 2 nothing will display.
3. [<span style="color: #019cde">IF<:[NUMADULT]:3</span><span style="color: #75d5ad">:|linen for two adults is included free of charge</span>]
If the number of adults is lower than 3 nothing will display. If the number of adults is not lower than 3 the text "linen for two adults is included free of charge" will display.
4. [<span style="color: #019cde">IF<=:[NUMADULT]:2</span><span style="color: #75d5ad">:yes</span><span style="color: #fe746c">|no</span>]
5. [<span style="color: #019cde">IF>=:[NUMADULT]:2</span><span style="color: #75d5ad">:yes</span><span style="color: #fe746c">|no</span>]
6. [<span style="color: #019cde">IFBETWEEN:[NUMADULT]:1:3</span><span style="color: #75d5ad">:yes</span><span style="color: #fe746c">|too low|too high</span>]
7. [<span style="color: #019cde">IFLIKE:[GUESTTITLE]</span><span style="color: #75d5ad">:Mr:Dear</span><span style="color: #fe746c">|Hi</span>]
IFLIKE works like IF= except it is case insensitive and removes any spaces from the start and end of the words
8. [<span style="color: #019cde">IFIN:John:[GUESTFIRSTNAME]</span><span style="color: #75d5ad">:Hi John</span><span style="color: #fe746c">|Your name does not contain John?</span>]
If the first word is contained in the second word the first option is displayed, otherwise the second option is displayed
9. [<span style="color: #019cde">IFIN:CHECKIN:[BOOKINGINFOITEMS]</span><span style="color: #75d5ad">:[BOOKINGINFOCODETEXT:CHECKIN]</span><span style="color: #fe746c">|</span>]
If the Booking Info Code CHECKIN has been added to the booking then you will see the value in the text (date/time) otherwise blank.
Using multiple IF statements to display special messages :-
10. [<span style="color: #019cde">IFIN:DEPOSIT:[BOOKINGINFOCODES]:|[IF=:[GUESTCOUNTRY2]:AU</span><span style="color: #75d5ad">:Credit card details are required </span><span style="color: #fe746c">|A deposit is required]|No deposit is required</span>]
You want to display a special message to Australians if the booking has a DEPOSIT info item code, if a deposit is required from a non Australia they get "A deposit is required" and if no deposit is required they see "No deposit is required"
11. [<span style="color: #019cde">IF<:[INADVANCE]:|[IFIN:TRANSFER:[BOOKINGINFOCODES]:3</span><span style="color: #75d5ad">:Payment Due Date: ASAP </span><span style="color: #fe746c">|Payment Due Date: [FIRSTNIGHT:- 30days]]|</span>]
You want display a special message to your guests 3 days before checkin with a Booking Info Code = TRANSFER.
12. [<span style="color: #019cde">IF=:[STATUS]:Confirmed:PAID|[IF<^[INADVANCE]^30</span><span style="color: #75d5ad">^Payment Due Date: As soon as possible</span><span style="color: #fe746c">~Payment Due Date: [FIRSTNIGHT:- 30 days]]</span>]
You want to display a special message for your guests for any bookings with Status not = Confirmed, and if the checkin date is more than 30 days in advance, then send the message with "Payment Due Date : "or that the "Payment is due As soon as possible".
13. [<span style="color: #019cde">IFBETWEEN:[TURNOVERDAYS]:0:3:</span><span style="color: #75d5ad">yes|</span><span style="color: #fe746c">no</span>]
You want to test if the days until next arrival into the same unit is between 0 and 3 days. Could be used for offering Late Checkouts or additional days to the guest where there is a gap between bookings.
14. [<span style="color: #019cde">IF>:[VACANTDAYS]:1:</span><span style="color: #75d5ad">yes|</span><span style="color: #fe746c">no</span>]
You want to test if there is 1 day from the previous checkout to check in of current booking. Could be used for offering Early Checkouts or additional days to the guest where there is a gap between bookings.
15. [<span style="color: #019cde">IF=:[LEAVINGDAY:{%a}]:Sun:|[IF>=^[TURNOVERDAYS]^1</span><span style="color: #75d5ad">^yes</span><span style="color: #fe746c">~no]</span>]
You want to test if the leaving date is a Sunday and it there is a gap for 1 or more days between the current booking and the next booking.
16. [<span style="color: #019cde">[IF=:[LEAVINGDAY:{%u}]:1:yes|[IF=^[LEAVINGDAY:{%u}]^3</span><span style="color: #75d5ad">^yes</span><span style="color: #fe746c">]</span>]
You want to test if the leaving date is a Monday or a Wednesday to send a specific message to the guest, for example a reminder that it is bin collection day.
17. [<span style="color: #019cde">[IF=:[LEAVINGDAY:{%u}]:1:yes|[IF=^[LEAVINGDAY:{%u}]^3^yes][IF=^[LEAVINGDAY:{%u}]^6</span><span style="color: #75d5ad">^yes</span><span style="color: #fe746c">]</span>]
You have different cleaning teams for different days of the week, and you want to send a message to the appropriate team if leaving date is a Monday, Wednesday or Saturday.
== Write out the number in Words. ==
[INWORDS] - writes out a number in words. This works in English only.
Expamles:
[INWORDS] 10 will write "ten"
[INWORDS] [INVOICEPAYMENTSNUM] will write out the invoice sum of all payments
[INWORDS] [INVOICEPAYMENTSNUM] [+] 10 will write out the invoice sum of all payments plus 10
== Encoding Template Variables ==
[ENCODEURL:value] encode value for URL data format
[ENCODEJSON:value] encode value for JSON data format
Note: Always use the template variables ending with NUM if numbers are involved. The math functions will only work with numbers with a decimal point (not a decimal comma) and no thousands separator and no currency symbol.
