Template Variables: Difference between revisions

From Beds24 Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 12: Line 12:
==Template Variables==
==Template Variables==


'''[PROPERTYNAME]''' - property name  
[PROPERTYNAME] - property name  


'''[PROPERTYADDRESS]''' - property address  
[PROPERTYADDRESS] - property address  


'''[PROPERTYCITY]''' - property city  
[PROPERTYCITY] - property city  


'''[PROPERTYEMAIL]''' - property email  
[PROPERTYEMAIL] - property email  


'''[PROPERTYPHONE]''' - property phone  
[PROPERTYPHONE] - property phone  


'''[PROPERTYID]''' - property id number
[PROPERTYID] - property id number


'''[ROOMNAME]''' - room names of all booked rooms
[ROOMNAME] - room names of all booked rooms


'''[ROOMNAME1]''' - room name of first booked room
[ROOMNAME1] - room name of first booked room


'''[ROOMNAMES]''' - room names including quantity of each booked room  
[ROOMNAMES] - room names including quantity of each booked room  


'''[ROOMNAMEOFFER]''' - room names of all booked rooms with offer name
[ROOMNAMEOFFER] - room names of all booked rooms with offer name


'''[OFFERNAME]''' - booked offer name for all booked rooms
[OFFERNAME] - booked offer name for all booked rooms


'''[UNITNAME]''' - unit name of the assigned room type
[UNITNAME] - unit name of the assigned room type


'''[BOOKID]''' - booking reference  
[BOOKID] - booking reference  


'''[REFERENCENUMBER]''' - booking reference  
[REFERENCENUMBER] - booking reference  


'''[FIRSTNIGHT]''' - first night booked
[FIRSTNIGHT] - first night booked


'''[FIRSTNIGHTSHORT]''' - first night booked in 1 Apr 2016 format  
[FIRSTNIGHTSHORT] - first night booked in 1 Apr 2016 format  


'''[FIRSTNIGHTYYYY-MM-DD]''' - first night booked in YYYY-MM-DD format
[FIRSTNIGHTYYYY-MM-DD] - first night booked in YYYY-MM-DD format


'''[FIRSTNIGHT:+1day]''' - offset from first night, can be any number of days positive or negative
[FIRSTNIGHT:+1day] - offset from first night, can be any number of days positive or negative


'''[LASTNIGHT]''' - last night booked  
[LASTNIGHT]''' - last night booked  


'''[LASTNIGHTSHORT]''' - last night booked in 1 Apr 2016 format  
[LASTNIGHTSHORT] - last night booked in 1 Apr 2016 format  


'''[LASTNIGHTYYYY-MM-DD]''' - last night booked in YYYY-MM-DD format
[LASTNIGHTYYYY-MM-DD] - last night booked in YYYY-MM-DD format


'''[LASTNIGHT:+1day]''' - offset from last night, can be any number of days positive or negative
[LASTNIGHT:+1day] - offset from last night, can be any number of days positive or negative


'''[LEAVINGDAY]''' - check-out day
[LEAVINGDAY] - check-out day


'''[LEAVINGDAYSHORT]''' - check-out day in 1 Apr 2016 format
[LEAVINGDAYSHORT] - check-out day in 1 Apr 2016 format


'''[LEAVINGDAYYYYY-MM-DD]''' - check-out day in YYYY-MM-DD format
[LEAVINGDAYYYYY-MM-DD] - check-out day in YYYY-MM-DD format


'''[LEAVINGDAY:+1day]''' - offset from check-out, can be any number of days positive or negative
[LEAVINGDAY:+1day] - offset from check-out, can be any number of days positive or negative


'''[NUMROOM]''' - the quantity of rooms booked (first room type only)  
[NUMROOM] - the quantity of rooms booked (first room type only)  


'''[NUMROOMS]''' - the quantity of rooms booked (sum of all rooms and room types)  
[NUMROOMS] - the quantity of rooms booked (sum of all rooms and room types)  


'''[NUMNIGHT]''' - number of nights  
[NUMNIGHT] - number of nights  


'''[NUMADULT]''' - number of adults  
[NUMADULT] - number of adults  


'''[NUMCHILD]''' - number of children  
[NUMCHILD] - number of children  


'''[NUMPEOPLE]''' - number of guests  
[NUMPEOPLE] - number of guests  


'''[RATEDESC]''' - name of the rate  
[RATEDESC] - name of the rate  


'''[PRICE]''' - Value in price field (number entered in the price field of the booking)
[PRICE] - Value in price field (number entered in the price field of the booking)


'''[PRICE:10%]''' - Percentage value of Price  
[PRICE:10%] - Percentage value of Price  


'''[PRICE:-10]''' - Price with offset amount
[PRICE:-10] - Price with offset amount


'''[AVPRICE]''' - Average Nightly Price  
[AVPRICE] - Average Nightly Price  


'''[AVPRICE:20%]''' - Percentage value of Average Nightly Price  
[AVPRICE:20%] - Percentage value of Average Nightly Price  


'''[AVPRICE:15]''' - Average Nightly Price with offset amount
[AVPRICE:15] - Average Nightly Price with offset amount


'''[DEPOSIT]''' - Value in deposit field  
[DEPOSIT] - Value in deposit field  


'''[TAX]''' - Value in tax field
[TAX] - Value in tax field


'''[COMMISSION]''' - Value in commission field
[COMMISSION] - Value in commission field


'''[GUESTTITLE]''' - guest title
[GUESTTITLE] - guest title


'''[GUESTFIRSTNAME]''' - first name  
[GUESTFIRSTNAME]''' - first name  


