AutoRefundExchange_6 Documentation

<AutoRefundExchange_6> DPR00ARFEXC

+ Requests

+ <PNRBFRetrieveMods>

2024 7.0

+ <TargetCRSInfo>

BP01 1.0

Do not send this KLR if the PNR resides on the CRS receiving the request under the pseudo city which the Client used to logon to the Host.
<TargetCRS>	Alphanumeric	2	Description of Field: Indicates which CRS the PNR or BF should be retrieved from. Format (a-alpha, n-numeric, x-alpha/numeric): xx Special Format: Field should only be used when retrieving PNRs or BFs outside user's CRS. Use of this field to retrieve a PNR within Apollo when user is making entry from Apollo will result in an error. Possible Values (List or Range): '1V' = Apollo '1G' = Galileo How is null data specified? Character blanks. What does null data indicate? Retrieval will take place in users current CRS

Alpha

Description of Field:
Indicator wherein a user can ask application to perform a branch retrieval.
Format (a-alpha, n-numeric, x-alpha/numeric):
A
Possible Values (List or Range):
'Y' = User desires branch retrieval
'N' = Do not use branch retrieval
How is null data specified?
Character Blanks
What does null data indicate?
No branch retrieve is desired

Alphanumeric

Description of Field:
Pseudo city for branch retrieval.
Format (a-alpha, n-numeric, x-alpha/numeric):
xxxx
Possible Values (List or Range):
Character blanks = All branches
How is null data specified?
Character blanks.
What does null data indicate?
Retrieval applies to all branches if branch indicator set to "y".

Alphanumeric

Description of Field:
Affiliate name to be used in retrieval.
Format (a-alpha, n-numeric, x-alpha/numeric):
xxxxx
Examples:
AFFL1
How is null data specified?
Character blanks
What does null data indicate?
Use of affiliate data for retrieve not desired.

+ <PNRAddr>

BP02 1.0

This KLR must not be sent with the Air Indexed PNR Retrieve KLR (BP03)
<FileAddr>	Alphanumeric	8	Description of Field: Address of PNR or BF on it's respective CRS. Do not use this tag. Format (a-alpha, n-numeric, x-alpha/numeric): xxxxxxxx Special Format: This is the hexadecimal displayable value for the PNR / BF's file address. Examples: 3BD2343F How is null data specified? Character blanks. What does null data indicate? PNR / BF file address is not available.

Alphanumeric

Description of Field:
Record Code Check for this record.
Do not use this tag.
Format (a-alpha, n-numeric, x-alpha/numeric):
xx
Special Format:
This is the hexadecimal displayable value for the PNR / BF's record code check.
If used, this field must match the PNR or BF record check exactly or retrieval will fail with an error.
Examples:
0C
How is null data specified?
Character blanks
What does null data indicate?
User does not desire use of record code check in retrieval process.

Alphanumeric

Description of Field:
This is record locator / confirmation number of the PNR or BF.
Mandatory for the request.
Format (a-alpha, n-numeric, x-alpha/numeric):
xxxxxx
Special Format:
Use this field for retrieval when PNR or BF file address is not available.
Examples:
TM9TQ7
How is null data specified?
Character blanks
What does null data indicate?
User desires use of PNR / Bf file address for retrieval.

+ <PNRAirIndex>

BP03 1.0

This KLR must not be sent with the Direct PNR Retrieve KLR
<AirV>	Alphanumeric	3	Description of Field: Airline carrier (vendor) code Format (x-alpha/numeric): xxx Special Format: Left justified, blank filled Examples: UA CO How is null data specified? Character blanks What does null data indicate? No data results in error

Numeric

Description of Field:
Flight number
Format (n-numeric):
nnnn
Special Format:
Right justified, zero filled
Examples:
0001
0010
0430
6743
How is null data specified?
0
What does null data indicate?
No data results in error

<OpSuf>

Alpha

Reserved - Currently ignored

Alphanumeric

Description of Field:
Airport code of customer embarkation
Format (a-alpha):
Aaaaa
Special Format:
Left justified, blank filled
Examples:
MCI
OMA
How is null data specified?
Character blanks
What does null data indicate?
No data results in error

Alphanumeric

Description of Field:
Airport code of customer's destination
Format (a-alpha):
aaaaa
Special Format:
Left justified, blank filled
Examples:
COS
DFW
How is null data specified?
Character blanks
What does null data indicate?
No data results in error

Numeric

Description of Field:
Departure date of segment
Format (n-numeric):
Nnnnnnnn
Special Format:
YYYYMMDD
For general timetable this holds the effective date.
How is null data specified?
Zero filled
What does null data indicate?
No data results in error

+ <CustNameInfo>

BP04 1.0

Alpha

Blank = Standard name
I = Infant name
G = Group / corporate name

Alpha

To End

The name to be used in the index search. The first character of the last name is mandatory. The first name is optional and must follow the last name delimited by a slash /
Examples:
S = all last names beginning with S
SMITH = all last names beginning with Smith
SMITH/JOHN = all John Smiths

BP05 1.0

+ <RequiredData>

BP06 1.0

+ <PNRDataIDAry>

Array

n/a

Alphanumeric

PNR Data Identifier:
Identifies a specific type of PNR data to be displayed in the response.
If all PNR data available is required, this KLR should not be used.

