TravelCaster API - ReportBO - Implementation information

Back to ReportBO.

Implementation information

This section details the business logic and technical rules required to correctly process the ReportBO data. It covers essential information for a successful implementation.

Key Topics:

Product information

The "Product" section contains information about the agency's role.

  • Attributes:
    • Product.OwnProduct: Product owner.
    • Product.OwnChannel: Product seller.
  • Possible combinations:
    • "OwnProduct"=true and "OwnChannel"=true: The agency sells its own product.
    • "OwnProduct"=true and "OwnChannel"=false: The agency distributes its product, but it is sold by another agency.
    • "OwnProduct"=false and "OwnChannel"=true: The agency sells another agency's product.
  • Product information (Actions):
    • "OwnProduct"=true: Remit payment to the airline.
    • "OwnProduct"=false: Remit payment to the Product.Owner.
    • "OwnChannel"=true: Charge the passenger/buyer.
    • "OwnChannel"=false: Charge the Product.WebOwner.

Ticket information

  • Edifact Carriers: These airlines provide a ticket number per passenger. You can associate a passenger with their ticket number using the following mapping:

    • Ticket.PaxNumber → Pax.PaxNumber

  • Low-Cost Carriers (LCC): These providers do not typically issue individual ticket numbers. In these cases, the association is established via PaxNumber, but the Ticket.Number field will be absent or empty.

    The following are examples of providers/carriers that exhibit this behavior:

    • AMS: SY
    • SBR: SY
    • JST: JA, WJ, JZ
    • FBO: FO
    • AZD: AD

  • F9 (AMS - SBR): This carrier exhibits a specific behavior by returning a 14-digit ID instead of a standard 13-digit ticket number. This ID is associated with a unique passenger within the reservation.

Cost information

Reservation costs are delivered per "Ticket" (ETK or EMD).

  • Type: Values: ETK, EMD.
  • SubType:
    • ETK values: MainTicket, ConjTicket. Implement your own logic for ConjTicket.
    • EMD values: Provider information.
  • Number: Refers to Ticket information.
  • PaxNumber: Passenger reference
  • Currency: Provider currency. The currency used by the airline for ticket reconciliation.
  • TotalAmount: The total value of the document.
  • FareAmount: Currently available for ETK.
  • TaxAmount: Currently available for ETK.

For ETK tickets, tax details are itemized in the "Tax" Section. All the TaxDetails.Amount

  • TicketId: Refers Ticket ID.
  • TaxDetails: Currently available for ETK.
  • TaxDetails.Code: The same TaxCode may be reported twice with different amounts, depending on the provider.
  • TaxDetails.Amount: Expressed in the respective "Ticket.Currency".

Note: Kiusys ("Provider": "KIU") does not provoide TaxDetails information.

Sales information

For ETK tickets, the sales amounts are detailed in the Pax.Purchase section.

  • Fare and Tax: These values are usually expressed in the credential's Currency. However, this may vary based on the following scenarios:
    • Shopping API Implementations: If the Shopping API implementation requests data in a specific currency, the reported values will reflect that requested currency.
    • Imported Reservations: If a reservation is imported into the system, the amounts will be reported in the currency originally specified by the Provider.

Commission information

Commission data is set for the agency selling the content (the final consolidator in the chain). This information should only be processed when "OwnChannel": true.

  • If "OwnChannel": true:

    • CommissionPct: The base commission percentage.
    • WingsCDISC: The commission discount/cap set by the consolidator.
    • Consolidator Commission Percentage:
      • If (CommissionPct > WingsCDISC) → WingsCDISC
      • Else → CommissionPct
    • Seller Agency Commission Percentage:
      • If (CommissionPct > WingsCDISC) → CommissionPct - WingsCDISC
      • Else → 0

  • If "OwnChannel": false:

    • Commission information is not applicable to the agency's role; do not process these fields.

Over information

