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

TOURPLAN NX MESSAGING: SUBSTITUTION CODES

Document Version: 4.05
Last Updated: 14/05/2019 11:45
Author: Geoff Beaver

NOTE: This document is current as of the date noted above. Updates will be made on a regular basis as new codes become available.

Overview

The message code substitution works slightly differently than it did in Tourplan iS and has been developed with a few concepts that are useful to understand

Substitution Codes

Where possible the same substitution codes as used in previous versions of Tourplan are used in NX, so that any codes in data fields such as notes and voucher text will continue to work.

Pax NamesOne place where the codes are not compatible are the room and pax codes. In iS there were separate codes for Fastbook pax name output versus Groupbook rooming list output. In NX it has been rationalised to the Rooming List model allowing List, Rooms and Pax level structures to be created.

Code Validation

Tourplan iS didn't attempt to validate that the substitution code and any suffixes were correct and would attempt to resolve it the best way it could, potentially leading to invalid or at least unpredictable output. In NX where practical the system validates that the code and any suffixes are a valid combination before attempting to resolve it.

Data Context

Substitution codes are resolved based on what NX knows as the 'context' in which they have been declared. For example <AGENT> used at the header level of a Booking Agent message will output the Agent Value for the Booking, whereas if it was used in the SERVICES section of the message it would be the Agent Value of that Service Line. If a substitution code is used in a context that NX does not understand and/or is wrong then it will not resolve. For example using <SN> in the header of a booking agent message will not resolve because there is no Supplier name available in that context

Completed CodesNot all codes have been implemented. The list below, is by data type. It provides a list of codes that have been implemented and those codes should match their Tourplan iS counterparts.

Agent Substitutions

Subst. Code

Data Source

Parameters

AC

Code

 

AN

Name.

:P – Physical; :M - Mailing

AA1

Address 1

:P – Physical; :M - Mailing

AA2

Address 2

:P – Physical; :M - Mailing

AA3

Address 3

:P – Physical; :M - Mailing

AA4

Address 4

:P – Physical; :M - Mailing

AA5

Address 5

:P – Physical; :M - Mailing

APC

PostCode

:P – Physical; :M - Mailing

AGA1

Analysis Code 1

 

AGA2

Analysis Code 2

 

AGA3

Analysis Code 3

 

AGA4

Analysis Code 4

 

AGA5

Analysis Code 5

 

AGA6

Analysis Code 6

 

AGAD1

Analysis Description 1

 

AGAD2

Analysis Description 2

 

AGAD3

Analysis Description 3

 

AGAD4

Analysis Description 4

 

AGAD5

Analysis Description 5

 

AGAD6

Analysis Description 6

 

AUDT1

User Defined Text 1

 

AUDT2

User Defined Text 2

 

AUDT3

User Defined Text 3

 

AUDT4

User Defined Text 4

 

AUDT5

User Defined Text 5

 

AUDT6

User Defined Text 6

 

AUDT7

User Defined Text 7

 

AUDT8

User Defined Text 8

 

AUDT9

User Defined Text 9

 

AUDT10

User Defined Text 10

 

ABA

Bank Account Number

 

ABAN

Bank Account Name

 

ABK

Bank Name

 

ABR

Bank Branch

 

ACREATEDBY

Created By

 

ACREATEDDATE

Created Date

 

AEDITEDBY

Edited By

 

AEDITEDDATE

Edited Date

 

ACM

Master Code

 

ANM

Master Name

:P – Physical; :M - Mailing

AAM1

Master Address 1

:P – Physical; :M - Mailing

AAM2

Master Address 2

:P – Physical; :M - Mailing

AAM3

Master Address 3

:P – Physical; :M - Mailing

AAM4

Master Address 4

:P – Physical; :M - Mailing

AAM5

Master Address 5

:P – Physical; :M - Mailing

APCM

Master Post Code

:P – Physical; :M - Mailing

AUDTM1

Master User Defined Text 1

 

AUDTM2

Master User Defined Text 2

 

AUDTM3

Master User Defined Text 3

 

AUDTM4

Master User Defined Text 4

 

AUDTM5

Master User Defined Text 5

 

AUDTM6

Master User Defined Text 6

 

AUDTM7

Master User Defined Text 7

 