Possible Values (List):
HL = Header lines
GI = General information
PN = Postscript note
NM = Names (includes name remarks)
FF = Frequent flyer numbers
PH = Phones
TA = Ticketing arrangement
FP = Form of payment
AS = Street address
AD = Delivery address
I = All itinerary segments
I1 = Air segments (includes open air segments)
I2 = Hotel segments
I3 = Car segments
I4 = Non-air segments
I5 = Due/paid/text segments
I6 = Flygtaxi segments
I7 = Leisureshopper segments
I8 = ARNK segments
RA = Associated itinerary remarks
RU = Unassociated itinerary remarks
ST = All seat data
SO = OSIs
SR = SSRs
CI = Customer ID
CF = Profile/Clientfile associations
CC = Custom check rules
RG = General remarks
VR = Vendor record locators
RV = Vendor remarks
RI = Associated / unassociated itinerary remarks
QM = Queue minders
DI = Document invoice/itinerary remarks
UD = Global PNR Untranslatable Data
NR = Name Related Data
UF = United Field Data
DS = Data Store Associations
EM = Email
CO = Corporate ID
GD = GIDS Data (Galileo Integrated Data Source)
TK = ETicket Data on Apollo (BP43)
MB = Multi-byte data (BP44)

+ <RefundAcceptMods>

4086 1.1

+ <VirtualLinkage>

DP56 1.0

Alpha

Description of Field:
Type of Virtual Linkage Transaction processing requested.
Format (a-alpha):
aaa
Special Format:
No special Format
Possible Values (List or Range):
VDP - Virtual Document Production
VIN - Virtual Invoice Number
VSD - Virtual Support Document
CVD - Conditional Virtual Document Production
VIS - Virtual Invoice and Virtual Support Documents
REA - Real Linkage Required
NLN - No Linkage Needed
How is null data specified?
No data results in error
What does null data indicate?
No data results in error

+ <CommissionPen>

DPCP 1.0

Numeric

Description of Field:
Passenger relation key

Format (n-numeric):
nnnn

Special Format:
N/A

Examples:
0000

How is null data specified?
N/A

What does null data indicate?
No data results in error.

<Amt>

Character

Description of Field:
Commission penalty amount. May contain decimal.

Format (a-alpha):
aaaaaaaaaaaa

Special Format:
Right justified, zero filled.

Examples:
000002378.50

How is null data specified?
Null data is specified by Zeros.

What does null data indicate?
Zero indicates no penalty has been levied on commission.

Character

Description of Field:
Commission penalty as percentage.

Format (a-alpha):
aaaaa

Special Format:
Character Blanks, if does not exist.

Examples:

How is null data specified?
Null data is specified by Character Blanks.

What does null data indicate?
Character Blanks indicate no penalty is charged or amount is charged.

+ <CreditCardFOP>

DPP0 1.0

<ID>

Numeric

Field Description:
Form of Payment type number
Format (n-numeric):
nn
Possible Values (List)
06 - Credit Card
10 - Debit Card
Special Format:
Right justified.

Examples:
06
How is null data specified?
N/A
What does null data indicate?
Task dependant, for 'some' tasks, no data results in error

<Type>

Numeric

Field Description:
Form of payment type
Format (n-numeric):
n
Possible Values (List)
1 - Credit type form of payment
2 - Cash type form of payment
Special Format:
N/A
Examples:
1
How is null data specified?
N/A
What does null data indicate?
Task dependant, for 'some' tasks, no data results in error

Alpha

Field Description:
Currency code of amount paid with FOP
Format (a-alpha):
aaa
Special Format:
Blank Filled.
Examples:
USD (U.S. Dollars)
CAD (Canadian Dollars)
EUR (Euros)
How is null data specified?
Blanks
What does null data indicate?
Task dependant, for 'some' tasks, no data results in error

<Amt>

Numeric

Field Description:
Amount paid with FOP (if not entered then zeroes)
Format (n-numeric):
nnnnnnnnnnnn
Possible Values (List)
000000000000 - 999999999999
Special Format:
Right justified, zero filled.
Examples:
000788392223
How is null data specified?
Zero
What does null data indicate?
Task dependant, for 'some' tasks, no data results in error

<ExpDt>

Numeric

Field Description:
Credit Card Expiration Date
Format (n-numeric):
nnnn (MMYY)
Special Format:
MMYY
Examples:
0505
How is null data specified?
Blanks
What does null data indicate?
Task dependant, for 'some' tasks, no data results in error

Numeric

Field Description:
Credit Transaction Type (If not entered then blanks)
Format (n-numeric):
n
Possible Values (List)
1 - Signature on File
2 - Telephone Order
Special Format:
Blank filled.
Examples:
2
How is null data specified?
Zero or Blanks
What does null data indicate?
When null (blanks) then this field is not applicable

Alpha

Field Description:
Outbound only. If source of approval unknown, field is blank.
Format (a-alpha):
a
Possible Values (List):
M - manual,
A - system generated
Character Blank - source of approval unknown.
Special Format:
N/A
Examples:
M
How is null data specified?
Blanks
What does null data indicate?
Task dependant, for 'some' tasks, no data results in error

Alpha

Field Description:
Credit Card Acceptance Override (CAO). CAO is Apollo only.
Possible Values (List):
Y - Credit Card acceptance override applies.
Format (a-alpha):
a
Special Format:
N/A
Examples:
Blank
How is null data specified?
Blanks
What does null data indicate?
When null (blanks) then this field is not applicable

Alpha

Field Description:
Credit Card Validation Bypass requested
Possible Values (List):
Y - Do not validate Credit Card with vendor
N - Validate Credit Card with Vendor.
Format (a-alpha):
a
Special Format:
If 'Y' you must enter the *A Authorization code in the Additional Info Array, in ID number 1 - Credit Card Approval Code.
Examples:
Y
How is null data specified?
Blanks - Defaults to 'N'
What does null data indicate?
When null (blanks) then this field is not applicable

<Vnd>

Alpha

Field Description:
Credit card Vendor alpha code
Format (a-alpha):
aa
Special Format:
Left justified, blank filled.
Examples:
AX
VI
CA
JC
TP
DC
How is null data specified?
N/A
What does null data indicate?
Task dependant, for 'some' tasks, no data results in error

<Acct>

Numeric

