Template Variables

From Beds24 Wiki
Revision as of 20:16, 18 January 2015 by Markkinchin (talk | contribs)
Jump to navigation Jump to search

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

[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

[REFERENCENUMBER] - booking reference

[FIRSTNIGHT] - first night booked

[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

[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

[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

[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

[GUESTNAME] - last name

[GUESTFIRSTNAME] - first name

[GUESTFULLNAME] - titel, 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

[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

[INVOICEPAYMENTS] - invoice sum of all payments

[INVOICECREDITS] - invoice sum of all credit items

[INVOICEDEBITS] - invoice sum of all debit items

[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

[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

Retrieved from "https://wiki.beds24.com/index.php?title=Template_Variables&oldid=5671"