Access Keys:
Skip to content (Access Key - 0)

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

TOURPLAN NX MESSAGING: SUBSTITUTION CODES

Document Version: 4.0405
Last Updated: 1514/0405/2019 0911:3545
Author: Geoff Beaver

Overview

...

Subst. Code

Data Source

Parameters

BHD

ID Number

 

PN or BN

Name

 

PST or BST

Header Status Code

 

PSTD or BSTD

Header Status Description

 

CN

Consultant Name

 

CS

Consultant Code

 

CUR

Currency Amount

:BC – Base Currency output.
:SLC - Service Line Cost Currency output.
:SLS – Service Line Sell Currency output

CURD

Currency Description

:BC – Base Currency.
:SLC - Service Line Cost Currency.
:SLS – Service Line Sell Currency

DEDate Entered 

DATE

Service Date

:CP Show value once until it changes

DAY

Day of Week

:CP Show value once until it changes

DAYNO

Day Number

:CP Show value once until it changes

EX

Extra Description

:1 – Product Extra 1
:2 – Product Extra 2
:3 – Product Extra 3
:4 – Product Extra 4
:5 – Product Extra 5
:A – Extra Details first & second charge units.
:F – Extra Details first charge unit.
D – Extra Details.
:l – Long Description
:S – Extra Details second charge unit.:BC – Base Currency output. 
:C - Output Extras Charge Basis - eg., Per Person, Per Group Per Room etc. 

IO

In/Out Date (Dates only)

 

IOD

In/Out Dates, incl Day of Week

 

LSD

Last Service Date

 

LW

Last Work Date

:A – In Alpha Format

SL1

Analysis Code 1

 

SL2

Analysis Code 2

 

SL3

Analysis Code 3

 

SL4

Analysis Code 4

 

SL5

Analysis Code 5

 

SL6

Analysis Code 6

 

SL1D

Analysis Description 1

 

SL2D

Analysis Description 2

 

SL3D

Analysis Description 3

 

SL4D

Analysis Description 4

 

SL5D

Analysis Description 5

 

SL6D

Analysis Description 6

 

SEQ

Service Sequence

 

TD

Travel/Base Date

 

QTY1

Quantity of First Charge Units

:C – Cost.
:S – Sell (Default)

QTY2

Quantity of Second Charge Units

:FOC – Number of FOC SCUs
:PAY – Number of Paid FOCs

PC

Service Line Price Code Used

 

PCD

Service Line Price Code Description

 

RM

Service Line Remarks

 

PAX

Adult Pax Count

 

ESC

Escort Count

 

DRV

Driver Count

 

GDE

Guide Count

 

AGENT

Agent Amount

:SS – Single Supplement
:TRD – Triple Reduction
:QR – Quad Reduction
:CHS – Child Supplement
:CSS – Child Share Supplement
:IS – Infant Supplement  
:R1 – From Pax Range 1 Only

RETAIL

Retail Amount

:SS – Single Supplement
:TRD – Triple Reduction
:QR – Quad Reduction
:CHS – Child Supplement
:CSS – Child Share Supplement
:IS – Infant Supplement 
:R1 – From Pax Range 1 Only

COST

Cost Amount

:SS – Single Supplement
:TRD – Triple Reduction
:QR – Quad Reduction
:CHS – Child Supplement
:CSS – Child Share Supplement
:IS – Infant Supplement

SELL

Sell Amount

:SS – Single Supplement
:TRD – Triple Reduction
:QR – Quad Reduction
:CHS – Child Supplement
:CSS – Child Share Supplement
:IS – Infant Supplement

ATAX

Agent Tax Amount

:SS – Single Supplement
:TRD – Triple Reduction
:QR – Quad Reduction
:CHS – Child Supplement
:CSS – Child Share Supplement
:IS – Infant Supplement

RTAX

Retail Tax Amount

:SS – Single Supplement
:TRD – Triple Reduction
:QR – Quad Reduction
:CHS – Child Supplement
:CSS – Child Share Supplement
:IS – Infant Supplement

CTAX

Cost Tax Amount

:SS – Single Supplement
:TRD – Triple Reduction
:QR – Quad Reduction
:CHS – Child Supplement
:CSS – Child Share Supplement
:IS – Infant Supplement

STAX

Sell Tax Amount

:SS – Single Supplement
:TRD – Triple Reduction
:QR – Quad Reduction
:CHS – Child Supplement
:CSS – Child Share Supplement
:IS – Infant Supplement

RATEBUYService Line Database buy rate:HT - Half Twin
:SS - Single Supplement
:TRD – Triple Reduction
:QR – Quad Reduction
:EX1 - EX5 – Extra 1 - 5 (Use individually)
:AD – Adult
:CHS – Child