AUDTM8

Master User Defined Text 8

 

AUDTM9

Master User Defined Text 9

 

AUDTM10

Master User Defined Text 10

 

Agent Statement Substitutions

Subst. Code

Data Source

Parameters

AR

Transaction Booking Agent Ref

 

BN

Transaction Booking Name

 

CT

Transaction Booking Res Contact

 

BALEAgent Future Entered Balance 
BALTTotal Agent Balance

:FA Balance + Future Aged 
:FE Balance +Future Entered

BALCAgent Aged Balance Current Period:+ Current plus all overdue periods
BAL1Agent Aged Balance 1 Month:+ 1 Month plus all overdue periods
BAL2Agent Aged Balance 2 Months:+ 2 Months plus all overdue periods
BAL3Agent Aged Balance 3 Months:+ 3 Months plus all overdue periods
BAL4Agent Aged Balance 4 Months:+ 4 Months plus all overdue periods
BALF1Agent Aged Balance Future 1:+ Future 1 plus all Future periods
BALF2Agent Aged Balance Future 2:+ Future 2 plus all Future periods
BALF3Agent Aged Balance Future 3:+ Future 3 plus all Future periods
BALF4Agent Aged Balance Future 4:+ Future 4 plus all Future periods

BR

Transaction Booking Reference

 

CUR

Transaction Booking Currency

 

ITEMTOT

Transaction Item Total

 

STMTDATE

Statement Date

 

TD

Transaction Booking Travel Date

 

TRNADCASHTYPE

Transaction Payment Type

 

TRNADDESC1

Transaction Header Description 1

 

TRNADDESC2

Transaction Header Description 2

 

TRNADDESC3

Transaction Header Description 3

 

TRNAREF

Transaction Apply To Reference

 

TRNCRAMT

Transaction Credit Amount

 

TRNDATE

Transaction Date

 

TRNDESC1

Transaction Line Description 1

 

TRNDESC2

Transaction Line Description 2

 

TRNDRAMT

Transaction Debit Amount

 

TRNDUE

Transaction Due Date

 

TRNENTDATE

Transaction Header Entered Date

 

TRNENTPER

Transaction Header Entered Period

 

TRNENTTIME

Transaction Header Entered Time

 

TRNEXT

Transaction Extended Price Amount

 

TRNITEM

Transaction Item

 

TRNPER

Transaction Period

 

TRNPRICE

Transaction Unit Price Amount

 

TRNREF

Transaction Reference

 

TRNTOT

Transaction Total Amount

 

TRNTYPE

Transaction Type

 

UT1

Booking Header User Text 1

 

UT2

Booking Header User Text 2

 

UT3

Booking Header User Text 3

 

UT4

Booking Header User Text 4

 

UT5

Booking Header User Text 5

 

Allocations Substitutions

Subst. Code

Data Source

Parameters

ALLOC

Allocation Taken

 

ALD

Allocation Description

 

ALN

Allocation Name

 

ALSD

Allocation Split Description

 

ALSN

Allocation Split Name

 

ALUDESC

Allocation Unit Description

 

Bookings Substitutions

Subst. Code

Data Source

Parameters

BN

Name

 

BR

Full Reference

 

BRN

Reference Number

 

BBR

Branch

 

BDP

Department

 

BHD

Booking Id

 

AR

Agent Reference

 

CS

Consultant Code

 

CT

Res Contact

 

CN

Consultant Name

 

BST

Status Code

 

BSTD

Status Description

 

DE

Date Entered

 

LW

Last Work Date

:A – Alpha Date Format

LSD

Last Service Date

 

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

 

BHN

Branch Name

 

DN

Department Name

 

TD

Travel Date

 

UT1

Header User Text 1

 

UT2

Header User Text 2

 

UT3

Header User Text 3

 

UT4

Header User Text 4

 

UT5

Header User Text 5

 

SUMCODESummary Analysis Code 
SUMCODEDESCSummary Analysis Description 

Product Substitutions

Subst. Code

Data Source

Parameters

OPTD

Code

:CP - Show the value once for the code

OPTN

Description

:CP - Show the value once for the code

OPTC

Comment

:CP - Show the value once for the code

DBA1

Analysis Code 1

 

DBA2

Analysis Code 2

 