Field Description:
Credit Card Number
Format (n-numeric):
nnnnnnnnnnnnnnnnnnnn
Special Format:
Right justified, Zero filled.
Examples:
00000371019534732004
How is null data specified?
N/A
What does null data indicate?
No data results in error

+ <AdditionalInfoAry>

Array

n/a

+ <AdditionalInfo>

FieldSet

n/a

<ID>

Numeric

Field Description:
Card Additional Data Indicator.

Format (n-numeric):
n

Possible Values (List):
1 - Credit Card Approval code (8 alphanumeric)
2 - Card Holder (29 alpha with special chars)
3 - Order number - South Africa only (29 alphanumeric)
4 - Card Identification Code as used by
=> AMEX (4 numeric) on 1V and
=> AMEX (4 numeric) on 1G
=> CA (3 numeric) on 1G
=> DC (3 numeric) on 1G
=> VI (3 numeric) on 1G
=> DS (3 numeric) on 1G
5 - Extended payment option, format depending on credit card vendor (4 alphanumeric)
6 - Customer reference (29 alphanumeric)
8 - OB Fee Charged

Special Format:
N/A

Examples:
1

How is null data specified?
N/A

What does null data indicate?
No data results in error

<Dt>

Alphanumeric

Field Description:
Additional Data.
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
Left justified, blank filled.
Examples:
A1234 (24 blanks)
512 (26 blanks)
How is null data specified?
N/A
What does null data indicate?
No data results in error

+ <CheckFOP>

DPP1 1.0

<ID>

Numeric

Field Description:
Form of Payment id -Cheque
Format (n-numeric):
nn
Special Format:
N/A
Possible Values (List or Range):
02- Cheque
Examples:
02
How is null data specified?
N/A
What does null data indicate?
No data results in error

<Type>

Numeric

Field Description:
Form of Payment Type
Format (n-numeric):
n
Special Format:
Zero, if not entered.
Possible Values (List):
1 - Credit type form of payment
2 - Cash type form of payment
Examples:
2
How is null data specified?
N/A
What does null data indicate?
No data results in error.

Alpha

Field Description:
Currency code of amount paid with FOP
Format (a-alpha):
aaa
Special Format:
Left justified, Character Blank filled.
Examples:
USD
How is null data specified?
N/A
What does null data indicate?
No data results in error.

<Amt>

Numeric

Field Description:
Amount paid with FOP
Format (n-numeric):
nnnnnnnnnnnn
Special Format:
Zero, if not entered.
Right justified, zero filled
Examples:
000000064578
How is null data specified?
Null data is specified as zero.
What does null data indicate?
If not entered then field is populated with zeroes.

+ <AdditionalInfoAry>

Array

n/a

+ <AdditionalInfo>

FieldSet

n/a

<ID>

Numeric

Field Description:
Additional Data indicator

Format (n-numeric):
n

Special Format:
Left justified, blank filled.

Possible Values (List):
1 - Micron number
2 - Bank (sort) code
3 - Cheque number
4 - Drawee name
5 - Holder name
6 - Free form text
8 - Ob Fee charged

Examples:
4

How is null data specified?
N/A

What does null data indicate?
No data results in error.

<Dt>

Alphanumeric

Field Description:
Additional Data based on the indicator selected in Additional Data Ind field.
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
Left justified, Character Blank filled.
Examples:
How is null data specified?
N/A
What does null data indicate?
No data results in error.

+ <OtherFOP>

DPP9 2.0

<FOPID>

Numeric

Description of Field:
Form of Payment identification number
Format (n-numeric):
nn
Possible Values (List or Range):
01 - Cash
03 - Nonref
04 - Miscellaneous
05 - Invoice
07 - Government (Travel) Request
08 - Pseudo Cash
09 - Credit (non Credit Card)
11 - AK Bons
12 - Pay Late
13 - Exchange
14 - Money Order
15 - Travelers Check
16 - Special Government Transportation Request
17 - Multiple Receivable
18 - Certificate (CERT for UA)
99 - Freeform etc.
Special Format:
Right justified, zero filled
Example:
07
How is null data specified?
N/A
What does null data indicate?
No data results in error

<Type>

Numeric

Description of Field:
Form of payment type
Format (n-numeric):
n
Possible Values (List or Range):
1 - Credit type form of payment
2 - Cash type form of payment
Special Format:
Right justified, zero filled
Example:
0
1
How is null data specified?
0
What does null data indicate?
Zero indicates null data.

Alpha

Description of Field:
Currency code of amount paid with FOP
Format (a-alpha):
aaa
Special Format:
Left justified, blank filled.
Example:
3 Blanks
USD (U.S. Dollars)
CAD (Canadian Dollars)
EUR (Euros)
How is null data specified?
N/A
What does null data indicate?
No data result in error.

<Amt>

Numeric

Description of Field:
Amount paid with FOP
Format (n-numeric):
nnnnnnnnnnnn
Possible Values (Range):
000000000000 - 999999999999
Special Format:
Right justified, zero filled
Example:
000787822122
How is null data specified?
0
What does null data indicate?
If not entered then field is populated with zeroes

+ <AddlDataIDAry>

Array

n/a

+ <AddlDataID>

FieldSet

n/a

<ID>

Numeric

Description of Field:
Additional data indicator

Format (n-numeric):
n

Possible Values (List):
2 - Money Order / Travelers Check number
3 - Government request id
4 - Freeform text
5 - Invoice number
6 - Certificate number
7 - Exchange EMDRB indicator
8 - OB Fee Charged
9 - Exchange Ticket Number

Example:
3

How is null data specified?
N/A

What does null data indicate?
No data results in error

<Dt>

Alphanumeric

Description of Field:
Additional data
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
Left justified, blank filled.
Example:
AD2311112 (20 blanks)
How is null data specified?
N/A
What does null data indicate?
No data results in error

