Short codes are used when creating emails and PDFs, to include variables so that your emails are contextualised for the course, venue etc that the customer is attending.
See Variable short codes for use in Emails and PDFs
Pricing Details can be used on emails and in PDFs, but are also used when displaying the information on public pages and pages within Wordpress. The Pricing Detail fields rely on a few records to be in place:
-
The Payment Method field to be on the document form
-
A payment method to be selected on the submitted document
-
A default tax rule to be configured (or a tax rule for the specific location of the course date the document is linked to)
These records provide the following to make the pricing calculations work: the Payment Method provides information for any relevant surcharge to be calculated, and the way to accept payment. Note that payment method variables are not included here. The Tax Rule provides for the calculation of tax and different formats to display the values in, the format includes if the display should include tax and what spacing/symbols should be included. You have access to three formats: Short, Long and Currency. The descriptions below show what format is used by default.
The following is a table displaying the different short codes, their name, a description and the license that they apply to. This is a lot to maintain - if you spot any inconstancies or you notice there is more than what is listed here please let us know!
Agreed Price - Short Format
[PriceDetail:PricePriceFmtSht]
This is the amount found on the Document, it includes discounts that are calculated by the price rules or manual adjustments – but NOT discounts from the catalog nor multbookings. Format used: Short format
Example value: $ 159.50 incl. GST
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |
Agreed Price - Long Format
[PriceDetail:PricePriceFmtLng]
See Agreed Price – Short Format Format used: Long format
Example value: $ 145.00 + 14.50 GST
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |
Price for Catalog – not formatted
[PriceDetail:PriceExtras]
This is the net total of the Catalog items, it includes only catalog item discounts and excludes items that have an effect on the total price. Unless formatted it does not include tax. Format used: Currency display format
Example value: -5
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| N | TBC | TBC | Y | Y |
Price for Catalog - Long Format
[PriceDetail:PriceExtrasLong]
See Price for Catalog – Currency Format Format used: Long format
Example value: $ -5.00 + -0.50 GST
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| N | TBC | TBC | Y | Y |
Price for Catalog - Short Format
[PriceDetail:PriceExtrasShort]
See Price for Catalog – Currency Format Format used: Short format
Example value: $ -5.50 incl. GST
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| N | TBC | TBC | Y | Y |
Catalog List - Long Format
[PriceDetail:PriceProductTableLong]
This is a List of the Catalog items, not including discounts in a table format Format used: Long format
Example value:
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| N | TBC | TBC | Y | Y |
Catalog List - Short Format
[PriceDetail:PriceProductTableShort]
See Catalog List - Long Format Format used: Short format
Example value:
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| N | TBC | TBC | Y | Y |
Invoice Table – Currency Format
[PriceDetail:InvoiceTable]
This is an invoice table that includes a tax column, subtotals and grand totals, where there are multiple bookings these would also be included as are each of the catalog items for each document. Format used: Currency display format
Example value:
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |
Tax Rate (%)
[PriceDetail:PriceTaxRate]
This is taken from the Tax rule field ‘Rate %’ expressed with a percentage sign Format used: N/A
Example value: 10%
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |
Tax Name (Short Version)
[PriceDetail:PriceTaxNameShort]
This is taken from the Tax Rule field ‘Tax Name (short)’ Format used: N/A
Example value: GST
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |
Tax Name (Long Version)
[PriceDetail:PriceTaxNameLong]
This is taken from the Tax Rule field ‘Tax Name (long)’ Format used: N/A
Example value: Goods and Services
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |
Tax Payable - not formatted
[PriceDetail:PriceTaxPayable]
This is plain amount of what tax needs to be paid, in two decimal places Format used: N/A
Example value: 15.28
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |
Tax Payable – Currency Format
[PriceDetail:PriceTaxPayableFormatted]
See Tax Payable - not formatted Format used: Currency display format
Example value: AUD $ 15.28
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |
Price Including Tax – Currency Format
[PriceDetail:PriceWithTax]
This is the amount of the course (without extras) that includes tax, ie Agreed Price + Tax Format used: Currency display format
Example value: AUD $ 168.08
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |
Payment Surcharge (%)
[PriceDetail:PriceSurchargeRate]
The percentage surcharge for the payment method, as specified on the payment method Format used: N/A
Example value: 2%
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |
Payment Surcharge – Currency Format
[PriceDetail:PriceSurchargePayable]
The amount payable as determined by the surcharge percentage on the total amount including tax Format used: Currency display format
Example value: AUD $ 3.30
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |
Total Price with no formatting
[PriceDetail:PriceTotalPrice]
This is the amount in total, including the catalog items, tax, discounts and surcharges. Format used: N/A
Example value: 168.08
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |
Total Price with no formatting (in cents)
[PriceDetail:PriceTotalPriceCents]
See Total Price with no formatting Format used: N/A
Example value: 16808
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |
Total Payable - Currency Format
[PriceDetail:PriceTotalFormattedCurrency]
See Total Price with no formatting Format used: Currency display format
Example value: AUD $ 168.08
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |
Catalog Effect On Total Price – Currency Format
[PriceDetail:PriceCatalogEffectOnTotal]
The net effect of all items in the catalog Format used: Currency display format
Example value: AUD $ 10.78
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| N | TBC | TBC | Y | Y |
Delegate Cost - Short Format
[PriceDetail:PriceDelegateCostFmtSht]
The amount specified on the course date as ‘Delegate Cost’ Format used: Short format
Example value: $ 97.90 incl. GST
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| N | TBC | TBC | Y | Y |
Delegate Cost - Long Format
[PriceDetail:PriceDelegateCostFmtLng]
See Delegate Cost - Short Format Format used: Long format
Example value: $ 89.00 + 8.90 GST
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| N | TBC | TBC | Y | Y |
Delegate Cost Tax - Short Format
[PriceDetail:PriceDelegateCostTaxFmtSht]
The amount of tax mentioned in Delegate Cost - Short Format Format used: Short format
Example value: $ 9.79 incl. GST
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| N | TBC | TBC | Y | Y |
Delegate Cost Including Tax - Short Format
[PriceDetail:PriceDelegateCostTotalFmtSht]
The total including tax for Delegate Cost - Short Format Format used: Short format
Example value: $ 107.69 incl. GST
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| N | TBC | TBC | Y | Y |
Price Effect of Multiple Bookings – Currency Format
[PriceDetail:PriceMultiBooking]
Applicable for multiple booking environments and when a catalog item offers discounts for multiple bookings Format used: Currency display format
Example value: AUD $ 0.00
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| N | TBC | TBC | Y | Y |
Error Indicator
[PriceDetail:PriceError]
Format used: N/A
Example value:
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |
Error Message
[PriceDetail:PriceErrorMessage]
Format used: N/A
Example value:
| License | ||||
| Free | Multiple Trainers | Training Company | International Training | Reseller |
|---|---|---|---|---|
| Y | Y | Y | Y | Y |