Support: 1-469-617-5446
Reset Search
 

 

Article

Document Template Reference: Mustache Tags

« Go Back

Information

 
Content

Document Template Reference: Mustache Tags

Kigo uses a variables to allow document templates to be reused, without requiring you to manually edit an e-mail message. We use mustache tags to insert variables into document templates. This article discusses how to use mustache tags when creating document templates. This document also lists available tags, to assist with custom document template creation.

Variables are contained in within two sets of brackets, like this: {{variable}}.

Variables can be written in line with text that does not need to change. So, an e-mail message greeting may read something like this: Dear {{Renter.FirstName}},. When the document template is used to generate an e-mail message, the {{Renter.FirstName}} variable is replaced the appropriate guest's first name.

Another item to remember is that document templates that use mustache tags must also have a opening and closing section tag. The opening section tag is {{#result}}, and the closing section tag is {{/result}}. These tags should be at the beginning and end of any template that uses variables. So, in action, a simple document template may look like this:

{{#result}}

Dear {{Renter.FirstName}},

Thank you for booking a reservation!

{{/result}}

Finally, know that the variables that go inside the mustache tags may have several parts. The variable includes a prefix, which is a variable category, and a suffix, which provides the detailed variable. For example, in the variable {{Renter.FirstName.}}, "Renter" is the prefix, and "FirstName" is the suffix. The prefix and the suffix are always separated by a period (.). In some variables, you may have multiple suffixes.

Attraction

The suffixes available in this section relate to attractions that have been entered in Kigo, and that display on Kigo web sites. Also listed is the data type. If the items on this list that are actually the prefix for another section are bolded. This is for variables that require multiple suffixes, such as {{Booking.BookedBy.LastName}}.

  • ID - Int32
  • AltID - String
  • Type - String
  • Status - String
  • Name - String
  • Summary - String
  • Description - String
  • Email - String
  • FaxNumber - String
  • IMAddress - String
  • Phone1 - String
  • Phone2 - String
  • Phone3 - String
  • SecondaryEmail - String
  • TextMessage - String
  • TollfreeNumber - String
  • Website - String
  • Images - Media[]
  • PrimaryImage - Media
  • Address1 - String
  • Address2 - String
  • City - String
  • State - String
  • PostalCode - String
  • Region - String
  • Country - String
  • Metro - String
  • County - String
  • Neighborhood - String
  • Longitude - Decimal
  • Latitude - Decimal
  • Location - String
  • ContextData - ContextDataClass
  • AddedOn - BAPIDateTime
  • ModifiedOn - BAPIDateTime

Booking

  • Coupon - String
  • AmountToCharge - Nullable`1
  • ID - Nullable`1
  • AltID - String
  • Type - String
  • Status - String
  • PropertyID - Nullable`1
  • UnitID - Nullable`1
  • CheckIn - Nullable`1
  • CheckOut - Nullable`1
  • PrivateNotes - String
  • PublicNotes - String
  • NumAdults - Nullable`1
  • NumChildren - Nullable`1
  • Renter - Person
  • BookedBy - Person
  • Statement - Statement
  • CreditCard - CreditCard
  • TotalDueNow - Nullable`1
  • PaymentTerms - String
  • SCheckIn - String
  • SCheckOut - String
  • UnitBooked - Unit
  • IsValid - Boolean
  • IsPropertyValid - Boolean
  • IsNumGuestsValid - Boolean
  • IsMinStayValid - Boolean
  • IsTurndayValid - Boolean
  • Turnday - DayOfWeek
  • ValidationMessage - String
  • AllQuoteDisplays - List`1
  • QuoteDisplay - QuoteDisplay
  • LeadSource - String
  • LeadSourceID - Int32
  • Property - Property
  • HeldUntil - BAPIDateTime
  • AddedOn - BAPIDateTime
  • FriendlyType - String
  • FriendlyStatus - String
  • Check_In - BAPIDateTime
  • Check_Out - BAPIDateTime
  • BookedOn - Nullable`1

BAPIValue

  • Label - String
  • Data - String

BAPICollection

  • Key - String
  • Values - BAPIValue[]

SEOData

  • MetaDescrip - String
  • MetaKeywords - String
  • PageTitle - String
  • DetailURL - String
  • FullURL - String
  • Keyword - String
  • BookingURL - String
  • AddedOn - BAPIDateTime
  • ModifiedOn - BAPIDateTime
  • pkid - Int32
  • entity - String

BAPIObject

  • AddedOn - BAPIDateTime
  • ModifiedOn - BAPIDateTime

BAPIDateTime

  • DateValue - DateTime
  • ShortDate - String
  • LongDate - String
  • ShortTime - String
  • LongTime - String
  • LongDateTime - String
  • YYYYMMDD - String
  • LocalDateValue - DateTime
  • LocalShortDate - String
  • LocalLongDate - String
  • LocalShortTime - String
  • LocalLongTime - String
  • LocalLongDateTime - String
  • LocalYYYYMMDD - String
  • IsEmpty - Boolean
  • LCID - Int32

BAPIDecimal

  • Value - Decimal
  • SValue - String
  • SValue1 - String
  • SValue2 - String
  • Perc - String
  • IsEmpty - Boolean
  • LCID - Int32

BAPICurrency

  • LocalLCID - Int32
  • Currency - String
  • CurrencySymbol - String
  • LocalCurrencySymbol - String
  • LocalCurrency - String
  • LocalValue - Decimal
  • LocalSValue - String
  • LocalSValue1 - String
  • LocalSValue2 - String
  • Value - Decimal
  • SValue - String
  • SValue1 - String
  • SValue2 - String
  • Perc - String
  • IsEmpty - Boolean
  • LCID - Int32

BAPIMeasurement

  • Value - Decimal
  • Unit - String

CreditCard

  • Type - String
  • NameOnCard - String
  • Address - String
  • Address2 - String
  • City - String
  • State - String
  • PostalCode - String
  • Country - String
  • CardNumber - String
  • ExpiresOn - DateTime
  • SecurityCode - String
  • ExpiryMonth - Int32
  • ExpiryYear - Int32
  • FriendlyType - String
  • ID - Int32

Currency

  • ID - Int32
  • AltID - String
  • ConversionRate - Decimal
  • Country - String
  • Currency - String
  • CurrencySymbol - String
  • RegionInfo - RegionInfo

Development

  • ID - Int32
  • AltID - String
  • Type - String
  • Status - String
  • Name - String
  • Affiliation - String
  • Amenities - String[]
  • AmenityTypes - String[]
  • StarRating - Int32
  • TotalUnits - Int32
  • TopAmenities - List`1
  • Amenities2 - List`1
  • Description - String
  • Images - Media[]
  • PrimaryImage - Media
  • Address1 - String
  • Address2 - String
  • City - String
  • State - String
  • PostalCode - String
  • Region - String
  • Country - String
  • Metro - String
  • County - String
  • Neighborhood - String
  • Longitude - Decimal
  • Latitude - Decimal
  • Location - String
  • MaxRate - Decimal
  • MaxRateCurrency - String
  • MinRate - Decimal
  • MinRateCurrency - String
  • Summary - String
  • Tags - String[]
  • ManagedBy - String
  • IsBookable - Boolean
  • ContextData - ContextDataClass

ContextDataClass

  • ItemIndex - String
  • SEO - SEOData

DocTemplate

  • ID - Int32
  • Type - String
  • Status - String
  • Name - String
  • Summary - String
  • DocText - String

Event

  • ID - Int32
  • AltID - String
  • Type - String
  • Status - String
  • Lead - Person
  • PropertyID - String
  • UnitID - String
  • CheckIn - DateTime
  • CheckOut - DateTime
  • NumAdults - Int32
  • NumChildren - Int32
  • Subject - String
  • Message - String
  • MessageFormat - String
  • Statement - Statement
  • AddedOn - DateTime
  • CompletedOn - DateTime
  • LeadSource - String
  • LeadSourceID - Int32
  • Property - Property
  • SuggestedProperties - List`1
  • StartedOn - DateTime
  • Language - String
  • Check_In - BAPIDateTime
  • Check_Out - BAPIDateTime
  • SCheckIn - String
  • SCheckOut - String

Fee

  • ID - Int32
  • Type - String
  • Status - String
  • Amount - Decimal
  • Currency - String
  • BoolField - Boolean
  • CalculatePerNight - Boolean
  • CalculatePerPerson - Boolean
  • DefaultQty - Int32
  • EffectiveDate - DateTime
  • EndDate - DateTime
  • IsFlatRate - Boolean
  • MaxConditionValue - Decimal
  • MinConditionValue - Decimal
  • Notes - String
  • Percentage - Decimal
  • Name - String
  • QtyField - Boolean
  • StartDate - DateTime
  • CalculatePerChild - Boolean
  • CalculatePerAdult - Boolean
  • Taxable - Boolean
  • Description - String

MarketArea

  • Address1 - String
  • Address2 - String
  • City - String
  • State - String
  • PostalCode - String
  • Region - String
  • Country - String
  • Metro - String
  • County - String
  • Neighborhood - String
  • Longitude - Decimal
  • Latitude - Decimal
  • Images - Media[]
  • Name - String
  • ID - String
  • Summary - String
  • PrimaryImage - Media
  • message - String
  • Description - String
  • ContextData - ContextDataClass

ContextDataClass

  • SEO - SEOData
  • Index - Int32

Media

  • ID - Int32
  • Type - String
  • Status - String
  • OriginalURL - String
  • MediumURL - String
  • ThumbnailURL - String
  • Caption - String
  • MediaName - String

Office

  • ID - Int32
  • AltID - String
  • Type - String
  • Status - String
  • Name - String
  • Summary - String
  • Specialties - String[]
  • Email - String
  • PrimaryPhone - String
  • FaxNumber - String
  • AltPhone - String
  • TollfreeNumber - String
  • Website - String
  • Skype - String
  • ShowOnMap - Boolean
  • Address1 - String
  • Address2 - String
  • City - String
  • State - String
  • PostalCode - String
  • Region - String
  • Country - String
  • Metro - String
  • County - String
  • Neighborhood - String
  • Longitude - Decimal
  • Latitude - Decimal
  • FmtLocation - String

Person

  • ID - Int32
  • AltID - String
  • Type - String
  • Status - String
  • FirstName - String
  • LastName - String
  • Initial - String
  • Prefix - String
  • Suffix - String
  • Greeting - String
  • Title - String
  • Company - String
  • PrimaryEmail - String
  • HomePhone - String
  • WorkPhone - String
  • CellPhone - String
  • FaxNumber - String
  • WebSite - String
  • Address1 - String
  • Address2 - String
  • City - String
  • State - String
  • PostalCode - String
  • Country - String
  • Longitude - Decimal
  • Latitude - Decimal
  • LeadSource - String
  • LeadSourceID - Int32
  • Notes - String
  • Tags - List`1
  • Language - String

User

  • UserName - String
  • Email - String
  • EffectiveRole - String
  • Roles - String[]

Property

  • ID - Int32
  • AltID - String
  • MasterID - String
  • Type - String
  • Status - String
  • AdjLivingSpace - String
  • AdjLivingSpaceUnit - String
  • Amenities - String[]
  • AmenityTypes - String[]
  • Bathrooms - Decimal
  • Bedrooms - Int32
  • TopAmenities - List`1
  • Amenities2 - List`1
  • CheckInInstructions - String
  • Description - String
  • Development - String
  • AvailableOnline - Boolean
  • Fees - Fee[]
  • GarageSpaces - Int32
  • PrimaryImage - Media
  • Images - Media[]
  • Address1 - String
  • Address2 - String
  • City - String
  • State - String
  • PostalCode - String
  • Region - String
  • Country - String
  • Metro - String
  • County - String
  • Neighborhood - String
  • Longitude - Decimal
  • Latitude - Decimal
  • Location - String
  • LotSize - Int32
  • LotSizeUnit - String
  • MaxRate - Decimal
  • MaxRateCurrency - String
  • MinRate - Decimal
  • MinRateCurrency - String
  • MinRate2 - BAPICurrency
  • MaxRate2 - BAPICurrency
  • Headline - String
  • Sleeps - Int32
  • Stories - Int32
  • Summary - String
  • Tags - String[]
  • Taxes - Tax[]
  • Units - Unit[]
  • YearBuilt - Int32
  • ManagedBy - String
  • IsBookable - Boolean
  • NumReviews - Int32
  • AvgReview - Decimal
  • Floor - Int32
  • ParkingSpaces - Int32
  • HideAvailability - Boolean
  • Locale - String
  • MinStay - Int32
  • BookingFees - String[]
  • CancellationFees - String[]
  • CleaningFees - String[]
  • DepositFees - String[]
  • ExtraPersonFees - String[]
  • InsuranceFees - String[]
  • OtherFees - String[]
  • UpsellFees - String[]
  • MinStayRules - String[]
  • CancellationRules - String[]
  • TurnDayRules - String[]
  • BookingChargeRules - String[]
  • ReservationChangeRules - String[]
  • ContextData - ContextDataClass

ContextDataClass

  • Rates - SeasonRates
  • Availability - AvailabilityEntry[]
  • Quote - Booking
  • Reviews - List`1
  • Attractions - Attraction[]
  • SEO - SEOData
  • ItemIndex - Int32
  • Distance - String
  • DistanceKM - Nullable`1
  • DistanceMiles - Nullable`1

AvailabilityEntry

  • CheckIn - DateTime
  • CheckOut - DateTime
  • SCheckIn - String
  • SCheckOut - String

SeasonRates

  • Keys - String[]
  • Values - List`1

Rate

  • StartDate - DateTime
  • EndDate - DateTime
  • Value - Decimal
  • Currency - String
  • RateType - String
  • PropertyID - Int32
  • LengthOfStay - Int32
  • NumRoomsOrPersons - Int32
  • PropertyAltID - String

Review

  • ID - Int32
  • AltID - String
  • Type - String
  • Status - String
  • Title - String
  • ReviewedBy - Person
  • Source - String
  • ReviewedEntityID - String
  • Rating - Int32
  • SubmissionDate - DateTime
  • Comment - String
  • Response - String
  • ExternalLink - String
  • SubmittedOn - BAPIDateTime

Search

  • ID - Int32
  • AltID - String
  • Name - String
  • Type - String
  • Status - String
  • SortIndex - Int32
  • GroupingKey - String
  • HonorLocationContext - Boolean
  • ExcludeFromList - Boolean
  • Images - Media[]
  • PrimaryImage - Media
  • Description - String
  • ContextData - ContextDataClass

ContextDataClass

  • ItemIndex - String
  • SEO - SEOData

Site

  • ID - Int32
  • AltID - String
  • Type - String
  • Status - String
  • Url - String
  • SSLUrl - String
  • HasSSLCert - Boolean
  • Language - String
  • RegionInfo - RegionInfo
  • ConvertCurrency - Boolean
  • BasePropertyURL - String
  • BaseDevelopmentURL - String
  • BasePOIURL - String
  • BaseSpecialURL - String
  • BaseMarketAreaURL - String
  • BasePropertyFinderURL - String
  • BookingPaymentScreen - String
  • SecureURL - String
  • SearchScreen - String
  • Instasite - Boolean
  • OptOutURL - String
  • PrivacyURL - String
  • UniquePrefix - String
  • PrimaryMarketAreas - MarketArea[]

Solution

  • Logo - Media
  • Name - String
  • PrimaryContact - Person
  • StatementDisplayOptions - StatementDisplayOptions
  • PrimaryOffice - Office
  • ParentSolution - Solution
  • Phone - String
  • Email - String
  • ControlPanelURL - String

StatementDisplayOptions

  • LumpTaxes - Boolean
  • LumpFees - Boolean
  • LumpDeposits - Boolean

Special

  • ID - Int32
  • AltID - String
  • Name - String
  • Type - String
  • Status - String
  • EffectiveDate - BAPIDateTime
  • ExpirationDate - BAPIDateTime
  • CutoffDate - BAPIDateTime
  • CouponCode - String
  • BlockoutDate - String
  • AppliesToSolution - String
  • AppliesTo - List`1
  • Images - Media[]
  • PrimaryImage - Media
  • Summary - String
  • Description - String
  • Terms - String
  • ShowOnSite - Boolean
  • ContextData - ContextDataClass
  • AddedOn - BAPIDateTime
  • ModifiedOn - BAPIDateTime

ContextDataClass

  • ItemIndex - String
  • SEO - SEOData

Statement

  • ID - Int32
  • Type - String
  • Status - String
  • Description - String
  • DueOn - DateTime
  • Notes - String
  • Total - Decimal
  • Currency - String
  • Details - List`1
  • CurrencySymbol - String
  • LocalCurrencySymbol - String
  • LocalCurrency - String
  • QuoteIncludesLocalCurrency - Boolean
  • Total2 - BAPICurrency
  • Services - List`1
  • ServicesTotal - BAPICurrency
  • Fees - List`1
  • FeesTotal - BAPICurrency
  • Insurances - List`1
  • InsurancesTotal - BAPICurrency
  • Taxes - List`1
  • TaxesTotal - BAPICurrency
  • OptionalFees - List`1
  • OptionalFeesTotal - BAPICurrency
  • Discounts - List`1
  • DiscountsTotal - BAPICurrency
  • Deposits - List`1
  • DepositsTotal - BAPICurrency
  • TaxesAndFees - List`1
  • TaxesAndFeesTotal - BAPICurrency
  • TaxesFeesAndServices - List`1
  • TaxesFeesAndServicesTotal - BAPICurrency
  • TaxesFeesDepositsAndServices - List`1
  • TaxesFeesDepositsAndServicesTotal - BAPICurrency
  • TaxesAndServicesTotal - BAPICurrency
  • TaxesAndServices - List`1
  • FeesAndServicesTotal - BAPICurrency
  • FeesAndServices - List`1
  • TotalDueNow - BAPICurrency
  • DueOn2 - BAPIDateTime
  • ValidUntil - BAPIDateTime
  • AmountPaid - BAPICurrency
  • TotalDue - BAPICurrency
  • CheckSum - String

StatementDetail

  • ID - Int32
  • Type - String
  • Status - String
  • Quantity - Decimal
  • Amount - Decimal
  • SubTotal - Decimal
  • Currency - String
  • Notes - String
  • SubTotal2 - BAPIDecimal
  • Amount2 - BAPIDecimal
  • IsOptional - Boolean
  • MinQty - Int32
  • MaxQty - Int32
  • QtyField - Boolean
  • BoolField - Boolean
  • Taxable - Boolean
  • RelatedToID - Int32
  • RelatedToEntityID - Int32

Tax

  • ID - Int32
  • Type - String
  • Status - String
  • Amount - Decimal
  • Currency - String
  • IncludeFees - Boolean
  • IsFlatRate - Boolean
  • Notes - String
  • Percentage - Decimal
  • Name - String
  • MinConditionValue - Decimal
  • MaxConditionValue - Decimal
  • Description - String

Unit

  • ID - Int32
  • Status - String
  • PropertyUnitID - String
  • UnitName - String
  • AltID - String
Attachment 

Feedback

 

Was this article helpful?


   

Feedback

Please tell us how we can make this article more useful.

Characters Remaining: 255