Tabular overview of all nodes, which may occur in this message. See legend below for description of table columns.
Note: Some sibling elements or complete sub-trees of the hierarchy may be defined as mutually exclusive alternative choices. This information cannot be expressed in this tabular overview. Please refer to schema diagram for a graphical representation of the message schema.
Node | Description | Values | Occurs | Example |
---|---|---|---|---|
<EMDIssueRQ> | Root element to issue an EMD (Electronic Miscellaneous Document). See annotation of attribute "EMDType" for type explanation. Note: Each EMD-A document may have up to 4 value coupons and up to 4 consecutive EMD document numbers can be issued as a conjunctive set. An EMD-S has a single coupon number (just like a paper MCO) As of Jan 2009 Split Form of Payment IS NOT planned to be supported for an EMD | 1 | ||
@version | Version number. | 0..1 | 1.0 | |
@MonetaryType | Characterizes this EMD as a DEBIT (charge to collect) or a CREDIT (i.e. credit for future air travel due to residual value of an unused ticket) transaction Note: EMD-S may be of type=CREDIT or DEBIT; EMD-A is always of type=DEBIT Possible values: DEBIT CREDIT | [DEBIT] [CREDIT] | 1 | |
@OverrideDupeEMD | Indicates override of duplicate EMD restriction to allow issue of dupe EMD. Value: "Y" | [Y] | 0..1 | |
<SaleInfo> | Sale information group | 0..1 | ||
<CityCode/> | City code. | 0..1 | MIA | |
<CountryCode/> | Country code. | 0..1 | US | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
</SaleInfo> | ||||
<RecordLocator> | PNR record locator from where this EMD is issued from. | 1 | ||
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
</RecordLocator> | ||||
<FormOfPayment> | The form of payment used to settle the charges of this EMD. | 1 | ||
<CreditCard> | Credit card group | 1 | ||
<CCCode/> | Credit card code. The following list of normalized credit card codes is currently supported by XX/1. AX .. American Express AXB .. American Express BTA AXI .. American Express IBTA CA .. MasterCard CAD .. MasterCard Debit CB .. Carte Blanche DC .. Diners Club DS .. Discover JC .. Japan Credit Bureau (JCB) MA .. Maestro TP .. Air Plus VI .. Visa Credit VID .. Visa Debit VIL .. Visa Delta VIE .. Visa Electron | 1 | VI | |
<CCNumber/> | Credit card number. | 1 | 4011236654652341 | |
<CCExpiration> | Credit card expiration group | 1 | ||
<Month/> | Credit card expiration month. | 1 | 02 Can be returned encrypted by GDS/CRS. Example: XX | |
<Year/> | Last two digits of the credit card expiration year. | 1 | 06 Can be returned encrypted by GDS/CRS. Example: XX | |
</CCExpiration> | ||||
<SecurityID/> | Credit card security number for online transactions (referred to also as CVV2, CVC2, CSC or CID). This is a 3-digit (Visa, Master, Discover) or 4-digit (Amex) number. | 0..1 | ||
<ReportingData> | Data Elements required by certain card issuers for report purposes | 0..1 | ||
<AccountNumber> | Corporation's account number | 0..1 | ||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 0..1 | ||
@DataElementID | Vendor code assigned to this reporting element | 1 | BK | |
@DataElementName | Vendor element name assigned to this reporting element | 1 | Corperate ID | |
</AccountNumber> | ||||
<CostCenter> | Cost center number/code | 0..1 | ||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 0..1 | ||
@DataElementID | Vendor code assigned to this reporting element | 1 | BK | |
@DataElementName | Vendor element name assigned to this reporting element | 1 | Corperate ID | |
</CostCenter> | ||||
<Department> | Department description for this Traveler in this association. | 0..1 | Marketing | |
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 0..1 | ||
@DataElementID | Vendor code assigned to this reporting element | 1 | BK | |
@DataElementName | Vendor element name assigned to this reporting element | 1 | Corperate ID | |
</Department> | ||||
<EmployeeID> | EmployeeID of traveler for this association. Example 476254 | 0..1 | ||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 0..1 | ||
@DataElementID | Vendor code assigned to this reporting element | 1 | BK | |
@DataElementName | Vendor element name assigned to this reporting element | 1 | Corperate ID | |
</EmployeeID> | ||||
<GenericElement> | These are elements provided by CC vendor and could include elements such as - ProjectNumber - AccountingUnit - ActionNumber - DepartingDate - FinalDestination Above sample reflects data elements from UATP/Airplus requirements | 0..N | ||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 0..1 | ||
@DataElementID | Vendor code assigned to this reporting element | 1 | PN | |
@DataElementName | Vendor element name assigned to this reporting element | 1 | Project Number | |
@SystemProcess | Allowed value: Y If set this identifies that this data content for this element is system generated (not provide by user input or profiles) | 0..1 | ||
</GenericElement> | ||||
</ReportingData> | ||||
<Authorization> | Credit card authorization | 0..1 | ||
@Type | Credit card authorization type. Values are: A = request authorization only S = request authorization and store returned approval code in the PNR D = request authorization and verify the address associated with this credit card; store the verification status and approval code in PNR. If no address associated - error message will be returned. | [A] [S] [D] | 1 | A |
<Amount/> | Monetary amount. This is the real amount without the decimal point. An amount of 7500 means 75.00 if Currency Code has 2 decimals. | 1 | 100 | |
<MerchantCode/> | The merchant is usually the Validating Carrier collecting the funds via settlement agency. | 1 | EK, AA | |
</Authorization> | ||||
<CardholderFullName/> | Credit cardholder full name as it appears on the card | 0..1 | ||
<ApprovalCode/> | Credit card approval code. | 0..1 | 996456 | |
<CCAddressGroup> | 0..1 | |||
<Address/> | Street or PO Box address. | 1..2 | 1234 Main Street | |
<City/> | City name. | 1 | NY | |
<PostalCode/> | Postal code or zip code. | 1 | 12345 | |
<StateCode/> | State code. | 0..1 | NY | |
<CountryCode/> | ISO Country code. This element is introduced as mandatory although GDS implementation will not require its presence until 30MAR2008. | 1 | US | |
<StreetNumber/> | Street number (if not included in Address lines.) | 0..1 | 100 | |
</CCAddressGroup> | ||||
</CreditCard> | ||||
<Other/> | Other payment type. Possible values: CASH, CHECK, INV | 1 | ||
</FormOfPayment> | ||||
<TicketReference/> | The ticket reference for this EMD. This is NOT the association mandatory for EMD-As which is to be mapped to the TicketNumber element at the ServiceElement level 13-digit ticket number. In case of conjunctive set this is the first (primary) ticket number of the set. | 0..1 | ||
<Service> | Servive details | 1..N | ||
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@AssociationID | Unique ID used to associate to this element at PNR creation time. | 1 | S1 | |
@ReasonCode | IATA RFIC (ReasonFor IssuanceCode, a 1-character main code) Example of RFIC: A Note: Only services of same RFIC code can be combined on an EMD-A document. For example, if there are services of RFIC code "A" and "B", two separate EMD documents are needed, issuing all services of "A" and "B" on seperate docs. | 1 | ||
@Method | Values are: F = FareIntegrated EA = EMD Associated ES = EMD Standalone MA = Flight Associated but settled via MCO MS = Standalone but settle via MCO D = DirectSettlement | [F] [EA] [MA] [ES] [MS] [D] | 0..1 | |
@SubCode | ATPCO RFIS (ReasonForIssuance Subcode). Example of RFIS: 0CC | 1 | ||
@ServiceCode | Additional unique ATPCO code. | 0..1 | OC | |
@Type | Indicator if this option is a discount or a surcharge; Values are: "Discount" 1) "Surcharge" "Included" 2) "Not applicable" 3) "Credit" 4) 1) only applicable when using methof F, applying option directly to a fare (not used in an EMD solution) 2) This item is free of charge due to FQTV status or chosen Price Class 3) This item is not available/applicable due to FQTV status or chosen Price Class. 4) This value applies when a residual value is provided as a credit (for future travel) Sample: Earning extra miles may only be allowed for a Top tier FQTV status and is not applicable for any other traveler. | [Discount] [Surcharge] [Included] [Not applicable] | 0..1 | |
@Quantity | This attribute provides how many service/items of the same type have been ordered. Possible Values: 1-99; 1 being the default | 0..1 | 3 | |
@ServiceType | The ATPCO defined code for the type of service (also referred to as 'Flight/Ticket/Merchandise Byte 21)': F = Flight (TypeValue=2) R = Rule Buster (Type Value = 5) T = Ticket (TypeValue=3 if EMD-S is issued, 4 if other) M = Merchandise (TypeValue=1 if EMD-S is issued, 4 if other) | 0..1 | ||
<SegmentIDRef/> | ID reference used to associate this item to a segment. No comma separated lists and no ranges supported. | 0..N | F1 | |
<TravelerIDRef/> | For booked travelers this references to an existing TravelerElementNumber, e.g. "1". For new booking reference is to the traveler element within this message, e.g. "T1" | 1 | ||
<GroupName/> | May go away | 1 | ||
<ServiceLocation/> | Optionally used for non-flight related services, such as airline lounge pass, pre-paid booklets for drinks/meals or WiFi. This is the 3-letter IATA city- or airport code related to the service. For example, an airport lounge pass may only be valid for one location. | 0..1 | DFW | |
<ServiceDate/> | Service date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2010-12-25 | |
<Description/> | Title description (Commercial Name) of this service - normally a one liner, e.g. "3rd Bag Fee" | 0..1 | ||
<DescriptionVariable/> | This value is used to provide a variable value for an selected service. Sample: for a Premium Seat this will be a seat number; for a annual pass of onboard WiFi this will be the credentials, etc. Examples: "9D" "UID: GO8978 PW: 1234" | 0..1 | ||
<ReferenceKey/> | Unique reference key. If present in pricing response messages, must be included. | 0..1 | ||
<ServicePrice> | Price for this service; not to be used for 'included' options (no charge options). This price is only used as the final price if it is a manually priced service, other services will be repriced during the PNRCreate processing and this price is only used for reference. | 0..1 | ||
@Total | Total amount for the chosen quantity of this service. Total = base price + total amount of taxes. | 1 | 7500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<BasePrice> | Base (net) price of Service | 1 | ||
@Amount | Net price of service | 1 | 6750 | |
</BasePrice> | ||||
<Taxes> | Tax Group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 750 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 250 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
</Tax> | ||||
</Taxes> | ||||
<ItemPrice> | Recommended to provide at all times, however if quantity is greater than 1 ItemPrice is mandatory | 0..1 | ||
@Total | Total amount for this service based on FQTV status and chosen Price Class. Total = base price + total amount of taxes. | 1 | 7500 | |
<BasePrice> | Base (net) price of Option | 1 | ||
@Amount | Net price of option. | 1 | 6750 | |
</BasePrice> | ||||
<Taxes> | Tax Group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 750 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 250 | |
<Designator/> | Tax or surcharge designator. | 1 | US | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
</Tax> | ||||
</Taxes> | ||||
</ItemPrice> | ||||
</ServicePrice> | ||||
<BookingInstructions> | Contains instructions how to book this service with respective source | 0..1 | ||
<SSRCode/> | Special service request code. IATA standard. | 0..N | VGML | |
<OSIText/> | 0..N | |||
<UpgradeMethod> | Allowed Values: A = AutoUpgrade S = SSR request | 0..1 | ||
@NewClass | Instructs which new class to book | 0..1 | ||
</UpgradeMethod> | ||||
<Text/> | Any freeflow to instruct DC | 0..N | ||
</BookingInstructions> | ||||
<InReferenceTo> | references the exchanged document(s) to support this item | 0..N | ||
<DocNumber/> | The 13-digit document number (no check digit) of an 'accountable' document such as eCert, voucher, MCO, EMD, etc | 1 | 0061234567890 | |
</InReferenceTo> | ||||
<ValidatingCarrier/> | Allows to specify the validating carrier for pricing. | 0..1 | DL | |
<DescriptionDetails> | Detailed description of this service | 0..1 | ||
<Text/> | 1..N | |||
</DescriptionDetails> | ||||
</Service> | ||||
<Traveler> | Options to be issued are grouped by traveler and unique FOP | 1..N | ||
@Total | Checksum to validate that the total of the issued EMD is the same value as expected by the agent. This can only be used on agreement in cases where the master PNR resides outside of the current system. | 0..1 | ||
<TravelerElementNumber/> | Traveler(s) selected by their PNR element number for EMD issuance | 1 | 1 | |
<ServiceElement> | PNR element numbers of the services/options to be issued with this EMD. NOTE: the services listed here may have different ReasonCodes. Any EMD must be grouped by (a) Method and (b) ReasonCode and can only be issued for one traveler. | 1..N | ||
@Source | Identifies the source where this request is to be dispatched to. Source maybe a GDS or DC (direct connect) airline. | 0..1 | 1A, 1V, or other AA, EK | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@Method | Values are: F = FareIntegrated EA = EMD Associated ES = EMD Standalone MA = Flight Associated but settled via MCO MS = Standalone but settle via MCO D = DirectSettlement | [F] [EA] [MA] [ES] [MS] [D] | 1 | |
@ReasonCode | IATA RFIC (ReasonFor IssuanceCode, a 1-character main code) Example of RFIC: A Note: Only services of same RFIC code can be combined on an EMD-A document. For example, if there are services of RFIC code "A" and "B", two separate EMD documents are needed, issuing all services of "A" and "B" on seperate docs. | 1 | ||
@SubCode | ATPCO RFIS (ReasonForIssuance Subcode). Example of RFIS: 0CC | 1 | ||
<ElementNumber> | The element number for this service in the PNR | 1 | ||
</ElementNumber> | ||||
<TicketNumber/> | 13-digit ticket number of the ASSOCIATED ticket (ONLY applicable to EMD-A). In case of conjunctive set this is the ticket containing the coupon associated with this service | 0..1 | ||
<CouponNumber> | The single digit coupon number of the ticket image associated to this service. If this service is associated to coupons of different tickets in a conjunctive set the attribute 'ConjTicketNumber' must be provided. EMD-A: single coupon association mandatory, no multiple coupons can be associated to an EMD-A. | 0..16 | ||
@ConjTicketNumber | Actual ticket number within a conjunctive ticket set. If this service is associated to coupons of different tickets in a conjunctive set the attribute 'ConjTicketNumber' must be provided. | 0..1 | ||
</CouponNumber> | ||||
<ReferenceKey/> | Unique reference key. If present in retrieval response messages, then must be included from the most recent one. | 0..1 | ||
</ServiceElement> | ||||
<TicketReference/> | The ticket reference for this EMD. This is NOT the association mandatory for EMD-As which is to be mapped to the TicketNumber element at the ServiceElement level 13-digit ticket number. In case of conjunctive set this is the first (primary) ticket number of the set. | 0..1 | ||
<FormOfPayment> | Form of payment used to settle the charges of this EMD. This element is MANDATORY when an EMD is issued to collect funds covering defined services (see also @MonetaryType = DEBIT in the EMDIssueRQ node) It is not used for an EMD which has a value of @MonetaryType=CREDIT - e.g. when credit is issued for residual values of an exchanged or refunded ticket | 0..1 | ||
<CreditCard> | Credit card group | 1 | ||
<CCCode/> | Credit card code. The following list of normalized credit card codes is currently supported by XX/1. AX .. American Express AXB .. American Express BTA AXI .. American Express IBTA CA .. MasterCard CAD .. MasterCard Debit CB .. Carte Blanche DC .. Diners Club DS .. Discover JC .. Japan Credit Bureau (JCB) MA .. Maestro TP .. Air Plus VI .. Visa Credit VID .. Visa Debit VIL .. Visa Delta VIE .. Visa Electron | 1 | VI | |
<CCNumber/> | Credit card number. | 1 | 4011236654652341 | |
<CCExpiration> | Credit card expiration group | 1 | ||
<Month/> | Credit card expiration month. | 1 | 02 Can be returned encrypted by GDS/CRS. Example: XX | |
<Year/> | Last two digits of the credit card expiration year. | 1 | 06 Can be returned encrypted by GDS/CRS. Example: XX | |
</CCExpiration> | ||||
<SecurityID/> | Credit card security number for online transactions (referred to also as CVV2, CVC2, CSC or CID). This is a 3-digit (Visa, Master, Discover) or 4-digit (Amex) number. | 0..1 | ||
<Authorization> | Credit card authorization | 0..1 | ||
@Type | Credit card authorization type. Values are: A = request authorization only S = request authorization and store returned approval code in the PNR D = request authorization and verify the address associated with this credit card; store the verification status and approval code in PNR. If no address associated - error message will be returned. | [A] [S] [D] | 1 | A |
<Amount/> | Monetary amount. This is the real amount without the decimal point. An amount of 7500 means 75.00 if Currency Code has 2 decimals. | 1 | 100 | |
<MerchantCode/> | The merchant is usually the Validating Carrier collecting the funds via settlement agency. | 1 | EK, AA | |
</Authorization> | ||||
<ReportingData> | Data Elements required by certain card issuers for report purposes | 0..1 | ||
<AccountNumber> | Corporation's account number | 0..1 | ||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 0..1 | ||
</AccountNumber> | ||||
<CostCenter> | Cost center number/code | 0..1 | ||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 0..1 | ||
</CostCenter> | ||||
<ProjectNumber> | 0..1 | |||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 0..1 | ||
</ProjectNumber> | ||||
<Department> | Department description for this Traveler in this association. | 0..1 | Marketing | |
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 1 | ||
</Department> | ||||
<AccountingUnit> | 0..1 | |||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 1 | ||
</AccountingUnit> | ||||
<EmployeeID> | EmployeeID of traveler for this association. Example 476254 | 0..1 | ||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 1 | ||
</EmployeeID> | ||||
<OrderNumber> | 0..1 | |||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 1 | ||
</OrderNumber> | ||||
<ActionNumber> | 0..1 | |||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 1 | ||
</ActionNumber> | ||||
<DepartureDate> | Attributes to be passed thru from CCReportingDataRS. Actual date value added during reproting process based on the ticket charged against this credit card. | 0..1 | ||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 1 | ||
</DepartureDate> | ||||
<FinalDestination> | Attributes to be passed thru from CCReportingDataRS. Actual final destination value added during reproting process based on the ticket charged against this credit card. | 0..1 | ||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 1 | ||
</FinalDestination> | ||||
</ReportingData> | ||||
<ApprovalCode/> | Credit card approval code. | 0..1 | 996456 | |
<CCAddressGroup> | 0..1 | |||
<Address/> | Street or PO Box address. | 1..2 | 1234 Main Street | |
<City/> | City name. | 1 | NY | |
<PostalCode/> | Postal code or zip code. | 1 | 12345 | |
<StateCode/> | State code. | 0..1 | NY | |
<CountryCode/> | ISO Country code. This element is introduced as mandatory although GDS implementation will not require its presence until 30MAR2008. | 1 | US | |
</CCAddressGroup> | ||||
<CardholderFirstName/> | FirstName on card. | 0..1 | ||
<CardholderLastName/> | Name on card. | 1 | ||
</CreditCard> | ||||
<Other/> | Other payment type. Possible values: CASH, CHECK. | 1 | ||
</FormOfPayment> | ||||
<EndorsementAddOns> | Any traveler associated tax ID e.g. RUC/VAT can be provided here. EMD processing will add these to the existing document level endorsements filed by the airline. These 'Add Ons' will not replace existing endorsements. | 0..1 | ||
<Text/> | Text to be added to existing (document level) endorsement | 1..N | ||
</EndorsementAddOns> | ||||
</Traveler> | ||||
<ServiceElement> | PNR element numbers of the services/options to be issued with this EMD. NOTE: the services listed here may have different ReasonCodes. Any EMD must be grouped by (a) Method and (b) ReasonCode and can only be issued for one traveler. | 1..N | ||
@Source | Identifies the source where this request is to be dispatched to. Source maybe a GDS or DC (direct connect) airline. | 0..1 | 1A, 1V, or other AA, EK | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@Method | Values are: F = FareIntegrated EA = EMD Associated ES = EMD Standalone MA = Flight Associated but settled via MCO MS = Standalone but settle via MCO D = DirectSettlement | [F] [EA] [MA] [ES] [MS] [D] | 1 | |
@ReasonCode | IATA RFIC (ReasonFor IssuanceCode, a 1-character main code) Example of RFIC: A Note: Only services of same RFIC code can be combined on an EMD-A document. For example, if there are services of RFIC code "A" and "B", two separate EMD documents are needed, issuing all services of "A" and "B" on seperate docs. | 1 | ||
@SubCode | ATPCO RFIS (ReasonForIssuance Subcode). Example of RFIS: 0CC | 1 | ||
<ElementNumber/> | The element number for this service in the PNR | 1 | ||
<TicketNumber/> | 13-digit ticket number of the ASSOCIATED ticket (ONLY applicable to EMD-A). In case of conjunctive set this is the ticket containing the coupon associated with this service | 0..1 | ||
<CouponNumber> | The single digit coupon number of the ticket image associated to this service. If this service is associated to coupons of different tickets in a conjunctive set the attribute 'ConjTicketNumber' must be provided. EMD-A: single coupon association mandatory, no multiple coupons can be associated to an EMD-A. | 0..16 | ||
@ConjTicketNumber | Actual ticket number within a conjunctive ticket set. If this service is associated to coupons of different tickets in a conjunctive set the attribute 'ConjTicketNumber' must be provided. | 0..1 | ||
</CouponNumber> | ||||
<ReferenceKey/> | Unique reference key. If present in retrieval response messages, then must be included from the most recent one. | 0..1 | ||
</ServiceElement> | ||||
<EMDTotal> | EMD-S use ONLY Final amount to be charged with this EMD-S This node exclusively used for EMD-S (includes TASF automated ServiceFee charge) | 0..1 | ||
@Total | Total amount debited or credited with this EMD. This is the sum of BasePrice .../EMDTotal/BasePrice/@Amount plus the sum of all taxes .../EMDTotal/Taxes/@Amount | 0..1 | 10675 | |
<CurrencyCode> | Currency code of Point of Sale (POS) Applies to all amounts of this EMD (with the exception of any amount filed in a different currency and identified by its own CurrencyCode element) | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<BasePrice> | Base (net) price of Option | 1 | ||
@Amount | Net price of charge. | 1 | 9550 | |
<FiledIn> | This element represents the BasePrice filed in a currency different from the currency of a point of sale. | 1 | ||
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Amount/> | Base Fare Amount as originally filed. | 1 | ||
</FiledIn> | ||||
<Surcharges> | Surcharges group | 0..1 | ||
@Amount | Total surcharges amount. | 1 | 2000 | |
<Surcharge> | Surcharges break down information. | 0..N | ||
@Amount | Individual surcharge amount. | 1 | 270 | |
<Designator/> | Surcharge designator. | 1 | ||
<Description/> | Surcharge descriptions as free form text. | 0..1 | ||
@Segment | Segment number to which the surcharge applies. | 0..1 | 1 | |
</Surcharge> | ||||
</Surcharges> | ||||
</BasePrice> | ||||
<Taxes> | Taxes group | 1 | ||
@Amount | Sum of all taxes | 1 | 1125 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 250 | |
<Designator/> | Tax or surcharge designator. | 1 | US | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
</Tax> | ||||
</Taxes> | ||||
<Commission> | The TOTAL commission taken. | 0..1 | 10 | |
@Type | Whether the commission is in percent or an amount. Possible values: P, A. | 1 | A | |
@NumberOfDecimals | If and only if the commission type is A, specify the number of decimals here. | 0..1 | 2 Note: Need and logic NEEDS to be verified. Is the decimal needed for type 'P' or 'A'? The node is copied over from TicketExchangeRQ | |
</Commission> | ||||
</EMDTotal> | ||||
<QualifierGroup> | EMD-S use ONLY additional qualifiers to be used for an EMD-S | 0..1 | ||
<Endorsement> | Endorsements for this service. | 0..N | NONREF | |
<Text/> | Freeflow text. | 1 | ||
</Endorsement> | ||||
<Remarks/> | Remarks that are to be printed on the EMD-S receipt. | 0..1 | Check with tour guide upon arrival | |
<TourCode/> | Tour code as required (EMD-S use) | 0..1 | ||
<Commission> | The TOTAL commission taken. | 0..1 | 10 | |
@Type | Whether the commission is in percent or an amount. Possible values: P, A. | 1 | A | |
@NumberOfDecimals | If and only if the commission type is A, specify the number of decimals here. | 0..1 | 2 Note: Need and logic NEEDS to be verified. Is the decimal needed for type 'P' or 'A'? The node is copied over from TicketExchangeRQ | |
</Commission> | ||||
</QualifierGroup> | ||||
<TravelStats> | Statistical data as needed for BSP and/or ARC reporting | 0..1 | ||
<PurposeCode/> | Purpose Code. Valid values: 1 = Business 2 = Pleasure 3 = Charter Canadian requirement | 0..1 | ||
<DestinationCode/> | 1 = Mexico, Costa Rica, Central America, Canal zone 2 = Islands and countries of the Caribbean, Bermuda, including PR, VI 3 = South America 4 = Europe incl Morocco, Tunisia, Algeria, Greenland 5 = Africa 6 = Middle East (western Asia) 7 = Asia including India 8 = Australia, New Zealand. Pacific islands incl Hawaii, excluding Guam 0 = United States (wholly within the USA) or trans- border Canada – USA (or vice-versa) Canadian requirement | 0..1 | ||
</TravelStats> | ||||
<TicketBlock> | Block of document numbers to be used in transaction. | 0..1 | ||
<Start/> | Starting number in ticket block to be applied in issue request | 1 | ||
<End/> | Ending number in ticket block to be applied in issue request | 1 | ||
<DocType/> | Document type applicable to number range. Values are: TKTT - Ticket number range EMD - EMD number range | 1 | ||
</TicketBlock> | ||||
</EMDIssueRQ> |
Column | Description |
---|---|
Node | Name of message node (element or attribute). Nodes in bold type are mandatory, if their parent element occurs in the message. Point mouse cursor at table cell to view complete XPath. |
Description | Description of meaning and usage of the node. |
Values | List of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema. |
Occurs | Minimum and maximum number of times the node must/may occur, if its parent element occurs in the message. Examples: 0..3 Node is optional and may occur up to 3 times. 1..N Node must occur at least one (mandatory) and may occur any number of times. 2 Node must occur exactly twice. |
Example | Example value for the node. |
XML Schema documentation generated with XX/1 server