DBA3

Analysis Code 3

 

DBA4

Analysis Code 4

 

DBA5

Analysis Code 5

 

DBA6

Analysis Code 6

 

DBAD1

Analysis Description 1

 

DBAD2

Analysis Description 2

 

DBAD3

Analysis Description 3

 

DBAD4

Analysis Description 4

 

DBAD5

Analysis Description 5

 

DBAD6

Analysis Description 6

 

FCU

First Charge Unit

 

SCU

Second Charge Unit

 

SRV

Service Code

:CP - Show the value once for the code

SRVD

Service Description

:CP - Show the value once for the code

LOC

Location Code

:CP - Show the value once for the code

LOCD

Location Description

:CP - Show the value once for the code

LCL

Locality Code

:CP - Show the value once for the code

LCLD

Locality Description

:CP - Show the value once for the code

DES

Destination Code

:CP - Show the value once for the code

DESD

Destination Description

:CP - Show the value once for the code

CNTRY

Country Code

:CP - Show the value once for the code

CNTRYN

Country Name

:CP - Show the value once for the code

CLS

Class Code

 

CLSD

Class Description

 

AML

Amenities List

 

INVTXT1

Invoice Text 1

 

INVTXT2

Invoice Text 2

 

VNAME

Voucher Supplier Name

 

VADD1

Voucher Supplier Address 1

 

VADD2

Voucher Supplier Address 2

 

VADD3

Voucher Supplier Address 3

 

VADD4

Voucher Supplier Address 4

 

VADD5

Voucher Supplier Address 5

 

VPC

Voucher Supplier Address Post Code

 

VT1

Voucher Text Line 1

 

VT2

Voucher Text Line 2

 

VT3

Voucher Text Line 3

 

VT4

Voucher Text Line 4

 

VT5

Voucher Text Line 5

 

VT6

Voucher Text Line 6

 

VT7

Voucher Text Line 7

 

VT8

Voucher Text Line 8

 

VT9

Voucher Text Line 9

 

VT10

Voucher Text Line 10

 

Pax Substitutions

CHD

Number of Children

 

CHS

Number of Children Sharing

 

DRV

Number of Driver(s)

 

ESC

Number of Escort(s)

 

GDE

Number of Guides(s)

 

INF

Number of Infants(s)

 

PAX

Number of Adults(s)

 

TOTPAX

Total Pax Count

 

FOCCOST

Number of FOC Cost Units

 

FOCSELL

Number of FOC Sell Units

 

ADDR1

Pax Address Line 1

:L – Field Label

ADDR2

Pax Address Line 2

:L – Field Label

ADDR3

Pax Address Line 3

:L – Field Label

ADDR4

Pax Address Line 4

:L – Field Label

ADDR5

Pax Address Line 5

:L – Field Label

POSTCODE

Pax Postcode

 

FORENAME

Pax Christian Name/Forename

 

SURNAME

Pax Surname

 

TITLE

Pax Title

 

PAXTYPE

Pax Type (eg Adult)

:S Short (e.g 'A')

AGE

Pax Age

 

DOB

Pax Date of Birth

 

NOTES1

Pax Notes Field 1

 

NOTES2

Pax Notes Field 2

 

NOTES3

Pax Notes Field 3

 

NOTES4

Pax Notes Field 4

 

NOTES5

Pax Notes Field 5

 

PPEXPIRY

Passport Expiry Date

 

PPISSUED

Passport Issed Date

 

PPNAME

Passport Name

 

PPNATIONALITY

Passport Nationality

 

PPNUMBER

Passport Number

 

PPPLACE

Passport Place of Issue

 

PCM Quotes Substitutions

Some Booking codes will work on PCM's. Both are shown

 

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 

Phone Book Substitutions

Subst. Code

Data Source

Parameters

AMP

Agent Mobile Phone

 

AEP

Agent Email Address

 

AFP

Agent Fax Number

 

ANPAgent Contact Name 
APPAgent Phone 
AWPAgent Web Address 

AMPM

Agent Master Mobile Phone

 

AEPM

Agent Master Email Address

 

AFPM

Agent Master Fax Number

 

APPMAgent Master Phone 
AWPMAgent Master Web Address 

SMP

Supplier Mobile Phone

 