+ <RefundData>

DPRR 1.0

Character

Description of Field:
Passenger Relation Key.

Format (a-alpha):
aaaa

Special Format:
N/A

Examples:
0000

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Alphanumeric

Description of Field:
Currency of Total Refund.

Format (x-alpha/numeric):
xxx

Special Format:
N/A

Examples:
USD

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Numeric

Description of Field:
Total amount of refund due.

Format (n-numeric):
nnnnnnnnnnn

Special Format:
Right justified, zero filled.

Examples:
00000000120

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Numeric

Description of Field:
Number of decimal places for Total Refund Amount

Format (n-numeric):
n

Special Format:
N/A

Examples:
2

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Character

Description of Field:
Total refund sign.

Format (c-character):
C

Special Format:
N/A

Possible Values (List or Range):
Character Blank = Positive
'-' = Negative

Examples:
-

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Alphanumeric

Description of Field:
Currency of Base fare amount to be refunded

Format (x-alpha/numeric):
xxx

Special Format:
N/A

Examples:
USD
GBP

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Numeric

Description of Field:
Base fare amount to be refunded - Negative amount

Format (n-numeric):
nnnnnnnnnnn

Special Format:
Right justified, zero filled.

Examples:
00000002200

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Numeric

Description of Field:
Number of decimal places for Refund Fare Amount

Format (n-numeric):
n

Special Format:
N/A

Examples:
0

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Character

Description of Field:
Refund sign

Format (c- character):
C

Special Format:
N/A

Possible Values (List or Range):
Character Blank - Positive
'-' - Negative

Examples:
Character Blank

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Alphanumeric

Description of Field:
Refund Tax Currency code

Format (x-alpha/numeric):
xxx

Special Format:
N/A

Examples:
USD

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Numeric

Description of Field:
Total Tax to be refunded - Negative amount

Format (n-numeric):
nnnnnnnnnnn

Special Format:
Right justified, zero filled.

Examples:
00000001200

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Numeric

Description of Field:
Number of decimal places for Refund Tax Amount

Format (n-numeric):
n

Special Format:
N/A

Examples:
0

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Character

Description of Field:
Refund tax sign

Format (c - character):
C

Special Format:
N/A

Possible Values (List or Range):
Character Blank - Positive
'-' - Negative

Examples:
Character Blank

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Alphanumeric

Description of Field:
Penalty Fee Currency code

Format (x-alpha/numeric):
xx

Special Format:
N/A

Examples:
USD

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Numeric

Description of Field:
Penalty Amount for Refund. Always a positive amount

Format (n-numeric):
nnnnnnnnnnn

Special Format:
Right justified, zero filled.

Examples:
00000000150

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Numeric

Description of Field:
Number of decimal places for Penalty Fee Amount

Format (n - numeric):
n

Special Format:
N/A

Examples:
2

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Numeric

Description of Field:
Total amount of Taxes in following array

Format (n - numeric):
nnnnnnnnnnn

Special Format:
Right justified, zero filled.

Examples:
00000000200

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Numeric

Description of Field:
Number of decimal places for Total Taxes Amount

Format (n-numeric):
n

Special Format:
N/A

Examples:
2

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Character

Description of Field:
Total of taxes sign

Format (c - character):
C

Special Format:
N/A

Possible Values (List or Range):
Character Blank - Positive
'-' - Negative

Examples:
-

How is null data specified?
N/A

What does null data indicate?
No data results in error.

TaxDataCnt
Structured data only.
Not in XML.

Numeric

Description of Field:
Number of tax fields

Format (n - numeric):
nn

Special Format:
Right justified, zero filled
Zero, if does not exist

Examples:

How is null data specified?
N/A

What does null data indicate?
No data results in error.

+ <TaxDataAry>

Array

n/a

+ <TaxData>

FieldSet

n/a

Alphanumeric

Description of Field:
Country Code.
(Country code or airport code must exist)

Format (x-alpha/numeric):
xx

Special Format:
N/A

Examples:
ZP

How is null data specified?
N/A

What does null data indicate?
No data results in error.

<Airp>

Alphanumeric

Description of Field:
Airport Code
(Country code or airport code must exist)

Format (x-alpha/numeric):
xxx

Special Format:
N/A

Examples:

How is null data specified?
N/A

What does null data indicate?
No data results in error.

<Amt>

Numeric

Description of Field:
Tax Amount

Format (n-numeric):
nnnnnnnnnnn

Special Format:
Right justified, zero filled.

Examples:
00000000200

How is null data specified?
N/A

What does null data indicate?
No data results in error.

Character

Description of Field:
Tax Sign

Format (c-character):
C

Special Format:
N/A

Possible Values (List or Range):
Character Blank - Positive
'-' - Negative

Examples:
-

How is null data specified?
N/A

What does null data indicate?
No data results in error.

+ <TicketNumber>

DPT1 1.0

Numeric

Description of Field:
Primary Ticket Number
Format (n - numeric):
nnnnnnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
0167100004000
How is null data specified?
N/A
What does null data indicate?
No data results in error.

+ <ExchangeAcceptMods>

4088 1.3

+ <CommissionMod>

DP10 2.0

<Amt>

Alphanumeric

Field Description:
Amount, including decimal places if required.

Format (x-alpha/numeric):
xxxxxxxxxxxx

Special Format:
Left justified, blank filled.

Examples:
10
10.00

How is null data specified?
N/A

What does null data indicate?
No data results in no error

Alphanumeric

Field Description:
Percentage, including decimal places if required. Can be entered with Capped Amount.

Format (x-alpha/numeric):
xxxxx

Special Format:
Left justified, blank filled.

Examples:
5
5.00

How is null data specified?
N/A

What does null data indicate?
No data results in no error

Alphanumeric

Field Description:
Capped Amount (1G only). Can be entered with Commission Percentage