:CSS – Child Share
:IS – Infant:
:DOWN – Display down the page
:R1 – From Pax Range 1 Only
:BKC - Output in Booking Currency
RATESELLService Line Database sell rate:HT - Half Twin
:SS - Single Supplement
:TRD – Triple Reduction
:QR – Quad Reduction
:EX1 - EX5 – Extra 1 - 5 (Use individually)
:AD – Adult
:CHS – Child
:CSS – Child Share
:IS – Infant:
:DOWN – Display down the page
:R1 – From Pax Range 1 Only
:BKC - Output in Booking Currency
MUPMarkup Amount 
MUPPCMarkup Percentage:SS - Single Supplement
:TRD – Triple Reduction
:QR – Quad Reduction
:CHS – Child

:CSS – Child Share
:IS – Infant:
COMMCommission Amount 
COMPCCommission Percentage:SS - Single Supplement
:TRD – Triple Reduction
:QR – Quad Reduction
:CHS – Child

:CSS – Child Share
:IS – Infant:

PU

Service Line Pickup

 

PUD

Pickup Date

 

PUT

Pickup Time

 

:12 – Output 12 Hour time - e.g., 10:35pm
:24 - (or no modifier) will output 24 hour time - e.g. 22:35

PUDAY

Pickup Day

 

DP

Service Line Drop-Off

 

DPDAY

Drop-Off Day

 

DPD

Drop-Off Date

 

DPT

Drop-Off Time

 :12 – Output 12 Hour time - e.g., 10:35pm
:24 - (or no modifier) will output 24 hour time - e.g. 22:35
TERMSPayment Terms 
VT1Product Voucher Text Line 1 
VT2Product Voucher Text Line 12 
VT3Product Voucher Text Line 3 
VT4Product Voucher Text Line 4 
VT5Product Voucher Text Line 5 
VT6Product Voucher Text Line 6 
VT7Product Voucher Text Line 7 
VT8Product Voucher Text Line 8 
VT9Product Voucher Text Line 9 
VT10Product Voucher Text Line 10 
RVT1Rate Level Voucher Text Line 1 
RVT2Rate Level Voucher Text Line 2 
RVT3Rate Level Voucher Text Line 3 
RVT4Rate Level Voucher Text Line 4 
RVT5Rate Level Voucher Text Line 5 
RVT6Rate Level Voucher Text Line 6 
RVT7Rate Level Voucher Text Line 7 
RVT8Rate Level Voucher Text Line 8 
RVT9Rate Level Voucher Text Line 9 
RVT10Rate Level Voucher Text Line 10 

...

Subst. Code

Data Source

Parameters

AGENT

Agent Amount

 

ATAX

Agent Tax Amount

 

COMM

Commission Amount

 

COMPCCommission Percentage 

COST

Cost Amount

 

CTAX

Cost Tax Amount

 

CUR

Currency Amount

:BC – Base Currency output.
:SLC - Service Line Cost Currency output.
:SLS – Service Line Sell Currency output

CURD

Currency Description

:BC – Base Currency.
:SLC - Service Line Cost Currency.
:SLS – Service Line Sell Currency

EXCHExchange Rate:SLC - Service Line Cost Currency output. 
:SLS – Service Line Sell Currency output
INVOICEDAmount Invoiced for Booking

:B - Sum of all

invoiced

invoice transactions for the booking that are in

the Invoice Currency

this invoices currency. 
:I - Value only of the invoice being output
:E - Value of all invoices for the booking in this invoices currency, except the receipt value (if any) of this invoice

MUP

Markup Amount

 

MUPPCMarkup Percentage 
RATEBUYService Line Database buy rate:TW - Twin
:SG - Single
:DB – Double
:TR – Triple 
:QD - Quad 
:OT - Other

:EX1 - EX5 – Extra 1 - 5 (Use individually)
:AD – Adult
:CH – Child
:CS – Child Share
:IN – Infant:
:AA – Additional Adult
:PP – Per Person
:BKC - Output in Booking Currency
RATESELLService Line Database sell rate:TW - Twin
:SG - Single
:DB – Double
:TR – Triple
:QD - Quad
:OT - Other
:EX1 - EX5 – Extra 1 - 5 (Use individually)
:AD – Adult
:CH – Child
:CS – Child Share
:IN – Infant:
:AA – Additional Adult
:PP – Per Person
:BKC - Output in Booking Currency

RETAIL

Retail Amount

 

RTAX

Retail Tax Amount

 

SELL

Sell Amount

 

STAX

Sell Tax Amount

 