Overcommission data is set for the agency selling the content (the final consolidator in the chain). This information should only be processed when "OwnChannel": true.

  • If "OwnChannel": true:

    • OverPct: The base overcommission percentage.
    • OverCalculation:
      • D (Direct): The calculation is applied directly to the fare base.
      • I (Indirect):
        • If commission exists: Subtract the commission from the fare base before applying the OverPct.
        • If no commission exists: Apply the OverPct to the fare base.
    • OverPaxType: Defines the passenger types eligible for the overcommission.
      • "ALL": Applies to all passengers.
      • "ADT|CHD": Applies only to Adults and Children.
      • "ADT": Applies only to Adults.
    • WingsODISC: The overcommission discount/cap set by the consolidator.
    • Consolidator Over Percentage:
      • If (OverPct > WingsODISC) → WingsODISC
      • Else → OverPct
    • Seller Agency Over Percentage:
      • If (OverPct > WingsODISC) → OverPct - WingsODISC
      • Else → 0

  • If "OwnChannel": false:

    • Over information is not applicable to the agency's role; do not process these fields.

Fee information

The Application attribute indicates the document type the fees apply to (e.g., ETK for tickets).

Fee calculations vary depending on the Product Owner/Seller roles:

  • Consolidator Cost (Managed in Servicing):

    • If "OwnProduct": true: Consolidator Cost is represented by ContentCost.
    • If "OwnProduct": false: Not applicable.

  • Consolidator Fee (Managed in Servicing):

    • If "OwnProduct": true: The fee is calculated as ContentFee minus ContentCost (if applicable).
    • If "OwnProduct": false: Consolidator Fee is represented by ContentFee.

  • Seller Fee:

    • Attributes: Includes ApiFee (from Servicing) and CFEE (from Wings).
    • Logic:
      • If "OwnChannel": true: Seller Fee is the sum of ApiFee + CFEE.
      • If "OwnChannel": false: Not applicable.

  • Retail Agency Fee:

    • Represented by AFEE (Managed in Wings).

Exchange information

When an exchange is performed, the service provides a new Book object with a structure similar to an "Issued" event. ReportBO will automatically trigger a notification containing the New Book data.

  • New Book (Current Record):

    • UpdateDate: Contains the timestamp when the exchange was performed.
    • "BookingNumber": "KXGWTA": Reservation code.
    • "BookingID": 1918804: New Book ID.
    • "ExchangedFrom": 1918715: The BookingID of the previous record, used to maintain the transaction chain.
    • "BookingStatus": "Issued-Exch"

  • Original Book (Previous Record):

    • Note: This record is not sent automatically. It is only provided if an agent manually triggers a "Force notification to ReportBO".
    • UpdateDate: The original timestamp remains unchanged.
    • "BookingNumber": "KXGWTA-EXCH-1": The original code plus a suffix indicating the exchange count (e.g., "KXGWTA-EXCH-1", "KXGWTA-EXCH-2").
    • "BookingID": 1918715: Original Book ID.
    • "ExchangedTo": 1918804: The BookingID of the next record in the sequence.
    • "BookingStatus": "Exchanged"

Remark information

Wings includes a set of fields (either optional or mandatory) that agents may be required to complete before finalizing a reservation. This data is provided in the Remarks section.

  • Default Association: By default, these remarks are associated with PaxNumber: 1.

    • RMK-CC: Returned in WingsCC.
    • RMK-SL: "Requested by" / Agent identifier.
    • RMK-ST: Cost Center information.
    • RMK-NO: Order Number.
    • RMK-RF: File reference.

  • GDS Storage: These remarks are also stored within the GDS reservation using standard formats:

    • Amadeus: e.g., RM ST-123456
    • Sabre: e.g., ..ST-123456

  • Custom Logic: Specific Customer API implementations may also include their own remark logic and passenger mapping.

Payment information

This section contains data based on Sales amounts. Since the system does not process payments directly, this information is strictly for reference. The system only transacts the air reservation cost between the agency and the Airline/GDS.

  • Type: Defines the payment category.
    • System Values: FARE, FEE, OFFERS.
    • Note: This may vary depending on specific API implementations.
  • FOPtype: Form of Payment type.
    • Values: CASH, CC (Credit Card).
  • Currency: Usually expressed in the sales currency, referencing the Sales information section.
  • Reference: This field identifies which passengers the payment applies to. It is used to create an association with Pax.PaxNumber.
    • Possible Values:
      • ALL: Applies to all passengers in the booking.
      • "1,2": Applies to specific passengers (e.g., Passenger 1 and 2).
  • CreditCard: Card numbers are masked in compliance with PCI security standards.

Providers list

For a detailed reference of supported travel providers and their respective codes, please refer to the following global list:

Back to ReportBO.

See change history for this file
Loading...