Format (x-alpha/numeric):
xxxxxxxxxxxx

Special Format:
Left justified, blank filled.

Examples:
10
10.00

How is null data specified?
N/A

What does null data indicate?
No data results in no error

+ <BaggageAllowance>

DP22 1.0

+ <SegNumAry>

Array

n/a

+ <SegNumInfo>

FieldSet

n/a

Numeric

Field Description:
Segment number of the itinerary item to which this KLR relates (0 = no segment select)

Format (x-alpha/numeric):
nnn

Special Format:
Right justified, zero filled.

How is null data specified?
N/A

What does null data indicate?
No data results in error

Numeric

Field Description:
Number or weight of bags
Up to 3 numerics, 1-999

Format (x-alpha/numeric):
nnn

Special Format:
Right justified, zero filled.

How is null data specified?
N/A

What does null data indicate?
No data results in error

Alpha

Field Description:
Allowance type:
'P' = pieces (count must be 1-99)
'K' = Kilos (count must be 1-99)
'L' = Pounds (count must be 1-99)
' ' = other (count must be 1-999)

Format (x-alpha/numeric):
a

Special Format:
na

How is null data specified?
N/A

What does null data indicate?
No data results in error

Processing notes
- Overrides the global fares allowance.
- Only 3 characters of baggage allowance will print on the ticket.
- Will print in the ALLOW box of each flight coupon.
- Modifier can be varied by segment
- Delimiter between segments is a colon (:), delimiter between segment number and segments data is a lozenge (@), delimiter between GBG and GTD is an end item (|).
- GBG and GTD undergo similar editing because they can be segment related but they are NOT related to each other in any way.

+ <TicketDesignator>

DP23 1.0

+ <SegNumAry>

Array

n/a

+ <SegNumInfo>

FieldSet

n/a

Numeric

Description of Field:
Segment number of the itinerary item to which this KLR relates (0 = no segment select)

Format (x-alpha/numeric):
nnn

Special Format:
Right justified, zero filled.

How is null data specified?
N/A

What does null data indicate?
No data results in error

Alphanumeric

Description of Field:
Ticket Designator

Format (x-alpha/numeric):
xxxxxxxxxxxxxxx

Special Format:
left justified, blank filled.

Example:
12345678aaasd(blank)(blank)

How is null data specified?
N/A

What does null data indicate?
No data results in error

Processing notes
- Will apply ticket designator to all segments. Will print only 6 characters
- Can be varied by segment
- Delimiter between segments is a colon (:), delimiter between segment number and segments data is a lozenge (@), delimiter between GBG and GTD is an end item (|).
- GBG and GTD undergo similar editing because they can be segment related but they are NOT related to each other in any way.

+ <TicketValidity>

DP24 1.0

<Ind>

Alpha

Description of Field:
Identify the date field as Not Valid After (NWA) or Not Valid Before (NWB).

Format (a-alpha):
a

Possible Values (List):
'B' - Not Valid Before (NWB)
'A' - Not Valid After (NWA)

How is null data specified?
N/A

What does null data indicate?
No data results in error

+ <SegNumAry>

Array

n/a

+ <SegNumInfo>

FieldSet

n/a

Numeric

Description of Field:
Segment number of the itinerary item to which this KLR relates (0 = no segment select)

Format (n-numeric):
nnn

Special Format:
Right justified, zero filled.

How is null data specified?
N/A

What does null data indicate?
No data results in error

<NVBDt>

Alphanumeric

Description of Field:
Date in DDMMM format

Format (x-alpha/numeric):
xxxxx

Special Format:
DDMMM

Example:
03JUN

How is null data specified?
N/A

What does null data indicate?
No data results in error

Processing Notes:
-     May be used independently or together
-     Will default to the entire itinerary with other modifiers
-     May be used in conjunction with the ATFQ, Pricing Record or ticketing entry
-     May be deleted or modified from the ATFQ line
-     NVB/NVA dates will not be compared against one another.
-     NVB/NVA dates will use the same date routine as the Pricing Record.
-     No date analysis will be made against the itinerary.
-     Dates entered with these modifiers will override those dates supplied by GlobalFares on outputs only.(The Linear Fare Data (*LF) section of the PNR created by Fare Quote will reflect true GlobalFares data).
-     When the NVB/NVA modifiers are used as part of the Pricing Record build entry, the data will become unchangeable within the Pricing Record Fill-in screen ($NME).
-     Modifier input hierarchy will remain the same (the HB entry will override the ATFQ, the ATFQ will override the PNR field).
-     Pricing/Fare Construction Indicator (FCI): If the system is going to output a pricing code of "0", it will check to see if an NVA/NVB modifier is used; if so, the system will change the pricing code to "5" for agency issued tickets and "2" for United Airlines issued tickets
-     OPTAT/TAT: When the NVB/NVA modifiers are used, dates will print in the current fields/boxes.
-     ATB: When the NVB/NVA modifiers are used, dates will print in the current NVB/NVA fields/boxes on the flight coupon and the Post Audit document.
-     MIR: These modifiers will output in current MIR 2 Labels.
NVB - Fare Basis Section, Label A08NVBC, 7 bytes alphanumeric (DDMMMYY)
NVA - Fare Basis Section, Label A08NVAC, 7 bytes alphanumeric (DDMMMYY)
The Pricing/Fare Construction Indicator is part of the Transaction Number in Passenger Data Section, Label A02TRN

+ <EndorsementBox>

DP27 1.0

Alphanumeric

Description of Field:
First endorsement box, free form text

Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Special Format:
Left justified, blank filled
Words can be separated by an @ on 1V and a blank on 1G

Examples:
NON@REFUNDABLE

How is null data specified?
N/A

What does null data indicate?
No data results in error

Alphanumeric