RECEIVED

Amount Received for Booking

:B – Sum of all receipt transactions for the booking that are in the invoice currency.
:I – Sum of all receipt transactions for the invoice.
:E Sum of all receipt transactions for the booking that are in the invoice currency excluding this invoice receipts

TERMS

 

Payment Terms

 

...

Subst. Code

Data Source

Parameters

DAY

Service Day of Week

:L3 – Limit to 3 characters
:CP - Show the value once for the code

DATE

Service Date

:CP - Show the value once for the code

IO

In/Out Date (Dates only)

 

IOD

In/Out Dates, incl Day of Week

 

DAYNO

Day Number

:CP - Show the value once for the code

SEQ

Service Sequence

 

QTY1

Quantity of First Charge Units

:C – Cost.
:S – Sell (Default)

QTY2

Quantity of Second Charge Units

:FOC – Number of FOC SCUs
:PAY – Number of Paid FOCs:1 – Product Extra 1
:2 – Product Extra 2

EX

Extra Description

:1 – Product Extra 1
:2 – Product Extra 2
:3 – Product Extra 3
:4 – Product Extra 4
:5 – Product Extra 5
:A – Extra Details first & second charge units.
:F – Extra Details first charge unit.
:D – Extra Details
:S – Extra Details second charge unit.
:C - Output Extras Charge Basis - eg., Per Person, Per Group Per Room etc. 

PC

Price Code Used

 

PCD

Price Code Description

 

ST

Service Status

 

STD

Status Description

 

RM

Remarks

 

SCF

Supplier Confirmation

 

SUPCONF

Supplier Confirmation

 

CANCEL

Cancellation Period

:D – Days, :H – Hours, :DATE – Date :DH – Days and Hours

PU

Service Line Pickup

 

PUD

Pickup Date

 

PUT

Pickup Time

 

:12 – Output 12 Hour time - e.g., 10:35pm
:24 - (or no modifier) will output 24 hour time - e.g. 22:35

DP

Service Line Drop-Off

 

DPDAY

Drop-Off Day

 

DPD

Drop-Off Date

 

DPT

Drop-Off Time

 

:12 – Output 12 Hour time - e.g., 10:35pm
:24 - (or no modifier) will output 24 hour time - e.g. 22:35

VS

Voucher Status

 

VN

Voucher Number

:SEQ – Append sequence number to multiple same service vouchers - 12345/1
:NO – appends – 'Of nn e.e. 12345/1 of 4. Can be :SEQ:NO or :NO:SEQ

VT1Product Voucher Text Line 1 
VT2Product Voucher Text Line 12 
VT3Product Voucher Text Line 3 
VT4Product Voucher Text Line 4 
VT5Product Voucher Text Line 5 
VT6Product Voucher Text Line 6 
VT7Product Voucher Text Line 7 
VT8Product Voucher Text Line 8 
VT9Product Voucher Text Line 9 
VT10Product Voucher Text Line 10 
RVT1Rate Level Voucher Text Line 1 
RVT2Rate Level Voucher Text Line 2 
RVT3Rate Level Voucher Text Line 3 
RVT4Rate Level Voucher Text Line 4 
RVT5Rate Level Voucher Text Line 5 
RVT6Rate Level Voucher Text Line 6 
RVT7Rate Level Voucher Text Line 7 
RVT8Rate Level Voucher Text Line 8 
RVT9Rate Level Voucher Text Line 9 
RVT10Rate Level Voucher Text Line 10 
ASIDAssignment ID 
ASNAssignment Name 
ASSAssignment Status 
ASTYPEAssignment TypeOne of either Single Task, Independent Services or Hop On Hop Off
ASSTARTAssignment Start Date/Time 
ASENDAssignment End Date/Time 
ASDAssigned Driver Code 
ASDN Assigned Driver Name 
ASGAssigned Guide Code 
ASGNAssigned Guide Name 
ASVAssigned Vehicle Code 
ASVNAssigned Vehicle Name 

Cancellation Policy Substitutions (V1.2)

These can be used in only between the <<CANCELPENALTIES:START>> and <<CANCELLPENALTIES:END>> section, within <<SERVICES>> section start and end tags in messages that include service detail..

Subst. Code

Data Source

Parameters

APPLIESD

Cancellation penalty applies after this date

 

APPLIEST

 

Cancellation penalty applies inside this time (x days or x hours)

 

CNLAGENT

 

Cancellation penalty agent amount 
CNLAGENTTXCancellation penalty agent tax amount

 

CNLCOST

Cancellation penalty cost amount 
CNLCOSTTXCancellation penalty cost tax amount

 