SEP

Supplier Email Address

 

SFP

Supplier Fax Number

 

SNPSupplier Contact Name 

SMPM

Supplier Master Mobile Phone

 

SPPSupplier Phone 
SWPSupplier Web Address 

SEPM

Supplier Master Email Address

 

SFPM

Supplier Master Fax Number

 

SPPMSupplier Master Phone 
SWPMSupplier Master Web Address 

Price Substitutions

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 invoice transactions for the booking that are in 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

 

Room Substitutions

Subst. Code

Data Source

Parameters

ROOMTYPE

Room Type - (e.g. TW)

:D Description - e.g. Twin

LISTNAMERooming List Name

 

KEY

Room Key

 

ROOMNAMERoom Type DescriptionEquivalent to <ROOMTYPE:D>

ROOMSEQ

Room Sequence

 

ROOMTOTBooking Room count

:FOCCOST - Number of Cost FOC Rooms
:FOCSELL - Number of Sell FOC Rooms
:-FOCCOST - Number of Booking rooms less Cost FOC Rooms
:-FOCSELL - Number of Booking rooms less Sell FOC Rooms

ITNAME

Itinerary Name

 

DB

Count of Double Rooms

:ND No Description

OT

Count of 'Other' Rooms

:ND No Description

QD

Count of Quad Rooms

:ND No Description

SG

Count of Single Rooms

:ND No Description

TR

Count of Triple Rooms

:ND No Description

TW

Count of Twin Rooms

:ND No Description

Service Line Substitutions

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

 

Transaction Substitutions

Subst. Code

Data Source

Parameters

TRNREF

Reference

 

TRNDATE

Date

 

TRNDESC1

Description Line 1

 

TRNDESC2

Description Line 2

 

TRNQTY1

Quantity 1

 

TRNQTY2

Quantity 2

 

TRNEXT

Extended Price Amount

 

TRNPRICE

Unit Price Amount

 

TRNTOT

Total Amount

:BC Output in Base Currency.

TRNAC

Posting Account

:F – Full Account Number (BR/Dp/Acct)
:FD – Full Account Description

TRNDRAC

Debit Posting Account

:F – Full Account Number (BR/Dp/Acct)
:FD – Full Account Description

TRNCRAC

Credit Posting Account

:F – Full Account Number (BR/Dp/Acct)
:FD – Full Account Description

TRNADATE

Transaction Apply Date

:T – Out Travel Date (if there is one) else the Apply Date.

TRNDRBR

Debit Account Branch

 

TRNCRBR

Credit Account Branch

 

TRNCRDP

Credit Account Department

 

TRNDRDP

Debit Account Department

 

TRNCOMM

Commission Amount

Use in Lines section

TRNTOTCOMMTotal Commission AmountUse in Total Section

TRNCURR

Currency

 

TRNDUE

Due Date

 

TRNITEM

Booking or Transaction Reference

 

TRNEXCLTAX

Amount Excluding Tax

:BC Output in Base Currency. Use in Lines Section

TRNTOTEXCLTAXTotal Amount Excluding Tax:BC Output in Base Currency. Use in Totals Section

TRNDRAMT

Debit Amount

 

TRNCRAMT

Credit Amount

: N – Show amount as a Negative

TRNSC

Booking Service Line Supplier Code

 

TRNSN

Booking Service Line Supplier Name

 

TRNSUB

Sub-total Amount

 

TRNTAX

Tax Amount.

:BC Output in Base Currency. Use in Lines Section

TRNTOTTAXTotal Tax Amount.:BC Output in Base Currency. Use in Totals Section

TRNTYPE

Transaction Header Type

:F – Full Transaction Type Name

TRNWHA

With-held Amount

 

TRNTOC

Tax on Commission Amount

BC Output in Base Currency. Use in Lines Section

TRNTOTTOCTotal Tax on Commission Amount:BC Output in Base Currency. Use in Totals Section
TRNENTBYTransaction Entered By 
CWCheque WordsPrints transaction value as text
CWUCheque Words - Units 
CWTCheque Word - Thousands 
CWTTCheque Word - Tens of Thousands 
CWTUCheque Word - Tens of Units 
CWMCheque Word Millions 
CWHCheque Word Hundreds 
CWHTCheque Word Hundreds of Thousands 
CWDCheque Word Decimals 
ARTransaction Booking Agent Reference 
BNTransaction Booking Name 
BRTransaction Booking Reference 
DATETransaction Booking Line Service Date 
OPTNTransaction Service Line Product Description 
TDTransaction Booking Travel Date 