Description of Field:
Second endorsement box, free form text

Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Special Format:
Left justified, blank filled
Words can be separated by an @ on 1V and a blank on 1G

Examples:
NON@REFUNDABLE

How is null data specified?
N/A

What does null data indicate?
No data results in error

Alphanumeric

Description of Field:
Third endorsement box, free form text

Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Special Format:
Left justified, blank filled
Words can be separated by an @ on 1V and a blank on 1G

Examples:
NON@REFUNDABLE

How is null data specified?
N/A

What does null data indicate?
No data results in error

+ <TourCode>

DP33 1.0

<Rules>

Alphanumeric

To End

Field Description:
1V rules: 1-15 characters, which will print on the ticket.

1G rules: 1-14 characters (except Saudi TAT which allows 1-10)

Format (x-alpha/numeric):
xxxxxxxxxxxxxx - 1G
xxxxxxxxxxxxxxx - 1V

Special Format:
Left Justified. Blank filled.
1V:
Special character pillow (@) appears as blank space.
An asterisk(*) will appear as a slash
A hyphen (-) is allowed and is unchanged

Examples:
E12SIN4
SHELL23CX

How is null data specified?
N/A

What does null data indicate?
No data results in error.

+ <DocumentSelect>

DP42 2.0

Alpha

Description of Field:
Specifies Ticket Only option

Format (a-alpha)
a

Examples:
Set to 'Y' if user wishes to alter the system default of producing a ticket, itin and MIR. Setting this will inhibit itin and MIR, unless these have also been specifically requested (Terminal Equivalent: DTD)

<ETInd>

Alpha

Description of Field:
Specifies Electronic Ticket Only option

Format (a-alpha)
A

Examples:
Set to 'Y' if an Electronic Ticket is required (Terminal Equivalent: DLD, ET)
Set to 'P' if Paper Ticket is required (Terminal Equivalent: PT)

How is null data specified?
Character blanks

What does null data indicate?
Leave blank for system to determine type

Alphanumeric

Description of Field:
Specifies the number of ATB (Automated Ticket and Boarding passes) Post-Audit Coupons ticket option

Format (a-alpha)
A

Special Format:
Setting this field to zero will generate 'GA0'.
Use a blank if you do not want this modifier generated

NOTE: If this field is set, then the next optional field (host/satellite) can also be set.

Examples:
2
Number of coupons (system defaults to 1) (max = 3)
(Terminal Equivalent: GA - 1V only)

How is null data specified?
Character blanks

What does null data indicate?
Leave blank for system default.

Alpha

Description of Field:
Specifies an ATB Post-Audit Destination ticket option

Format (a-alpha)
A

Example:
Destination for coupons:
'H' - Home
'S' - Satellite
(optional - related to number of Post Audit Coupons)

Alpha

Description of Field:
Specifies a Force Audit Coupon ticket option

Format (a-alpha)
A

Example:
Set to 'A' to print an ATB Audit Coupon and override normal BSP setting. (Terminal Equivalent: 1G only - AU modifier)

Alpha

Description of Field:
Specifies Machine Interface Record (MIR) Only ticket option

Format (a-alpha)
A

Examples:
Six valid settings:
'A' - Accounting MIR (Terminal Equivalent: DBD - 1V only)
'N' - Non-Accounting MIR (Terminal Equivalent: DAD)
'R' - Non-Accounting Remote MIR (requires GTID/CRS and PCC to be populated: see below) (Terminal Equivalent: DND)
'F' - Non-Faring Remote MIR (requires GTID/CRS and PCC to be populated: see below) (Terminal Equivalent: DJD - 1V only)
'X' - Dual MIR. Issues a ticket, itinerary, a two ticketing MIRs - to the MIR device to which the CRT is physically linked, and a copy of that MIR to the MIR device specified in the following fields (DXD)

Special Format:
If one of these options is set (except for 'X'), the system default of producing a ticket, itin and MIR will be overridden. Setting this will inhibit ticket and itin, unless these have also been specifically requested.

<Locn>

Alphanumeric

Description of Field:
Specifies the Location for data from the MIR only option field.

Format (a-alpha)
A

Special Format:
Required if option 'R', 'G', 'F', or 'X' is selected in MIR Only field. Populated with either the destination GTID (LNIATA - Line Number Interchange Address Terminal Address) for MIRs within the same system, or CRS name (1G or 1V) for MIRs to another system.

<PCC>

Alphanumeric

Description of Field:
Pseudo City Code.

