Docrefund - Initrefund 09.2: Technical Reference
Docrefund - Initrefund 09.2: Technical Reference
Docrefund - Initrefund 09.2: Technical Reference
Technical Reference
(Amadeus Proprietary and Confidential Information: unauthorized use and disclosure strictly forbidden. 2009 - Amadeus s.a.s - All Rights Reserved.)
Introduction
This document is the technical reference for an Amadeus functional interface. This reference is not directly
bundled to Amadeus Programming Interface development or any other development flavour. It is just a generic
description of the interface through all the services it publishes.
Structure hierarchy
* A service contains an input message and an output message.
* A query/reply structure contains a list of simple structures and a list of grouped structures.
* A grouped structure contains a list of simple structures and a list of grouped structures.
* A simple structure contains a list of data elements and grouped data elements.
* A data element can be coded, therefore a code list is described in a separate table.
Document structure
* Service overview.
* Query and output messages for the service, with their corresponding description.
* For each query/reply structure, a table describing its higher level entities of the query/reply structure.
* For each grouped or simple structure, a table describing the entities they are built with.
* For each coded entity, a table describing the possible coded values it can take.
Grouped structures introduces the 'level' concept within a structure. This level is reflected in the structure tables
via indentation.
Document navigation
The document uses internal links to quickly navigate between referenced entities and its corresponding
structure and substructures (if any).
Glossary of terms
Entity definition
Every entity in this document is defined by:
M* (Mandatory): This indicates that the status differs from the IATA PADIS Data Dictionary. If an entity is
defined as conditional in the IATA approved message but must be mandatory to complete a business function,
the entity will be indicated with an M for Mandatory along with an asterix (*).
Representation
Following table explains the meaning of possible representations for a leaf entity.
Representation Meaning
ax The entity is conveying a fix number(x) of alphabetic elements.
Table of contents
Operation: DocRefund_InitRefund.......................................................................................... 1
Query message .................................................................................................................. 2
Reply message ................................................................................................................... 3
Grouped structures .................................................................................................................4
Simple structures ....................................................................................................................7
Codesets .............................................................................................................................. 22
i
Amadeus Programming Interface
Operation: DocRefund_InitRefund.
freeTextInfo Free text information C 1 This segment is used to convey the error text.
ticketNumber Ticket number details M 1 the ticket number of the refundable documents,
inclusive of airline and check digit.
documentStatus Free text information M 1 Will contain the status of the document The status
can be one of the following : "CNF" :
CONFIRMED "PND" : CONFIRMED "CAN" :
CANCELLED "RFD" : REFUNDED "UNK" :
UNKNOWN
refundableDocument Group C 1
ruleId Reference information M 1 Convey the rule Id, client must used
to display the refund record
travellerPriorityInfo Traveller priority details C 1 Use for Staff: Staff number, Date of
Joining and Cost Center.
taxDetailsInformation Tax details C 198 List of refund taxes (up to 197 taxes
may be present+one paid tax
aggregate amount). Previously paid
aggregate sum of taxes must be
convey using the 701 tax category.
firstAndLastSegmentDates Structured period C 1 Conveys the date of the first and the
information last segment of the original coupons
inHouseIdentification1 In-house identification M* 1 an..9 Will be used to convey the Office ID.
errorCode Application error, coded M 1 an..5 Code identifying the data validation
error condition.. Codeset list: 9321
1A 02.1.219
textSubjectQualifier Text subject qualifier M 1 an..3 text Subject Qualifier. Codeset list:
4451 IA 02.2.543
issueIndicator Issue indicator C 1 an1 Issue indicator : 'F' --> First Issue 'R'
type Data type, coded M 1 an..3 To specify the type of data, i.e. staff
reservation entitlement, status, type of
travel, or ticket type. Codeset list:
9989 IA 02.2.68
locationFrom Place/location C 1 an..25 The From city for the carrier fee.
identification Codeset list: 3225 IA 02.2.3414
type Form of payment M 1 an..10 the type of the fop. Codeset list: 9888
identification IA 02.2.419
textSubjectQualifier Text subject qualifier M 1 an..3 Text subject qualifier.. Codeset list:
4451 IA 02.2.1519
issueIndicator Issue indicator C 1 an1 Issue indicator : 'F' --> First Issue 'R'
--> Reissue 'I' --> First issue of It 'Y'
--> Reissue of IT 'B' --> First issue of
BT 'W' --> Reissue of BT.
Codeset list: 906T 1A 02.1.96
type Duty/Tax fee type, M* 1 an..3 Tax code XT stands for extended
coded taxes.. Codeset list: 5153 IA 02.2.240
textSubjectQualifier Text subject qualifier M 1 an..3 Text subject qualifier.. Codeset list:
4451 IA 02.2.401
Structure: PRIORITY
Copyright 1987-2009 Amadeus IT Group SA
Page 20 of 52
Amadeus Programming Interface
Codesets
Value Description
STF Update Staff Profile Flag
Value Description
1 Invalid date
10 Invalid service type code
100 Invalid Place of Departure Code
101 Invalid Place of Destination Code
102 Invalid Departure Date
103 Invalid Departure Time
104 Invalid Reservation Booking Designator
105 Invalid Reservation Booking Modifier
106 Invalid Number of Inventory Adjustments
107 Invalid Airline Designator/Vendor Supplier
108 Invalid Place of Connection Code
109 Invalid Country Code
11 Invalid aircraft type coded
110 Invalid Source of Business
111 Invalid Agent's Code
112 Requestor Identification Required
113 Invalid Period of Operation
114 Invalid Flight Number
115 Invalid Arrival Date
116 Invalid Arrival Time
117 Schedule Change in Progress
118 System Unable to Process
119 Shuttle Flight Does Not Allow Reservation
12 Invalid product details qualifier coded
Value Description
EC Error Codes
WEC Warning code
WZZ Mutually defined warning
ZZZ Mutually defined
Codeset for Code list responsible agency, coded (Ref: 3055 IA 02.2.344)
Value Description
13 ICAO (International Civil Aviation Organization)
2 CEC (Commission of the European Communities)
3 IATA (International Air Transport Association)
5 ISO (International Organization of Standardization)
6 IATCI
ZZZ Mutually defined
Value Description
7CC Industry Car Rental Companies
7HH Industry Hotel Chains
Value Description
1 Unable ref to 3207 96.1 IA
ZZ Country code list
Value Description
No specific codeset defined for this data element.
Value Description
777 Neutral Unit of Construction
Value Description
777 Neutral Unit of Construction
Value Description
ZZZ Currency code list
Value Description
777 Neutral Unit of Construction
Value Description
777 Neutral Unit of Construction
Value Description
12 Not interlineable
13 Not refundable
14 Commissionable
15 Not commissionable
Value Description
FC1 Form of payment fee 1
FC2 Form of payment fee 2
FC3 Form of payment fee 3
FC4 Form of payment fee 4
FC6 Form of payment fee 6
FCA Form of payment Credit Card fee
OLD Old total amount of paid fee
R01 Requested service fee 1
R02 Requested service fee 2
R03 Requested service fee 3
R04 Requested service fee 4
R05 Requested service fee 5
R06 Requested service fee 6
R07 Requested service fee 7
R08 Requested service fee 8
R09 Requested service fee 9
R10 Requested service fee 10
R11 Requested service fee 11
R12 Requested service fee 12
R13 Requested service fee 13
R14 Requested service fee 14
R15 Requested service fee 15
R16 Requested service fee 16
R17 Requested service fee 17
R20 Requested service fee 20
T01 Ticketing fee 1
T02 Ticketing fee 2
T03 Ticketing fee 3
T04 Ticketing fee 4
T05 Ticketing fee 5
Value Description
710 Date Ticketed
DR DAte of refund
Value Description
700 All other document types
E Excess baggage
M Miscellaneous charge order
O Tour order
S Special service ticket
T Ticket
Value Description
700 All other document types
E Excess baggage
M Miscellaneous charge order
O Tour order
S Special service ticket
T Ticket
Value Description
700 Additional collection
701 Paid
710 Applies to carrier fee
711 Applies to tax on carrier fee
Value Description
700 Additional collection (ET exchange/reisue new tax totals)
701 Paid (ET exchange/reissue paid tax box totals)
702 Current
703 Total amount of all passenger facility charges (PFC)
704 Total taxes
D Include departure taxes only
E Tax exempt
I Taxes included
N Taxes not applicable
Q Exempt security surcharge
T Domestic tax not applicable
Value Description
XT Extended
ZZ Tax type list
Value Description
XT Extended taxes
Value Description
1 ASCII 7 bit
2 ASCII 8 bit
3 Code page 500 (EBCDIC Multinational no. 5)
4 Code page 850 (IBM PC Multinational)
5 UCS-2
6 UCS-4
7 UTF-8
8 UTF-16
ZZZ Mutually agreed
Value Description
AGT On behalf of/in exchange for a document previously issued by a Sales Agent
CA Cash
CC Credit Card
CK Check
GR Government transportation request
MS Miscellaneous
NR Non-refundable (refund restricted)
PT Prepaid Ticket Advice (PTA)
Value Description
ERR Error text
STA Document status
Value Description
45 Original issue information
CFP Complete Form Payement
CSTF Customer file reference
REM Remark
Value Description
AB Billing address
Value Description
45 Original issue information
REM Remark
Value Description
B First issue of BT
F First Issue
I First issue of IT
R Reissue
W Reissue of BT
Y Reissue of IT
Value Description
B First issue of BT
F First Issue
I First issue of IT
R Reissue
W Reissue of BT
Y Reissue of IT
Value Description
FRM from number
TCN Transmission control number
TO unto numebr
Value Description
AEA Amount Entered by agent
B Base fare
CP Cancellation penalty
CUR Cureency conversion amount
FRF Fare refund
Value Description
B Base fare
C Additional collection total
D Bank exchange rate
E Equivalent fare
F Commission amount
G Commission rate
H Net fare amount
I Transaction total amount
M Ticket total amount
T Ticket document amount (base, tax, fee)
Value Description
773 Fee relate to booking
774 Fee related to ticketing
775 Fee related to service
Value Description
CP Cancellation Penalty
FMA Airline commission A
FMB Airline commission B
Value Description
ARNK ARNK (for RTG use only)
ZZZ ZZZ (used to designate all cities)
Value Description
ARNK ARNK (for RTG use only)
ZZZ ZZZ (used to designate all cities)
Value Description
ARNK ARNK (for RTG use only)
ZZZ ZZZ (used to designate all cities)
Value Description
D Domestic itinerary
I International itinerary
Value Description
MNE Printer Mnemonique
RID Rule Id
SAC Settelment authorization code
STK Printer stock
TRM Terminal Id
Value Description
DIS Data source
FZR FZ Revenue attribution number
INV Invoice number
TKT TKT indicator
Value Description
VAC Validation Certificate used for Staff
Value Description
DIS Data source
REF Refund Number
TKT TKT Indicator (Y or N)
Value Description
1 Coupon 1
2 Coupon 2
3 Coupon 3
4 Coupon 4
Value Description
F CRS Floor limit
M Manual
S Link
Value Description
OK Confirmed
OPE Open
RF Refunded
T Ticketed
V Void
Value Description
700 no active itinerary
701 Coupon notification
702 Active* (*To indicate the queue is designated for use whether it currently has any
items. When not present, the default status is non-active)
703 Queue placement is inhibited
704 Queue level notification
705 Queue being printed
706 Sub-queue present
707 On hold
A Add
AC Accrual
AL Aiport control
ALL Allocated
AVA Available
B Flown/used
BD Boarded
C Change
CK Checked in
CLO Closed
D Reprint
DB Deboarded
DN Denied boarding
E Exchanged/reissued
F Critical free text
G Non air segment
I Original Issue (Open for Use)
IF Information only
INU In use
IO Irregular operations
K Confirmed, effective, working, firm, etc
LIM Limitations on use
NAV Not available
NC Not checked in
NS Infant, no seat
OF Offloaded
OK Confirmed
OLD Replaced item
OPE Open
P Provisional, draft proposed subject to change, etc
PAV Partial Availability - Specified sub-elements only
PE Print Exchange
PR Printed
PRF Preferred
PRP Proposed/Intended Allocation
R Request
RD Redemption
REP Replacement
REV Revised
RF Refunded
RQ Requested
S Suspended
SA Space Available
SB Standby
SRV Serviceable
T Ticketed
UNS Unserviceable
V Void
WL Waitlisted
X Cancel
Value Description
No specific codeset defined for this data element.
Value Description
COV Cover additional expenditure
EMD EMD ticket number
I Involuntary (no reason given)
NRF Non-refundable indicators bypass option
NUL Null
TAX Taxes
Value Description
CI City
CO Country
CY Company
L1 Address line1
L2 Address line 2
NA Name
PO P.O. BOX
ST State
ZP Postal code
Value Description
1 Coded free text
3 Literal text
4 Coded and literal text
Value Description
4 Coded and literal text
Value Description
4 Coded and literal text
Value Description
ACMA Agency credit memo
ACMR Refund credit memo
ADMA Agency debit memo
BPAS Boarding-Pass-Only
CANN Cancelled computer generated ticket number
CANR Cancellation with reversal
CANX Cancelled document
MCOM Miscelaneous Charges order - Manual
MD50 Miscelaneous charges order - Automated
Value Description
ACMA Agency credit memo
ACMR Refund credit memo
ADMA Agency debit memo
BPAS Boarding-Pass-Only
CANN Cancelled computer generated ticket number
CANR Cancellation with reversal
CANX Cancelled document
MCOM Miscelaneous Charges order - Manual
MD50 Miscelaneous charges order - Automated
PSCN Printed stock control number
PTAM Prepaid ticket advice - Manual
RCSM Commission recall statement
RFND Refund
RSCN Regenarated stock control number
Value Description
ADJA Adustment for Agent
ADJP Adjustment for provider
INVT Inventory Document
REFD Refund document
SALE Sale document
Value Description
ADJA Adustment for Agent
ADJP Adjustment for provider
INVT Inventory Document
REFD Refund document
SALE Sale document