'''[GUESTNAME]''' - last name
[GUESTNAME] - last name


'''[GUESTFULLNAME]''' -  title, first name, last name
[GUESTFULLNAME] -  title, first name, last name


'''[GUESTEMAIL]''' - guest's Email address
[GUESTEMAIL] - guest's Email address


'''[GUESTPHONE]''' - guests phone number  
[GUESTPHONE]  - guests phone number  


'''[GUESTADDRESS]''' - guests address  
[GUESTADDRESS]  - guests address  


'''[GUESTPOSTCODE]''' -  guests postcode
[GUESTPOSTCODE] -  guests postcode


'''[GUESTCITY]''' - guests city
[GUESTCITY] - guests city


'''[GUESTCOUNTRY]''' - guests country  
[GUESTCOUNTRY] - guests country  


'''[GUESTMOBILE]''' - guests mobile number  
[GUESTMOBILE] - guests mobile number  


'''[GUESTFAX]''' - guests fax number
[GUESTFAX] - guests fax number


'''[GUESTARRIVALTIME]''' - arrival time  
[GUESTARRIVALTIME] - arrival time  


'''[GUESTCOMMENTS]''' - comments in the booking  
[GUESTCOMMENTS] - comments in the booking  


'''[GUESTCUSTOMQ1]''' - answer to custom question 1  
[GUESTCUSTOMQ1] - answer to custom question 1  


'''[GUESTCUSTOMQ2]''' - answer to custom question 2  
[GUESTCUSTOMQ2] - answer to custom question 2  


'''[GUESTCUSTOMQ3]''' - answer to custom question 3  
[GUESTCUSTOMQ3] - answer to custom question 3  


'''[GUESTCUSTOMQ4]''' - answer to custom question 4
[GUESTCUSTOMQ4] - answer to custom question 4


'''[GUESTCUSTOMQ5]''' - answer to custom question 5  
[GUESTCUSTOMQ5] - answer to custom question 5  


'''[GUESTCUSTOMQ6]''' - answer to custom question 6
[GUESTCUSTOMQ6] - answer to custom question 6


'''[GUESTCUSTOMQ7]''' - answer to custom question 7
[GUESTCUSTOMQ7] - answer to custom question 7


'''[GUESTCUSTOMQ8]''' - answer to custom question 8
[GUESTCUSTOMQ8] - answer to custom question 8


'''[GUESTCUSTOMQ9]''' - answer to custom question 9
[GUESTCUSTOMQ9] - answer to custom question 9


'''[GUESTCUSTOMQ10]''' - answer to custom question 10  
[GUESTCUSTOMQ10] - answer to custom question 10  