Format (x-alpha/numeric:
XXXX

Special Format:
Left Justified Blank Filled
PCCs with less than 4 characters should be padded with a leading zero. For example, X0B should be submitted as 0X0B.

CDATA can also be used to override the attributes of this field. For example,
![CDATA[ X0B]] In this case the field is forced to right justify with a leading blank.

Examples:
1WP7
0X0B
![CDATA[ X0B]]
![CDATA[2GK5]]

How is null data specified?
Character blanks

What does null data indicate?
No user data was input.

Alpha

Description of Field:
Specifies the Itinerary or Invoice type option for the ticket.

Format (a-alpha)
a

Examples:
'I' - normal itin/invoice (Terminal Equivalent: DID)
'P' - Pocket itin (ticketing only) (Terminal Equivalent: DPD - 1V only)

Alpha

Description of Field:
Specifies the Itinerary or Invoice fax type option for the ticket.

Format (a-alpha)
a

Examples:
'X' - FAX - Can store the Fax modifier (Terminal Equivalent: GFX) or can use with ticketing.
'D' - Itin FAX - can't be stored, can use with ticketing only (Terminal Equivalent: DFX).
(Terminal Equivalent: 1V only - DFX/GFX)

Alpha

Description of Field:
Specifies the Itinerary or Invoice type options for the ticket.

Format (a-alpha)
a

Examples:
'F' - itin with no fare information (Terminal Equivalent: GIF/DCD)
'A' - itin with no amounts (Terminal Equivalent: GIN, IN)
'D' - itin, but do not decrement invoice numbers (Terminal Equivalent: GID 1V only)

Alpha

Description of Field:
Specifies whether there are separate itineraries.

Format (a-alpha)
a

Examples:
Y
N

Note:
If set to 'Y', one itinerary will be printed per passenger (Terminal Equivalent: GIS/ IS)

Alphanumeric

Description of Field:
Number of pocket itineraries for ATB (Terminal Equivalent: GP - 1V only).
A pocket itinerary is an option to print a passenger itinerary together with associated information on pocket itinerary stock. The data printed is identical to full length documents.

Format (a-alpha)
a

Special Format:
Setting this field to zero will generate 'GP0', use a blank if you do not want this modifier generated

If this field is set, then the next optional field (host/satellite) can also be set.

How is null data specified?
Character blanks

What does null data indicate?
System default.

Alpha

Description of Field:
Destination for Pocket Itineraries

Format (a-alpha)
A

Special Format:
(optional - related to number of Pocket Itineraries)

Examples:
'H' - Home
'S' - Satellite

Alpha

Description of Field:
Specifies the Delivery Documents

Format (a-alpha)
A

Example:
'D' - select delivery documents (Terminal Equivalent: DDD - 1V only)
NOTE: Not valid with any D modifier except DPD, GA, GB, GBN, GFX, GT, GF, GFP, GID, GUSD, GCAD, GIN, GIS

PROCESSING NOTES:
ATB only.

Open to buy not down dated.

The printer 'firmware' (pectab) must be one of the following:
2200 - version 08
2800 - version 05, 07, 08

An error response will be displayed if the agency is using a 2200 printer with firmware versions 04 or 07

Requires Delivery (D-) field in PNR.

FOP is not required on the DDD modifier

Does not go to fare quote.

DP44 1.0

+ <WaitlistSegSelect>

DP45 1.0

+ <SegNumAry>

Array

n/a

Numeric

Field Description:
Segment number of the itinerary item to which this KLR relates.

Format (n-numeric):
nnn

Special Format:
Right justified, zero filled.

Examples:
000
001
002

How is null data specified?
N/A

What does null data indicate?
No data results in error.

+ <AuxSegSelect>

DP46 1.0

+ <SegNumAry>

Array

n/a

Alphanumeric

Field Description:
Segment number of the itinerary item to which this KLR relates.

Format (x-alpha/numeric):
xxx

Special Format:
Right justified, blank filled.

Examples:
ALL
003

How is null data specified?
N/A

What does null data indicate?
N/A

+ <VirtualLinkage>

DP56 1.0

Alpha

+ <ServiceFees>

DP57 1.0

Numeric

Description of Field:
Service Fee document Number.
Format (a-alpha, n-numeric, x-alphanumeric, b-character blank):
Numeric
Special Format:
None
List of Possible Values:
1231234567890
How is null data specified?
N/A
What does null data indicate?
No data results in ERROR

<PCC>

Alphanumeric

Description of Field:
Pseudo City Code
Format (a-alpha, n-numeric, x-alphanumeric, b-character blank):
Alpha Numeric
Special Format:
Left Justified Blank field
List of Possible Values:
X6H
K29
How is null data specified?
BLANK
What does null data indicate?
No data means use the same Pseudo City Code

Alphanumeric

Description of Field:
Service Fee Issue Date.
Format (a-alpha, n-numeric, x-alphanumeric, b-character blank):
Alpha Numeric
Special Format:
DDMMMYYYY
List of Possible Values:
12JAN2009
How is null data specified?
BLANK
What does null data indicate?
No data means the current Date

DP58 1.0

+ <CommissionPen>

DPCP 1.0

Numeric

Description of Field:
Passenger relation key

Format (n-numeric):
nnnn

Special Format:
N/A

Examples:
0000

How is null data specified?
N/A

What does null data indicate?
No data results in error.

<Amt>

Character

Character

DPMD 1.0

+ <CreditCardFOP>

DPP0 1.0

<ID>

Numeric

<Type>

Numeric

Alpha

<Amt>

Numeric

<ExpDt>

Numeric

Numeric

Alpha

Alpha

Alpha

<Vnd>

Alpha

<Acct>

Numeric

+ <AdditionalInfoAry>

Array

n/a

+ <AdditionalInfo>

FieldSet

n/a

<ID>

Numeric

<Dt>

Alphanumeric

+ <CheckFOP>

DPP1 1.0

<ID>

Numeric

<Type>

Numeric

Alpha

<Amt>

Numeric

+ <AdditionalInfoAry>

Array

n/a

+ <AdditionalInfo>

FieldSet

n/a

<ID>

Numeric

<Dt>

Alphanumeric

+ <OtherFOP>

DPP9 2.0

<FOPID>

Numeric

<Type>

Numeric

Alpha

<Amt>

Numeric

+ <AddlDataIDAry>

Array

n/a

+ <AddlDataID>

FieldSet

n/a

<ID>

Numeric

<Dt>

Alphanumeric

+ <TicketNumber>

DPT1 1.0

Numeric

+ <ExchangeData>

DPXD 1.0

Alpha

Description of Field:
Passenger relation key
Format (a - alpha):
aaaa
Special Format:
N/A
Examples:
0001
How is null data specified?
N/A
What does null data indicate?
No data results in error.

Alphanumeric

Description of Field:
Currency of Total Adcol/Refund
Format (x -alpha/numeric):
xxx
Special Format:
N/A.
Examples:
USD
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Numeric

Description of Field:
Total amount of add collect/refund due of the exchange. (Collected Fare Amount + Collected Tax Amount + Change Fee + Forfeit Amount)
Format (n - numeric):
nnnnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
00000001350
How is null data specified?
N/A
What does null data indicate?
No data results in error.

Numeric

Description of Field:
Number of decimal places for Total Exchange Amount
Format (n - numeric):
n
Special Format:
N/A
Examples:
2
How is null data specified?
N/A
What does null data indicate?
No data results in error.

Alpha

Description of Field:
Total Exchange Amount Sign
Format (a - alpha):
a
Special Format:
N/A
Possible Values (List or Range):
Character Blank - Positive
- - Negative
Examples:
Character Blank
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Alphanumeric

Description of Field:
Currency of Total Fare
Format (x -alpha/numeric):
xxx
Special Format:
N/A
Examples:
USD
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Numeric

Description of Field:
Total reported fare amount for this exchange request (includes surcharges and any PFC absorption).
Format (n - numeric):
nnnnnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
00000001200
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Numeric

Description of Field:
Number of decimal places for Total Fare Amount
Format (n - numeric):
n
Special Format:
N/A
Examples:
2
How is null data specified?
N/A.

What does null data indicate?
No data results in error.

Alpha

Description of Field:
Total Fare Amount Sign
Format (a - alpha):
a
Special Format:
N/A
Possible Values (List or Range):
Character Blank - Positive
- - Negative
Examples:
Character Blank
How is null data specified?
N/A.

What does null data indicate?
No data results in error.

Alphanumeric

Description of Field:
Currency of total tax.
Format (x -alpha/numeric):
xxx
Special Format:
N/A
Examples:
USD
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Numeric

Description of Field:
The issued tax amount for this trip
Format (n - numeric):
nnnnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
00000000100
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Numeric

Description of Field:
Number of decimal places for Total Tax Amount
Format (n - numeric):
n
Special Format:
N/A
Examples:
2
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Alpha

Description of Field:
Total Tax Sign
Format (a - alpha):
a
Special Format:
N/A
Possible Values (List or Range):
Character Blank - Positive
- - Negative
Examples:
Character Blank
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Alphanumeric

Description of Field:
Collect fare amount currency code
Format (x -alpha/numeric):
xxx
Special Format:
N/A
Examples:
USD
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Numeric

Description of Field:
Total fare amount to be collected for this exchange request
Format (n - numeric):
nnnnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
00000000050
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Numeric

Description of Field:
Number of decimal places for Collected Fare Amount
Format (n - numeric):
n
Special Format:
N/A
Examples:
0
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Alpha

Description of Field:
Collected Fare Sign
Format (a - alpha):
a
Special Format:
N/A

Possible Values (List or Range):
Character Blank - if fare is collected
'-' - if fare is not collected.
Examples:
Character Blank
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Alphanumeric

Description of Field:
Collected Tax Currency code
Format (x -alpha/numeric):
xxx
Special Format:
N/A
Examples:
3 Character Blanks
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Numeric

Description of Field:
Collected Tax Amount - total tax amount to be collected.
Format (n - numeric):
nnnnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
00000000000
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Numeric

Description of Field:
Number of decimal places for Collected Tax Amount
Format (n - numeric):
n
Special Format:
N/A
Examples:
0
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Alpha

Description of Field:
Collected Tax Sign
Format (a - alpha):
a
Special Format:
N/A
Possible Values (List or Range):
Character Blank - Positive
- - Negative
Examples:
Character Blank
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Alphanumeric

Description of Field:
Change Fee Currency code
Format (x -alpha/numeric):
xxx
Special Format:
N/A
Examples:
USD
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Numeric

Description of Field:
Change Fee Amount - amount of the change fee that will apply when this ticket is booked using this fare. Always positive amount.
Format (n - numeric):
nnnnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
0000000010
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Numeric

Description of Field:
Number of decimal places for Change Fee Amount
Format (n - numeric):
n
Special Format:
N/A
Examples:
0
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Alphanumeric

Description of Field:
Forfeit Currency Code
Format (x -alpha/numeric):
xxx
Special Format:
N/A
Examples:
USD
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Numeric

Description of Field:
Forfeit Amount - non-refundable residual value.
Format (n - numeric):
nnnnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
00000000350
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Numeric

Description of Field:
Number of decimal places for Forfeit Amount
Format (n - numeric):
n
Special Format:
N/A
Examples:
0
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

Alpha

Description of Field:
Forfeit Amount Sign.
Format (a - alpha):
a
Special Format:
N/A
Possible Values (List or Range):
Character Blank - Positive
- - Negative
Examples:
-
How is null data specified?
N/A.
What does null data indicate?
No data results in error.

TaxDataCnt
Structured data only.
Not in XML.

Numeric

Description of Field:
Number of tax fields
Format (n - numeric):
nn
Special Format:
Right justified, zero filled
Zero, if does not exist
Examples:
How is null data specified?
N/A
What does null data indicate?
No data results in error.

+ <TaxAry>

Array

n/a

+ <TaxElement>

FieldSet

n/a

Alphanumeric

Description of Field:
Country Code.
(Country code or airport code must exist)
Format (x -alpha/numeric):
xx
Special Format:
N/A
Examples:
ZP
How is null data specified?
N/A
What does null data indicate?
No data results in error.

<Airp>

Alphanumeric

Description of Field:
Airport Code
(Country code or airport code must exist)
Format (x -alpha/numeric):
xxx
Special Format:
N/A
Examples:
How is null data specified?
N/A
What does null data indicate?
No data results in error.

<Amt>

Numeric

Description of Field:
Tax Amount
Format (n - numeric):
nnnnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
00000000200
How is null data specified?
N/A
What does null data indicate?
No data results in error.

Character

Description of Field:
Tax Sign
(tax sign indicates positive or negative tax amount)
Format (c - character):
C
Special Format:
N/A
Possible Values (List or Range):
Character Blank - Positive
'-' - Negative
Examples:
-
How is null data specified?
N/A
What does null data indicate?
No data results in error.