User Substitutions

Subst. Code

Data Source

Parameters

UN

Name

 

UPWD

Password

 

UFN

Full Name

 

UT

Title

 

UE

Email Address

 

UM

Mobile Number

 

UP

Phone Number

 

UF

Fax Number

 

UW

Web Address

 

SYSDATE

System Date

*

EFT Substitution

Only a subset of substitution codes operate in EFT formats.


Subst. Code

Data Source

Parameters

EFTBT

EFT Batch Total

 

HASHTOTAL

Hashtotal

 

SBA

Supplier Bank Account Number

 

SBAN

Supplier Bank Account Name

 

SBK

Supplier Bank Name

 

SBR

Supplier Bank Branch

 

SC

Supplier Code

 

SCREATEDBY

Supplier Created By

 

SCREATEDDATE

Supplier Created Date

 

SEDITEDBY

Supplier Last Modified By

 

SEDITEDDATE

Supplier Last Modified Date

 

SMA1

Supplier Mailing Address Line 1

 

SMA2

Supplier Mailing Address Line 2

 

SMA3

Supplier Mailing Address Line3

 

SMA4

Supplier Mailing Address Line 4

 

SMA5

Supplier Mailing Address Line5

 

SMAM1

Supplier Master MailingAddress Line 1

 

SMAM2

Supplier Master MailingAddress Line 2

 

SMAM3

Supplier Master MailingAddress Line 3

 

SMAM4

Supplier Master MailingAddress Line 4

 

SMAM5

Supplier Master MailingAddress Line 5

 

SMPC

Supplier Mailing Address Post Code

 

SMPCM

Supplier Master Mailing Address Post Code

 

SN

Supplier Name

 

SNM

Supplier Master Name

 

SPA1

Supplier Physical Address Line 1

 

SPA2

Supplier Physical Address Line 2

 

SPA3

Supplier Physical Address Line 3

 

SPA4

Supplier Physical Address Line 4

 

SPA5

Supplier Physical Address Line 5

 

SPAM1

Supplier Master Physical Address Line 1

 

SPAM2

Supplier Master Physical Address Line 2

 

SPAM3

Supplier Master Physical Address Line 3

 

SPAM4

Supplier Master Physical Address Line 4

 

SPAM5

Supplier Master Physical Address Line 5

 

SPPC

Supplier Physical Address Post Code

 

SPPCM

Supplier Master Physical Address Post Code

 

SUDT1

Supplier User Defined Text 1

 

SUDT2

Supplier User Defined Text 2

 

SUDT3

Supplier User Defined Text 3

 

SUDT4

Supplier User Defined Text 4

 

SUDT5

Supplier User Defined Text 5

 

SUDT6

Supplier User Defined Text 6

 

SUDT7

Supplier User Defined Text 7

 

SUDT8

Supplier User Defined Text 8

 

SUDT9

Supplier User Defined Text 9

 

SUDT10

Supplier User Defined Text 10

 

SUDTM1

Supplier Master User Defined Text 1

 

SUDTM2

Supplier Master User Defined Text 2

 

SUDTM3

Supplier Master User Defined Text 3

 

SUDTM4

Supplier Master User Defined Text 4

 

SUDTM5

Supplier Master User Defined Text 5

 

SUDTM6

Supplier Master User Defined Text 6

 

SUDTM7

Supplier Master User Defined Text 7

 

SUDTM8

Supplier Master User Defined Text 8

 

SUDTM9

Supplier Master User Defined Text 9

 

SUDTM10

Supplier Master User Defined Text 10

 

SYSDATE

System Date

 

TRNCOUNT

Number of Transaction in the Batch

 

TRNCURR

Transaction Currency

 

TRNDATE

Transaction Date

 

TRNREF

Transaction Reference

 
TRNTOTTransaction Total Amount 

 

Air Substitutions

Use standard messaging codes to output ticket pricing - e.g., COST, SELL, AGENT, RETAIL etc.

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