CNLRETAIL

 

Cancellation penalty retail amount 
CNLRETAILTX

 

Cancellation penalty retail tax amount

 

FEE

 

Cancellation penalty fee amount

 

FEETYPE

Type of cancellation penalty - e.g,, Fixed, Percentage

 

INEFFECTIf the cancel penalty is in effect then display 'In effect' otherwise displays blank  
PERIODFCancellation penalty period from date 
PERIODTCancellation penalty period to date 

Supplier Substitutions

Subst. Code

Data Source

Parameters

SCREATEDBY

Created By

 

SCREATEDDATE

Created Date

 

SEDITEDBY

Edited By

 

SEDITEDDATE

Edited Date

 

SBA

Bank Account

 

SBAN

Bank Account Name

 

SBK

Bank Name

 

SBR

Bank Branch

 

SC

Code

:CP - Show the value once for the code

SN

Name

:P – Physical; :M – Mailing
:CP - Show the value once for the code

SA1

Address 1

:P – Physical; :M – Mailing

SA2

Address 2

:P – Physical; :M – Mailing

SA3

Address 3

:P – Physical; :M – Mailing

SA4

Address 4

:P – Physical; :M – Mailing

SA5

Address 5

:P – Physical; :M – Mailing

SPC

Post Code

:P – Physical; :M – Mailing

SPA1

Analysis Code 1

 

SPA2

Analysis Code 2

 

SPA3

Analysis Code 3

 

SPA4

Analysis Code 4

 

SPA5

Analysis Code 5

 

SPA6

Analysis Code 6

 

SPAD1

Analysis Description 1

 

SPAD2

Analysis Description 2

 

SPAD3

Analysis Description 3

 

SPAD4

Analysis Description 4

 

SPAD5

Analysis Description 5

 

SPAD6

Analysis Description 6

 

SUDT1

User Defined Text Field 1

 

SUDT2

User Defined Text Field 2

 

SUDT3

User Defined Text Field 3

 

SUDT4

User Defined Text Field 4

 

SUDT5

User Defined Text Field 5

 

SUDT6

User Defined Text Field 6

 

SUDT7

User Defined Text Field 7

 

SUDT8

User Defined Text Field 8

 

SUDT9

User Defined Text Field 9

 

SUDT10

User Defined Text Field 10

 

SCM

Master Code

 

SNM

Master Name

:P – Physical; :M – Mailing

SAM1

Master Address 1

:P – Physical; :M – Mailing

SAM2

Master Address 2

:P – Physical; :M – Mailing

SAM3

Master Address 3

:P – Physical; :M – Mailing

SAM4

Master Address 4

:P – Physical; :M – Mailing

SAM5

Master Address 5

:P – Physical; :M – Mailing

SPCM

Master Post Code

:P – Physical; :M – Mailing

SUDTM1

Master User Defined Text 1

 

SUDTM2

Master User Defined Text 2

 

SUDTM3

Master User Defined Text 3

 

SUDTM4

Master User Defined Text 4

 

SUDTM5

Master User Defined Text 5

 

SUDTM6

Master User Defined Text 6

 

SUDTM7

Master User Defined Text 7

 

SUDTM8

Master User Defined Text 8

 

SUDTM9

Master User Defined Text 9

 

SUDTM10

Master User Defined Text 10

 

...

Subst. Code

Data Source

Parameters

AIRAircraft Type:F - Full Description

ARR

Destination

:F - Full Description
:CTY - Country
:4 – Product Extra 4
:5 – Product Extra 5
:A – Extra Details first & second charge units.
:F – Extra Details first charge unit.
:D – Extra Details
:S – Extra Details second charge unit. 
:C - Output Extras Charge Basis - eg., Per Person, Per Group Per Room etc. 

ARRDATE

Arrival Date

 D - Day of week, full month
:T - Time

ARRTER

Arrival Terminal

:F - Full Description  

CARCarrier:F - Full Description

CLA

Class

:F - Full Description  

CSH

Code Share

 

DEP

Origin

 :F - Full Description
:CTY - Country

DEPDATE

Depart Date

  D - Day of week, full month
:T - Time

DEPTER

Departure Terminal

 :F - Full Description  

DISDistance 

ELA

Elapsed Time

 

FLI

Flight Number

 

FSTFlight Status:F - Full Description  
MEAMeals on Sector:F - Full Description  
REFPNR 
STOStops in Sector 
SEASeat Request 
SPMMeal Request 
TKNUMTicket Number 
TKFFFrequent Flyer Number(s) 
TKPAXnTicket Pax Name(s)n = 1 or 2 Each pax on a new line
TKTAXTax Amount