Variables
Customer
Usage
${customer.VARIABLE} // Replace VARIABLE with the appropriate field
|
Definition
|
Description
|
Example
|
|---|---|---|
| addressAddition | ${customer.addressAddition} | |
| addressFormatted | The default formatting for a customer address. | ${customer.addressFormatted} |
| city | ${customer.city} | |
| country | The country of the customer | ${customer.country} |
| creationDate | Date of the creation of the customer | ${customer.creationDate?string["dd.MM.YYYY"]} |
| creator | Name of the creator of the customer | ${customer.creator} |
| ${customer.email} | ||
| firstName | ${customer.firstName} | |
| lastName | ${customer.lastName} | |
| name | Combination of firstName and lastName | ${customer.name} |
| number | The customer number in advatra (K1000001) | ${customer.number} |
| phone | ${customer.phone} | |
| state | ${customer.state} | |
| street | ${customer.street} | |
| website | ${customer.website} | |
| zipCode | ${customer.zipCode} |
Document
Usage
${document.VARIABLE} // Replace VARIABLE with the appropriate field
|
Definition
|
Description
|
Example
|
|---|---|---|
| travelStart | Start of the travel, only on travel documents | ${document.travelStart?string["dd.MM.YYYY"]} |
| travelEnd | End of the travel, only on travel documents | ${document.travelEnd?string["dd.MM.YYYY"]} |
| expirationDate | Date until the document is valid | ${document.expirationDate?string["dd.MM.YYYY"]} |
| number | The document number (D1000001.101) | ${document.number} |
| currency | The Currency of the document, ISO 4217 | ${document.currency} |
| note | ${document.note} | |
| type | Offer, Confirmation, Invoice, Deposit, Prepayment | ${document.type} |
| language | ${document.language} | |
| locale | Can be used for the translation of the document | ${document.locale} |
| date | ${document.date?string["dd.MM.YYYY"]} | |
| charged | Used for Deposit and Prepayment. Defines if they have been charged to an invoice. | ${document.charged} |
| exportDate | Date, when the document have been exported to the accounting system | ${document.exportDate?string["dd.MM.YYYY"]} |
| canton | Location | ${document.canton} |
| image | ||
| days | List of days contained in the offer/confirmation |
Dossier
Usage
${dossier.VARIABLE} // Replace VARIABLE with the appropriate field
|
Definition
|
Description
|
Example
|
|---|---|---|
| name | ||
| openingDate | ||
| status | ||
| employee | ||
| responsibleEmployee | ||
| travelAgent | ||
| number |
Product
Usage
[#list products as product]
${product.VARIABLE} // Replace VARIABLE with the appropriate field
[#/list]
|
Definition
|
Description
|
Example
|
|---|---|---|
| note | ||
| start | ||
| end | ||
| title | ||
| description | ||
| voucherRelevant | ||
| voucherText | ||
| person | ||
| images | ||
| images3x2 | ||
| type | ||
| travellers | See details here | |
| customer | See details here | |
| notes | ||
| prices | See details here | |
| guides | See details here | |
| drivers | See details here | |
| supplierNotes | ||
| locationSmall | only available, when a template is linked. | |
| locationMedium | only available, when a template is linked. | |
| locationLarge | only available, when a template is linked. | |
| hasKickback | true, if any service has a commission |
Price
Usage
[#list products as product]
[#list product.prices as price]
${price.VARIABLE} // Replace VARIABLE with the appropriate field
[/#list]
[#/list]
|
Definition
|
Description
|
Example
|
|---|---|---|
| name | ||
| person | ||
| quantity | ||
| price | ||
| type | ||
| discount | ||
| purchasingPrice | ||
| creditorInvoiceReceived | ||
| billingText | ||
| effectivePurchasingPrice | ||
| vat | Vat Object | |
| kickback | ||
| kickbackAmount | ||
| kickbackInvoiceCreated | ||
| kickbackVat | ||
| total | TotalPrice Object | |
| hotelNights | ||
| supplier | See details here |
TotalPrice
Usage
${totalPrice.VARIABLE} // Replace VARIABLE with the appropriate field
|
Definition
|
Description
|
Example
|
|---|---|---|
| vats | ||
| surcharges | ||
| priceNetto | ||
| priceVat | ||
| priceBrutto | ||
| totalPriceBrutto | ||
| priceNettoFormatted | ||
| totalPriceFormatted |
Traveller
Usage
[#list travellers as traveller]
${traveller.VARIABLE} // Replace VARIABLE with the appropriate field
[#/list]
|
Definition
|
Description
|
Example
|
|---|---|---|
| firstName | ||
| lastName | ||
| name | ||
| phone | ||
| passportNumber | ||
| placeOfIssue | ||
| birthday | ||
| arrivalType | ||
| arrivalDate | ||
| arrivalTime | ||
| arrivalNumber | ||
| arrivalFlightClass | ||
| arrivalSeat | ||
| departureType |
Guide
Usage
[#list guides as guide]
${guide.VARIABLE} // Replace VARIABLE with the appropriate field
[#/list]
|
Definition
|
Description
|
Example
|
|---|---|---|
| firstName | ||
| lastName | ||
| name | ||
| phone | ||
Driver
Usage
[#list drivers as driver]
${driver.VARIABLE} // Replace VARIABLE with the appropriate field
[#/list]
|
Definition
|
Description
|
Example
|
|---|---|---|
| firstName | ||
| lastName | ||
| name | ||
| phone | ||