'''[REFERRER]''' - Referrer  
[REFERRER] - Referrer  


'''[REFERRER2]''' - Referrer2  
[REFERRER2] - Referrer2  


'''[ORIGINALREFERRER]''' - Original referrer
[ORIGINALREFERRER] - Original referrer


'''[APIREF]''' - the booking number at the originating channel
[APIREF]''' - the booking number at the originating channel


'''[APIMESSAGE]''' - api message sent by originating channel
[APIMESSAGE] - api message sent by originating channel


'''[NOTES]''' - notes  
[NOTES] - notes  


'''[MESSAGE]''' - the content of the booking message field
[MESSAGE] - the content of the booking message field


'''[REFERENCE]''' - content of the booking reference field
[REFERENCE] - content of the booking reference field


'''[INVOICEBALANCE]''' - invoice balance
[INVOICEBALANCE] - invoice balance


'''[INVOICEBALANCE:50%]''' - percentage of invoice balance
[INVOICEBALANCE:50%] - percentage of invoice balance


'''[INVOICEBALANCE:-100]''' - invoice balance with offset amount
[INVOICEBALANCE:-100] - invoice balance with offset amount


'''[INVOICEPARTBALANCE:status1,status2,status4]''' - Calculate the balance of all invoice 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.
[INVOICEPARTBALANCE:status1,status2,status4] - Calculate the balance of all invoice 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.


'''[INVOICECHARGES]''' - invoice sum of all charges  
[INVOICECHARGES] - invoice sum of all charges  


'''[INVOICECHARGES:50%]''' - invoice sum of all charges with percentage multiplier
[INVOICECHARGES:50%] - invoice sum of all charges with percentage multiplier


'''[INVOICECHARGES:-100]''' - invoice sum of all charges with offset  
[INVOICECHARGES:-100] - invoice sum of all charges with offset  


'''[INVOICEPAYMENTS]''' - invoice sum of all payments  
[INVOICEPAYMENTS] - invoice sum of all payments  


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


'''[INVOICEPAYMENTS:-100]''' - invoice sum of all payments with offset  
[INVOICEPAYMENTS:-100] - invoice sum of all payments with offset  


'''[INVOICECREDITS]''' - invoice sum of all credit items (negative items)
[INVOICECREDITS] - invoice sum of all credit items (negative items)


'''[INVOICECREDITS:50%]''' - invoice sum of all credit items with percentage multiplier  
[INVOICECREDITS:50%] - invoice sum of all credit items with percentage multiplier  


'''[INVOICECREDITS:-100]''' - invoice sum of all credit items with offset  
[INVOICECREDITS:-100] - invoice sum of all credit items with offset  


'''[INVOICEDEBITS]''' - invoice sum of all debit items (positive items)
[INVOICEDEBITS] - invoice sum of all debit items (positive items)


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


'''[INVOICEDEBITS:-100]''' - invoice sum of all debit items with offset
[INVOICEDEBITS:-100] - invoice sum of all debit items with offset


'''[INVOICEVAT]''' - invoice sum of all vat value
[INVOICEVAT] - invoice sum of all vat value


'''[INVOICETABLE]''' - invoice table
[INVOICETABLE] - invoice table


'''[INVOICETABLE2]''' - invoice table with status field
[INVOICETABLE2] - invoice table with status field


'''[INVOICETABLEVAT]''' - invoice table with vat information
[INVOICETABLEVAT] - invoice table with vat information


'''[INVOICETABLEVAT2]''' - invoice table with vat information and status field
[INVOICETABLEVAT2] - invoice table with vat information and status field


'''[STATUS]''' - status of booking  
[STATUS] - status of booking  


'''[FLAG]''' - Flag
[FLAG] - Flag


'''[CANCELURL]''' - URL to view and cancel bookings  
[CANCELURL] - URL to view and cancel bookings  


'''[CURRENTDATE]''' - current date
[CURRENTDATE] - current date


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


'''[CURRENTDATE:+1day]''' - offset from current date, can be any number of days positive or negative  
[CURRENTDATE:+1day] - offset from current date, can be any number of days positive or negative  


'''[CURRENTTIME]''' - current time
[CURRENTTIME] - current time


'''[BOOKINGDATE]''' - booking date
[BOOKINGDATE] - booking date


'''[BOOKINGTIMEDATE]''' - booking date and time
[BOOKINGTIMEDATE] - booking date and time


'''[BOOKINGDATEYYYY-MM-DD]''' - booking date in YYYY-MM-DD format
[BOOKINGDATEYYYY-MM-DD] - booking date in YYYY-MM-DD format


'''[BOOKINGDATE:+1day]''' - offset from booking date, can be any number of days positive or negative
[BOOKINGDATE:+1day] - offset from booking date, can be any number of days positive or negative


'''[BOOKINGIP]''' - ip address of booker's computer
[BOOKINGIP] - ip address of booker's computer


'''[ROOMID]''' - room id number
[ROOMID] - room id number


'''[ROOMMETAAUXTEXT]''' - room meta auxiliary text
[ROOMMETAAUXTEXT] - room meta auxiliary text


'''[INTERNALROOMNAME]''' - internal room name as used in the control panel, this is not the translated room name shown on the booking page
[INTERNALROOMNAME] - internal room name as used in the control panel, this is not the translated room name shown on the booking page


'''[VIEWBOOKING]''' - create a URL to log into the control panel and view this booking (for hosts, not intended to be sent to guests)
[VIEWBOOKING] - create a URL to log into the control panel and view this booking (for hosts, not intended to be sent to guests)


'''[EMAIL:00]''' - Email status to display in the hover text of a booking. Replace 00 with the number of the Email template
[EMAIL:00] - Email status to display in the hover text of a booking. Replace 00 with the number of the Email template

Revision as of 07:34, 8 May 2015

Below is a List of Template Variables.

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.

The date variables can have an optional offset value of a number of days added after a colon, for example [FIRSTNIGHT:-3 days]

The price variables can have an optional offset value applied which can be a percentage or fixed amount with or without minus sign added after a colon, for example [PRICE:-10] or [INVOICEBALANCE:25%]

Template Variables

[PROPERTYNAME] - property name

[PROPERTYADDRESS] - property address

[PROPERTYCITY] - property city

[PROPERTYEMAIL] - property email

[PROPERTYPHONE] - property phone

[PROPERTYID] - property id number

[ROOMNAME] - room names of all booked rooms

[ROOMNAME1] - room name of first booked room

[ROOMNAMES] - room names including quantity of each booked room

[ROOMNAMEOFFER] - room names of all booked rooms with offer name

[OFFERNAME] - booked offer name for all booked rooms

[UNITNAME] - unit name of the assigned room type

[BOOKID] - booking reference

[REFERENCENUMBER] - booking reference

[FIRSTNIGHT] - first night booked

[FIRSTNIGHTSHORT] - first night booked in 1 Apr 2016 format

[FIRSTNIGHTYYYY-MM-DD] - first night booked in YYYY-MM-DD format

[FIRSTNIGHT:+1day] - offset from first night, can be any number of days positive or negative

[LASTNIGHT] - last night booked

[LASTNIGHTSHORT] - last night booked in 1 Apr 2016 format

[LASTNIGHTYYYY-MM-DD] - last night booked in YYYY-MM-DD format

[LASTNIGHT:+1day] - offset from last night, can be any number of days positive or negative

[LEAVINGDAY] - check-out day

[LEAVINGDAYSHORT] - check-out day in 1 Apr 2016 format

[LEAVINGDAYYYYY-MM-DD] - check-out day in YYYY-MM-DD format

[LEAVINGDAY:+1day] - offset from check-out, can be any number of days positive or negative

[NUMROOM] - the quantity of rooms booked (first room type only)

[NUMROOMS] - the quantity of rooms booked (sum of all rooms and room types)

[NUMNIGHT] - number of nights

[NUMADULT] - number of adults

[NUMCHILD] - number of children

[NUMPEOPLE] - number of guests

[RATEDESC] - name of the rate

[PRICE] - Value in price field (number entered in the price field of the booking)

[PRICE:10%] - Percentage value of Price

[PRICE:-10] - Price with offset amount

[AVPRICE] - Average Nightly Price

[AVPRICE:20%] - Percentage value of Average Nightly Price

[AVPRICE:15] - Average Nightly Price with offset amount

[DEPOSIT] - Value in deposit field

[TAX] - Value in tax field

[COMMISSION] - Value in commission field

[GUESTTITLE] - guest title

[GUESTFIRSTNAME] - first name

[GUESTNAME] - last name

[GUESTFULLNAME] - title, first name, last name

[GUESTEMAIL] - guest's Email address

[GUESTPHONE] - guests phone number

[GUESTADDRESS] - guests address

[GUESTPOSTCODE] - guests postcode

[GUESTCITY] - guests city

[GUESTCOUNTRY] - guests country

[GUESTMOBILE] - guests mobile number

[GUESTFAX] - guests fax number

[GUESTARRIVALTIME] - arrival time

[GUESTCOMMENTS] - comments in the booking

[GUESTCUSTOMQ1] - answer to custom question 1

[GUESTCUSTOMQ2] - answer to custom question 2

[GUESTCUSTOMQ3] - answer to custom question 3

[GUESTCUSTOMQ4] - answer to custom question 4

[GUESTCUSTOMQ5] - answer to custom question 5

[GUESTCUSTOMQ6] - answer to custom question 6

[GUESTCUSTOMQ7] - answer to custom question 7

[GUESTCUSTOMQ8] - answer to custom question 8

[GUESTCUSTOMQ9] - answer to custom question 9

[GUESTCUSTOMQ10] - answer to custom question 10

[REFERRER] - Referrer

[REFERRER2] - Referrer2

[ORIGINALREFERRER] - Original referrer

[APIREF] - the booking number at the originating channel

[APIMESSAGE] - api message sent by originating channel

[NOTES] - notes

[MESSAGE] - the content of the booking message field

[REFERENCE] - content of the booking reference field

[INVOICEBALANCE] - invoice balance

[INVOICEBALANCE:50%] - percentage of invoice balance

[INVOICEBALANCE:-100] - invoice balance with offset amount

[INVOICEPARTBALANCE:status1,status2,status4] - Calculate the balance of all invoice 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.

[INVOICECHARGES] - invoice sum of all charges

[INVOICECHARGES:50%] - invoice sum of all charges with percentage multiplier

[INVOICECHARGES:-100] - invoice sum of all charges with offset

[INVOICEPAYMENTS] - invoice sum of all payments

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

[INVOICEPAYMENTS:-100] - invoice sum of all payments with offset

[INVOICECREDITS] - invoice sum of all credit items (negative items)

[INVOICECREDITS:50%] - invoice sum of all credit items with percentage multiplier

[INVOICECREDITS:-100] - invoice sum of all credit items with offset

[INVOICEDEBITS] - invoice sum of all debit items (positive items)

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

[INVOICEDEBITS:-100] - invoice sum of all debit items with offset

[INVOICEVAT] - invoice sum of all vat value

[INVOICETABLE] - invoice table

[INVOICETABLE2] - invoice table with status field

[INVOICETABLEVAT] - invoice table with vat information

[INVOICETABLEVAT2] - invoice table with vat information and status field

[STATUS] - status of booking

[FLAG] - Flag

[CANCELURL] - URL to view and cancel bookings

[CURRENTDATE] - current date

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

[CURRENTDATE:+1day] - offset from current date, can be any number of days positive or negative

[CURRENTTIME] - current time

[BOOKINGDATE] - booking date

[BOOKINGTIMEDATE] - booking date and time

[BOOKINGDATEYYYY-MM-DD] - booking date in YYYY-MM-DD format

[BOOKINGDATE:+1day] - offset from booking date, can be any number of days positive or negative

[BOOKINGIP] - ip address of booker's computer

[ROOMID] - room id number

[ROOMMETAAUXTEXT] - room meta auxiliary text

[INTERNALROOMNAME] - internal room name as used in the control panel, this is not the translated room name shown on the booking page

[VIEWBOOKING] - create a URL to log into the control panel and view this booking (for hosts, not intended to be sent to guests)

[EMAIL:00] - Email status to display in the hover text of a booking. Replace 00 with the number of the Email template