or-icd-001-orion-ftr extract-interface-controlv2 6

Upload: suresh-kumar

Post on 09-Apr-2018

230 views

Category:

Documents


0 download

TRANSCRIPT

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    1/31

    ICD- Interface Control DocumentOrion FTR Extract

    Version 2.6

    Date 1 August 2007

    Author Anthony Cozens

    Reviewed D Howe

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    2/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 2

    Revision History

    Date of this revision: 1 August, 2007

    RevisionNumber

    RevisionDate

    Summary of Changes Reviewedby

    ReviewedDate

    0.1 17-Jun-05 Initial version (AC)

    0.2 17-Jun-05 Updated version with additionalinformation on FTR (SW)

    0.3 20-Jun-05 Formatting updates (AC) DH 20-Jun-05

    0.4 20-Jun-05 Added record delimiter

    0.5 20-Jun-05 Added table descriptions (AC) DH 20-Jun-05

    0.6 24-Jun-05 Updates following QR reviewmeeting (AC)

    0.7 24-Jun-05 Added formats for reconciliation

    summary and detail (SW)0.8 30-Jun-05 Minor updates to section 4 (AC) MG 1-Jul-05

    0.9 19-Jul-05 Ticket Exchange field added(AC)

    0.10 16-Aug-05 u_version field removed fromticket_coupon_even table (AC)

    1.0 16-Aug-05 Release for QR

    1.1 19-Aug-05 Fields added to Record Type 1& 3 (AC)

    1.2 19-Aug-05 DH Added QR FTR record

    names1.3 26-Aug-05 Change to file names and dateformats as per QR request (AC)

    1.4 5-Sep-05 Added Appendix (AC)

    1.5 17-Oct-05 Added file details for MincomTest and Prod (MG)

    1.6 7-Dec-05 Added new fields for PTVhandling (SW)

    1.7 8 Sep 06 Genericised DH

    2.0 4 Jan 07 Add new fields for QR

    2.1 23-Feb-07 Updated to use carrier

    configured business rules tohandle FTR extract file nameand record type 00 header (MG)

    2.2 4 April 07 Add new fields for QR phase 1B(SW)

    2.3 10 April 07 Add new fields for CLK phase 3(SW)

    AC 16-Apr-07

    2.4 17 April 07 Moved file locations to appendix,included additional minor QRupdates (AC)

    2.5 30-Jul-07 Add new fields for CLK Phase3B (SW) AC 1-Aug-07

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    3/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 3

    2.6 2-Aug-07 Updated tkcp_status_indremarks, added order numberdetails, movedfint_override_remark field (AC)

    SW 4-Oct-07

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    4/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 4

    Signatures

    VERSION NO. ACCEPTED: .

    This document is agreed to and accepted by

    Rail Operator

    By:.....................................................

    Authorised Signature

    ..........................................................

    Print name and Officer's Title

    Date...................................................

    Onerail

    By:.....................................................

    Authorised Signature

    ..........................................................

    Print name and Officer's Title

    Date...................................................

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    5/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 5

    Table of Contents

    Revision History 2Signatures 4

    1 INTRODUCTION 61.1 Aim of Document 61.2 Audience 61.3 Background 6

    2

    FILE FORMAT 7

    2.1 Carrier Configured File Format 73 FILE LOCATION 84 OUTPUT FIELDS 9

    4.1 FTR Extract 94.2 FTR Reconciliation Summary 234.3 FTR Reconciliation Detail 24

    5 ADDITIONAL FIELDS 266 APPENDIX 28

    6.1 Fare Calculations 286.2 Proportioning Calculations 286.3 File Locations 31

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    6/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 6

    1 Introduction

    1.1 Aim of Document

    The aim of this document is to detail the contents of the FTR extract as generated bythe Nightly File Maintenance.

    1.2 Audience

    This document has been written for Finance Personnel involved in the Orion project.

    1.3 Background

    Onerail are delivering Orion will be used as a replacement for TravelLink. TravelLinkproduced an FTR Extract which contained details of all financial transactions, andwas used by the Rail Operators finance department for accounting purposes.

    Orion will contain extra fields related to financial transactions, which will be includedin the FTR Extract, however the format will be largely the same as the one producedfrom TravelLink

    This document contains changes to the FTR Extract that are being delivered as partof QR Phase 1B and CLK Phase 3 (CR014 and CR016).

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    7/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 7

    2 File Format

    The extract will be in a text format, with each field delimited by a pipe | (ASCII 124)

    Each record will be delimited with a Line Feed (ASCII 10)

    FTR extract file will be named in the format oriftrextyyyymmdd(i.e. Orion FTR Extract for 24th May 2005 will be named oriftrext20050524)

    The reconciliation summary file will be named in the format orisummyyyymmdd(i.e. Orion FTR reconciliation summary for 24th May 2005 will be namedorisumm20050524)

    The reconciliation detail file will be named in the format oridetlyyyymmdd(i.e. Orion FTR reconciliation summary for 24th May 2005 will be named

    oridetl20050524)

    2.1 Carrier Configured File Format

    The file format specified above section 2 will be used as the system base file format.

    If the system host carrier is QTT (Queensland Rail) the file format will be as follows:

    FTR extract file will be named in the format qroftrextyyyymmdd

    (I.e. Orion FTR Extract for 24

    th

    May 2007 will be named qroftrext20070524)

    The reconciliation summary file will be named in the format qrosummyyyymmdd(I.e. Orion FTR reconciliation summary for 24th May 2007 will be namedqrosumm20070524)

    The reconciliation detail file will be named in the format qrodetlyyyymmdd(I.e. Orion FTR reconciliation summary for 24th May 2007 will be namedqrodetl20070524)

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    8/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 8

    3 File Location

    The FTR extract files will be generated nightly in each of the environments asidentified in Appendix 6.3.

    These extract files will also be purged nightly when they are X days old (X isparameterised currently set to 7 days).

    See Appendix 6.3 for carrier specific file locations.

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    9/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 9

    4 Output Fields

    4.1 FTR Extract

    The FTR Extract will be comprised of the following fields

    4.1.1 Header Record (Record type 0)

    This table contains the general information about the FTR extract.There will be one instance of this for the FTR extract.

    Field name Data type Nulls Field description and originRecord Type Char(2) no The record type (Always 00)Extract date date no Date of the FTR extract - The time this process started

    (format YYYY-MM-DD)Extract time time no Time of the FTR extract - The time this process started

    (format HH:MM)Header name char(23) no Literal CLK will use ORION FTR HEADER

    RECORD. QTT will use QRORI FTR HEADERRECORD

    Resend indicator char(1) no Y for resend of previous extract, N for new extractLast FTR date date yes FTR date of the last FTR from the previous extractLast FTR id Integer yes FTR id of the last FTR from the previous extract

    An example of this record type is:

    00|2007-02-21|23:20|QRORI FTR HEADER RECORD|N|2007-02-20|61518|4.1.2 informix.financial_transact (Record type 1) (FTR200)

    This table contains the base data of an FTR.There will be one instance of this for each financial transaction.

    Field name Data type Nulls Field description and originfint_trans_date date no system generated transaction date - current system

    today (YYYY-MM-DD)fint_trans_id integer no system generated transaction id - (based on the

    syst_fin_lst_num from system_parameter FINTXNoccurrence) CLK will utilize ID numbers 50001-99999.QTT will utilize ID numbers 30001-50000 until oldsystem is decommissioned then ID numbers utilizedwill be 1-50000.Transaction id sequence by default will be reset weeklyon Sunday evenings.

    u_version char(1) yesfint_trans_type char(1) yes T for travel product, N for Non-travel product, F for

    Financial Settlementfint_prev_txn_date date yes for refunded sales transaction record contains the

    associated refund transaction date

    for a refund transaction record contains the originalsales transaction date

    otherwise blank

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    10/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 10

    fint_prev_txn_id integer yes for refunded sales transaction record contains theassociated refund transaction number

    for a refund transaction record contains the originalsales transaction number

    otherwise blankfint_sales_refund char(1) yes S for sales, R for refunds, P for pseudofint_auto_tkt char(1) yes true for automated ticketing transaction,

    false manual ticketing transactionfint_country_tax char(2) yes country (federal) sales tax code (from quote fare)fint_ctry_tax_rate decimal(5,2) yes country (federal) sales tax rate (from quote fare)fint_s_r_account1 char(3) yes sales account for federal sales tax for the departure

    provincefor refund: refund account for federal sales tax for thedeparture province

    fint_ctry_tax_cod2 char(2) yes country (federal) tax code used for travelled portion ofthe partial refund transaction (from quote fare)

    fint_ctry_tax_rat2 decimal(5,2) yes country (federal) tax rate used for travelled portion ofthe partial refund transaction (from quote fare)

    fint_s_r_account2 char(3) yes sales account for federal tax for the departure provincefor travelled portion of the partial refund transaction

    (from quote fare)fint_prov_tax char(2) yes province sales tax code (from quote fare)fint_prov_tax_rate decimal(5,2) yes province sales tax rate (from quote fare)fint_s_r_account3 char(3) yes sales account for provincial sales tax for the departure

    provincefor refund: refund account for provincial sales tax forthe departure province

    fint_prov_tax_casc char(1) yes indicator - true, if provincial sales tax is cascaded ontop of federal sales tax

    fint_prov_tax_cod2 char(2) yes provincial sales tax code used for travelled portion ofthe partial refund transaction

    fint_prov_tax_rat2 decimal(5,2) yes provincial sales tax rate used for travelled portion ofthe partial refund transaction

    fint_s_r_account4 char(3) yes sales account for provincial sales tax for the departureprovince for travelled portion of the partial refundtransaction

    fint_prov_tax_cas2 char(1) yes sales tax cascade indicator for travelled portion of thepartial refund transaction

    fint_future_tax char(3) yes null (not in use)fint_trip_origin char(2) yes province / state of the trip origin (provided for sales tax

    purposes)fint_trip_org_ctry char(2) yes country of the trip origin (provided for sales tax

    purposes)fint_tax_over_ref char(16) yes the reference number to support the sales tax overridefint_issue_time char(8) yes system time (GMT) when ticket was issued (HHMM)

    fint_local_time char(8) yes local time when ticket was issued (HHMM)fint_local_date date yes local date when ticket was issuedfint_booking_date date yes the date when the PNR has been created

    (psnr_creation_dt in PNR) from which the travel ticketwas issued or copy from previous FTR forsubstitute/duplicate/prepaid tickets (not applicable tonon-travel product or financial settlement)

    fint_agnt_issue char(8) yes ticket or refund issuing agent - the agent financiallyresponsible for the transaction; will be users agent idunless this is an issue on behalf of other TTCO whereit will be null

    fint_empl_num integer yes employee number of the issuing agent frominformix.agent/agnt_emp_num

    fint_agnt_request char(8) no ticket or refund requesting agent - the agent whoperformed the request for transaction

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    11/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 11

    fint_agnt_book char(8) yes the agent who created PNR from which transactionwas issued or copy from previous FTR forsubstitute/duplicate/prepaid tickets

    tktp_type char(8) yes document (ticket) form type (includes ticket to screen);from informix.ticket_type

    fint_tkt_forms smallint yes number of document forms that constitute a ticket;dependent on the informix.ticket_type/tktp_num_coupon which determine the number ofcoupons per ticket page

    fint_tcn_tsk char(16) yes ticket control number or ticket stock number (used onlyfor manual tickets and their refunds) [seefint_tcn_tsk_ind indicator below]

    fint_tcn_tsk_ind char(1) yes ticket control number or ticket stock number indicator(used only for manual tickets and their refunds)

    fint_printer_id char(9) yes the printer id the ticket was issued on (not used withOrion v5)

    fint_waiver char(5) yes waiver code for the price override of the salestransactions for this passenger;

    fint_trv_waiver char(5) yes nullfint_client_num integer yes null (not in use)

    fint_pen_col decimal(7,2) yes the applicable penalty to be collected, if refunded in thefuture (from fare quote );for master ticket, this value is zero (0)

    fint_s_r_account5 char(3) yes account number for penalty collected - refund recordsonly

    fint_s_r_account7 char(3) yes account number for federal sales tax levied on thepenalty collected -refund records only

    fint_s_r_account8 char(3) yes account number for province/state sales tax levied onthe penalty collected -refund records only

    fint_pen_non_adj decimal(7,2) yes the applicable non-adjusted penalty, if refunded in thefuture (non-adjusted penalty from fare quote);for master ticket, this value is zero (0)

    fint_pen_waiver char(5) yes null

    fint_commission decimal(7,2) yes commission amount of the commission earned by anagent; commission amount=fint_comm_perc (times)fint_fare_coll (fare collected)

    fint_comm_perc decimal(5,2) yes commission rate of the commission earned by anagent; based on the ttc_organization of the issuingagent;if today is less thaninformix.ttc_organization/ttco_comm_end_date,

    informix.ttc_organization/ttco_comm1otherwise

    informix.ttc_organization/ttco_comm2.fint_com_recal char(1) yes commission recall indicator, if true, the commission is

    to be recalled for this refund record;informix.ttc_organization/ttco_comm_recall of thettc_organization of the issuing agent.

    fint_com_recal_ovr char(1) yes falsefint_rqst_stn_code char(4) no requesting agent/operator station code (location)fint_rqst_ofc_func char(2) no requesting agent/operator office function code

    (location)fint_book_stn_code char(4) yes booking agent/operator station code (locationfint_book_ofc_func char(2) yes booking agent/operator office function code (location)fint_issu_stn_code char(4) yes issuing agent/operator station code (location),

    However, will be null if issuing a ticket on behalf ofother TTCO

    fint_issu_ofc_func char(2) yes issuing agent/operator office function code (location).

    However, will be null if issuing a ticket on behalf ofother TTCO

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    12/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 12

    fint_iss_ttct_tpcd char(3) no issuing agent/operator TTCO type for the issuing agent(fint_agnt_issue). However, will be the pnr TTCO typeif issuing a ticket on behalf of other TTCO.

    fint_iss_ttct_ownr char(8) no issuing agent/operator TTCO number for the issuingagent (fint_agnt_issue). However, will be the pnr TTCOowner if issuing a ticket on behalf of other TTCO.

    fint_fare_coll decimal(7,2) yes amount of fare collected; total fare paid without taxes;for master ticket, it is sum of value of the individualmember tickets;for individual member ticket, this value is zero (0)

    NB. This is not the total fare collected just the NetFare (exclusive of GST)

    fint_s_r_account6 char(3) yes carrier sales account for a carrier when price overrideor travel credit used otherwise is blank (only onecarrier allowed for price override)

    fint_fare_trav decimal(7,2) yes Travelled amount for partial refundsfint_fare_refunded decimal(7,2) yes Refunded amount for refund transactions(difference

    between fint_fare_coll and fint_fare_trav)fint_fare_auto decimal(7,2) yes automated fare - the fare calculated by the system

    (may be equal to the fare collected, if there is no priceoverride of the fare); (from quote fare);for master ticket, this value is zero (0)for the partial refund automated fare calculated bythe system for travelled portion of the itinerary

    fint_fare_non_adj decimal(7,2) yes fare non-adjusted - the fare calculated by the systemwithout discount entitlements taken into account (fromquote fare)for master ticket, this value is zero (0)for the partial refund - fare non-adjusted calculated bythe system for travelled portion of the itinerary

    fint_from_crs char(1) yes indicator, if true, the record has been transferred fromthe CRS's via BSP

    fint_pnr_ttct_type char(3) yes PNR owner TTCO type (informix.pnr/ ttct_type_code)fint_pnr_ttco_ownr char(8) yes PNR owner TTCO number (informix.pnr/ttct_owner)tcre_type char(2) yes travel credit typetcre_code char(7) yes travel credit codefint_tc_amount decimal(7,2) yes travel credit amountfint_psgr_prof_id char(7) yes passenger/customer profile idfint_nett decimal(7,2) yes Net amount collected (collected fare commission

    paid)tinv_invoice_date date yes Tax Invoice Datetinv_invoice_id integer yes Tax Invoice Idonerail_fee decimal(10,2) yes (not used)ext_to_financials Datetime yes (not used)gst_rounding1 decimal(7,2) yes GST rounding for first fint_trans_fopgst_rounding2 decimal(7,2) yes GST rounding for second fint_trans_fopcollected_gst decimal(7,2) yes GST collectedtravelled_gst decimal(7,2) yes GST related to travelled part of ticketrefunded_gst decimal(7,2) yes GST related to refunded part of ticketautofare_gst decimal(7,2) yes GST related to the automated fare fare calculated by

    the system. Used if GST applicablefint_comm_clawback decimal(7,2) yes Commission amount to be clawbacked from initial

    sales agentfint_commission_gst decimal(7,2) yes GST related to percentage commission amount for

    agentfint_flat_commission decimal(7,2) yes Flat commission amount for agentfint_flat_commission_gst decimal(7,2) yes GST related to flat commission amount for agent

    fint_obo_ind char(1) yes On-behalf-of indicatorfint_delivery_method char(20) yes Ticket delivery method - text

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    13/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 13

    fint_delivery_address char(200) yes Ticket delivery address textfint_override_remark char(100) Yes Override remarks - text

    4.1.3 informix.ticket (Record type 2) (FTR240)

    This record contains the details of a ticket. Ticket details are only applicable to travelFTRs.There will be zero or one instance of this for each financial transaction. (There willeither be a ticket record or a non travel transaction record for each FTR)

    Field name Data type Nulls Field description and origin

    fint_trans_date date no system generated transaction date - current systemtoday (YYYY-MM-DD)

    fint_trans_id integer no system generated transaction id - (based on thesyst_fin_lst_num from system_parameter FINTXNoccurrence). CLK will utilize ID numbers 50001-99999.

    QTT will utilize ID numbers 30001-50000 until old systemis decommissioned then ID numbers utilized will be 1-50000.Transaction id sequence by default will be reset weeklyon Sunday evenings.

    u_version char(1) yes

    crss_crs_id char(2) no CRS id of the CRS which produced this transaction (therail system itself is one of "CRS's"); (CL);

    tket_psgr_locator char(8) yes PNR locator from which ticket has been issued;input PNR locator;informix.pnr/psnr_locator

    tket_psgr_pax_type char(3) yes passenger type of the passenger who bought the ticket;informix.passenger/psty_passenger_typ of the

    passenger being ticketed;tket_psgr_prof_id char(7) yes passenger/customer profile id

    tket_last_name char(30) yes passenger last name;informix.passenger/psgr_last_name

    tket_first_name char(20) yes passenger first name;informix.passenger/psgr_first_name

    tket_endorsements char(60) yes concatenated ticket endorsements from pricing rulesinvolved in the ticket fare construction; the endorsementsare truncated if they exceed field size

    tket_mastr_tkt_ind char(1) yes indicator, if true, the transaction is for master ticket (notused since no PNR level overrides)

    tket_mst_trans_dat date yes null; for individual member ticket - the master ticket FTR

    date (cross reference to the master ticket) otherwise null;if this is the individual member ticket when there is oneprice override for more than 1 passengers (not usedsince no PNR level overrides)

    tket_mst_trans_id integer yes null; for individual member ticket - the master ticket FTRid (cross reference to the master ticket);if this is the individual member ticket when there is oneprice override for more than 1 passengers (not usedsince no PNR level overrides)

    tket_prepaid_dat date yes for prepaid order, FTR date - cross reference to theprepaid order FTR otherwise null;

    tket_prepaid_id integer yes for prepaid order, FTR number - cross reference to theprepaid order FTR otherwise null;

    tket_paid_to_via char(1) yes indicator, if true, the ticket has been paid to the railwaystket_lost_ticket char(1) yes indicator, if true, the ticket has been reported been stolen

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    14/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 14

    tket_substitute char(1) yes indicator, if true, the ticket issued is a substitute ticket

    tket_duplicate char(1) yes indicator, if true, the ticket issued is a duplicate ticket

    tket_used char(1) yes indicator, if true, the prepaid order has been used toissue ticket valid for travel

    tket_prepaid_order char(1) yes indicator, if true, the transaction is the prepaid orderissue

    tket_internet char(1) yes (not used)

    tket_refundability char(1) yes indicator, if true, the ticket has been issued with onlyrefundable rules required - the refundable rule wererequested (not used by QTT/CLK)

    tket_issue_option char(3) yes ticket issue option from the PNR (TPD, TBM etc.) frominformix.pnr/psnr_tkt_isu_optn

    tket_tc_type char(2) yes Travel credit type (not used by QTT/CLK)

    tket_tc_code char(7) yes Travel credit code (not used by QTT/CLK)

    tket_tc_amount decimal(7,2) yes Travel credit amount (not used by QTT/CLK)

    tket_nonref_amount decimal(7,2) yes non-refundable amount (net amount) applicable for asales transaction. For a refund transaction, this is thenon-refundable amount applied to the transaction.

    tket_voucher smallint yes number of vouchers required for the trip; has value onlywith pensioner card within the native state (e.g. PC QLIN,

    NSIN etc.tket_current_year char(4) yes Entitlement year for the vouchers

    tket_next_voucher smallint yes number of vouchers required for the trip; has value onlywith pensioner card within the native state (e.g. PC QLIN,NSIN, QRIN etc.

    tket_next_year char(4) yes Entitlement year for the vouchers

    tket_xchange_dat date yes for ticket exchange, FTR date - cross reference to theoriginal ticket otherwise null;

    tket_xchange_id integer yes for ticket exchange, FTR number - cross reference to theoriginal ticket otherwise null;

    tkct_bus_name varchar(60) yes Name of business for tax invoice

    tkct_abn varchar(255) yes ABN or address of business for tax invoice

    tket_exchange char(1) yes indicator, if true, the transaction used as ticket exchangenonrefundable_gst decimal(7,2) Yes GST related to the non refundable portion of the ticket

    tket_ntvl_ftr_date date yes For booking fee, FTR date cross reference to the linkednon-travel product otherwise null

    tket_ntvl_ftr_id integer yes For booking fee, FTR id cross reference to the linkednon-travel product otherwise null

    tket_sub_date date yes for substitute ticket, FTR date - cross reference to theoriginal ticket otherwise null;

    tket_sub_id integer yes for substitute ticket, FTR number - cross reference to theoriginal ticket otherwise null;

    4.1.4 informix.ticket_coupon (Record type 3) (FTR300)This record contains details of segments making up a ticket. Fares and forms ofpayment proportioned to each segment are included.There will be one to many instances of this record if a ticket record is displayed (zeroinstances if a ticket record does not exist).

    Field name Data type Nulls Field description and origin

    fint_trans_date date no system generated transaction date - current systemtoday (YYYY-MM-DD)

    fint_trans_id integer no system generated transaction id - (based on thesyst_fin_lst_num from system_parameter FINTXNoccurrence) . CLK will utilize ID numbers 50001-99999.QTT will utilize ID numbers 30001-50000 until old system

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    15/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 15

    is decommissioned then ID numbers utilized will be 1-50000.Transaction id sequence by default will be reset weeklyon Sunday evenings.

    tkcp_coupon_number integer no ticket coupon sequence number - ticket coupon isequivalent to itinerary segment; numbers start from 1 toindicate first, second ... coupon;

    u_version char(1) yestkcp_stopover char(1) yes indicator, if true, the stopover is after this itinerary

    segment (from fare quote)tkcp_rsvt_car_code char(3) no carrier code of the corresponding segment; from

    informix.reservation/carr_carrier_codetkcp_rsvt_train_id integer yes train number of the corresponding segment; from

    informix.reservation/trnn_train_idtkcp_rsvt_ti_date date yes train departure date from the train origin station of the

    corresponding segment (train instance date); fromInformix.reservation/trin_ti_date

    tkcp_rsvt_bk_class char(2) yes booking class code of the corresponding segment; frominformix.reservation/bkcl_book_cls

    tkcp_origin char(4) yes itinerary segment origin station code of the

    corresponding segment; frominformix.reservation_unit/tisg_origin, if there is nocorresponding informix.reservation_unit record, useinformix.reservation/tisg_origin

    tkcp_dep_date date yes train departure date from the itinerary segment originstation; from informix.ti_stn/tist_schd_dep_date of thetkcp_origin

    tkcp_dep_time char(8) yes train departure time from the itinerary segment originstation; from informix.ti_stn/tist_schd_dep_time of thetkcp_origin

    tkcp_destination char(4) yes itinerary segment destination station code of thecorresponding segment; frominformix.reservation_unit/tisg_destination, if there is no

    corresponding informix.reservation_unit record, useinformix.reservation/tisg_destination

    tkcp_arr_date date yes train arrival date to the itinerary segment destinationstation; from informix.ti_stn/tist_schd_arr_date of thetkcp_destination

    tkcp_arr_time char(8) yes train arrival time to the itinerary segment destinationstation; from informix.ti_stn/tist_schd_arr_time of thetkcp_destination

    tkcp_tkt_design char(7) yes null - ticket designator (not used)tkcp_tinn_cr_ln_nm integer yes car line number; from

    informix.reservation_unit/ticr_car_line_num. If no unit, 0.tkcp_main_class char(2) yes main class code; from

    informix.reservation_unit/mncl_main_cls_code. If no unit,null;

    tkcp_tinn_unit_id char(3) yes unit/seat id (number); frominformix.reservation_unit/smpu_unit_id. If no unit, null

    tkcp_res_status char(2) yes reservation status code; frominformix.reservation/rsst_code

    tkcp_status_ind char(1) yes indicator, If F the segment has not been travelled or is arefund, if T, the itinerary segment has been travelled, ifN, the itinerary segment is non-refundable for a refundtransaction

    tkcp_pax_per_unit smallint yes number of passengers per unit (number ofinformix.pax_reservation rows associated with theinformix.reservation row that corresponds to this segment

    tkcp_legs_in_ps smallint yes pricing segment sequence number within the journeybeing priced for fare collected/automated.for partial refund: for travelled segment - value from the

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    16/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 16

    quote fare output pricing segment number for collected;whereas, for refunded segment - null.

    tkcp_leg_no smallint yes itinerary segment sequence number within the pricingsegment for fare collected/automated.for partial refund: for travelled segment - value from thequote fare output itinerary segment within pricingsegment number for collected; whereas, for refundedsegment - null.

    tkcp_fbc1_coll char(8) yes fare basis code (FBC) of the basic rule for farecollected/automated (from quote fare)for partial refund: for travelled segment - value from thequote fare output fare basis code for collected;whereas, for refunded segment - null.

    tkcp_de_code_fbc1 char(2) yes discount entitlement type used for pricing in associationwith the basic rule (from quote fare)for partial refund: for travelled segment - value from thequote fare output, first discount entitlement type from therule used, if any; whereas, for refunded segment - null.

    tkcp_de_type_fbc1 char(8) yes discount entitlement code used for pricing in associationwith the basic rule(from quote fare)

    for partial refund: for travelled segment - value from thequote fare output, first discount entitlement code fromthe rule used, if any; whereas, for refunded segment -null.

    tkcp_fbc2_coll char(8) yes fare basis code (FBC) of the best rule for farecollected/automated (from quote fare)for partial refund: for travelled segment - value from thequote fare output fare basis code for collected - secondrule used in case of pensioners/employees; whereas, forrefunded segment - null

    tkcp_de_code_fbc2 char(2) yes discount entitlement type used for pricing in associationwith the best rule (from quote fare)for partial refund: for travelled segment - value from the

    quote fare output, second discount entitlement type fromthe rule used, if any; whereas, for refunded segment -null (not used for QTT/CLK)

    tkcp_de_type_fbc2 char(8) yes discount entitlement code used for pricing in associationwith the best rule (from quote fare)for partial refund: for travelled segment - value from thequote fare output, second discount entitlement codefrom the rule used, if any; whereas, for refundedsegment - null. (not used for QTT/CLK)

    tkcp_charge_coll decimal(7,2) yes amount of the rail fare collected for the itinerary segment(from quote fare)for partial refund: for travelled segment - value from thequote fare output, pricing segment fare for collected;

    whereas, for refunded segment - null.tkcp_refund_coll decimal(7,2) yes penalty charge result (from quote fare)

    for partial refund: for travelled segment - value from thequote fare output, refund penalty; whereas, for refundedsegment - null.

    tkcp_fbc1_nona char(8) yes fare basis code (FBC) of the basic rule for fare non-adjusted (from quote fare)for partial refund: for travelled segment - value from thequote fare output, fare basis code for non-adjusted;whereas, for refunded segment - null.

    tkcp_fbc2_nona char(8) yes fare basis code (FBC) of the best rule for fare non-adjusted (from quote fare)for partial refund: for travelled segment - value from the

    quote fare output, fare basis code for non-adjusted -used for pensioners/employees; whereas, for refunded

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    17/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 17

    segment - null. (not used for QTT/CLK)tkcp_legs_in_psn smallint yes pricing segment sequence number within the itinerary

    being priced for fare non-adjustedfor partial refund: for travelled segment - value from thequote fare output pricing segment number for non-adjusted; whereas, for refunded segment - null.

    tkcp_leg_non smallint yes itinerary segment sequence number within the pricingsegment for fare non-adjustedfor partial refund: for travelled segment - value from thequote fare output itinerary segment within pricingsegment number for non-adjusted; whereas, forrefunded segment - null.

    tkcp_charge_nona decimal(7,2) yes amount of fare non-adjusted for itinerary segment (fromquote fare)for partial refund: for travelled segment - value from thequote fare output, itinerary segment fare for non-adjusted; whereas, for refunded segment - null.

    tkcp_refund_nona decimal(7,2) yes non-adjusted penalty charge result (from quote fare)for partial refund: for travelled segment - value from thequote fare output, refund penalty for non-adjusted;

    whereas, for refunded segment - null.tkcp_y_class_bf decimal(7,2) yes amount of basic fare for the economy class for the pricingsegment (from quote fare); (not used for QTT/CLK)

    tkcp_service_msg char(60) yes MEAL, SNACK FOR SALE etc. (the service messageprinted on the ticket) (from quote fare) (not used forQTT/CLK)

    tkcp_endorsements char(60) yes ticket endorsement text from pricing rule (from quotefare) (not applicable in price override situation)

    tkcp_no_refund char(1) yes indicator, if true, the pricing segment is not refundable(from quote fare)

    tkcp_s_r_account char(3) no carrier sales account number of the carrier of thisitinerary segment; from Informix.carrier;for full refund - carrier refund account number of the

    carrier of this itinerary segment; from informix.carrier;for partial refund: for travelled segments - carrier salesaccount number of the carrier of this itinerary segment;from informix.carrier; whereas, for refunded segments -carrier refund account number of the carrier of thisitinerary segment; from informix.carrier;

    tkcp_fare_instance smallint yes the fare instance number used for pricing (from quotefare)

    tkcp_rule_instance smallint yes the pricing rule instance number used for pricing (fromquote fare)

    tkcp_attribute char(3) yes the train attributetkcp_mileage smallint yes the distance (in kilometers) from the origin to the

    destination station of this itinerary segment

    tkcp_rev_auto decimal(12,2) yes the rail portion of the collected fare (revenue) attributedto this itinerary segment

    tkcp_rev_nadj decimal(12,2) yes the rail portion of the non-adjusted fare amount attributedto this itinerary segment (it could be blank in case ofprice override when automated pricing is not working)

    tkcp_evnt_rev decimal(12,2) yes the event driven revenue for this itinerary segmenttkcp_super_class char(2) yes super class code;tkcp_xx_notice date yes Notice date that the itinerary segment in the PNR was

    cancelledtkcp_xx_agent_id char(8) yes Agent Id of the user that cancelled the itinerary segment

    in the PNRtkcp_event_coll decimal(7,2) yes Amount Collected for the event

    tkcp_fop1_id char(2) yes First form of payment typetkcp_fop1_amount decimal(7,2) yes Amount of first form of payment for this itinerary segmenttkcp_fop1_gst decimal(6,2) yes Gst on the first form of payment for this itinerary segment

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    18/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 18

    tkcp_fop2_id char(2) yes Second form of payment typetkcp_fop2_amount decimal(7,2) yes Amount of second form of payment for this itinerary

    segmenttkcp_fop2_gst decimal(6,2) yes Gst on the second form of payment for this itinerary

    segmentprice_override_flag char(1) yes Indicator; if true, this itinerary segments fare has been

    overridden

    payment_split_flag char(1) yes Indicator; if true, the split between the amounts for thefirst and second forms of payment of this itinerarysegments fare has been changed

    tkcp_commission decimal(7,2) yes Percentage commission amount of the commissionearned/refunded by an agent; commissionamount=tkcp_comm_perc (times) tkcp_charge_coll (farecollected for sales) or commissionamount=tkcp_comm_perc (times) tkcp_refund_coll (farerefunded for refunds)

    tkcp_commission_gst decimal(7,2) yes GST related to percentage commission amount for agenttkcp_comm_perc decimal(5,2) yes commission rate of the commission earned by an agent;

    based on the ttc_organization of the issuing agent;if today is less than

    informix.ttc_organization/ttco_comm_end_date,informix.ttc_organization/ttco_comm1otherwiseinformix.ttc_organization/ttco_comm2.

    tkcp_flat_commission decimal(7,2) yes Flat rate commission amount earned/refunded by anagent

    tkcp_flat_commission_gst

    decimal(7,2) yes GST related to flat rate commission amount for agent

    tkcp_comm_clawback

    decimal(7,2) yes Commission amount to be clawbacked from initial salesagent

    tkcp_orig_coupon_number

    Integer yes Cross-reference to the ticket coupon on the original salesFTR for reservations that did not change after a ticketexchange.

    4.1.5 informix.ticket_coupon_even (Record type 4)

    This record contains details of the event fare portion of a segment.There will be zero to one instance of this record if a ticket coupon record is displayed(zero instances if a ticket coupon record does not exist)

    Field name Data type Nulls Field description and origin

    fint_trans_date date no system generated transaction date - current systemtoday (YYYY-MM-DD)

    fint_trans_id integer no system generated transaction id - (based on thesyst_fin_lst_num from system_parameter FINTXNoccurrence) . CLK will utilize ID numbers 50001-99999.QTT will utilize ID numbers 30001-50000 until old systemis decommissioned then ID numbers utilized will be 1-50000.Transaction id sequence by default will be reset weeklyon Sunday evenings.

    tkcp_coupon_number integer no itinerary segment sequence number from theticket_coupon

    evnt_event_code char(3) no event code (from quote fare)

    fevn_sequence_num integer no event sequence number within the itinerary segment(from quote fare)

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    19/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 19

    fevn_origin char(4) yes event origin station code (from quote fare)fevn_destination char(4) yes event destination station code (from quote fare)fevn_charges decimal (7,2) yes amount of event charges (from quote fare)fevn_s_r_account char (3) yes event charges sales account number (from

    informix.event table)for full refund: event charges refund account number(from informix.event table)for partial refund: for travelled itinerary segments copiedfrom the corresponding sales transaction record;whereas,for refunded itinerary segments event chargesrefund account number (from informix.event table)

    fevn_event_coll decimal (7,2) yes Collected amount of event charges

    4.1.6 informix.ticket_ssr (Record type 5)

    This record contains special service request information for each passenger.There will be zero or one instance of this record for travel FTRs (zero instances if aticket record does not exist)

    Field name Data type Nulls Field description and origin

    fint_trans_date date no system generated transaction date- current system today(YYYY-MM-DD)

    fint_trans_id integer no system generated transaction id - (based on thesyst_fin_lst_num from system_parameter FINTXNoccurrence) . CLK will utilize ID numbers 50001-99999.QTT will utilize ID numbers 30001-50000 until old systemis decommissioned then ID numbers utilized will be 1-50000.Transaction id sequence by default will be reset weeklyon Sunday evenings.

    tcsr_ssrt_code char(4) no special service request code associated with thepassenger being ticketed

    u_version char(1) yes

    4.1.7 informix.fin_trans_disc_ent (Record type 6) (FTR220)

    This record contains discount entitlement information for each passenger.There will be zero or one instance of this record for travel FTRs (zero instances if aticket record does not exist)

    Field name Data type Nulls Field description and origin

    fint_trans_date date no system generatedfint_trans_id integer no system generated. CLK will utilize ID numbers 50001-

    99999. QTT will utilize ID numbers 30001-50000 until oldsystem is decommissioned then ID numbers utilized willbe 1-50000.Transaction id sequence by default will be reset weeklyon Sunday evenings.

    dent_de_code char(2) no Discount entitlement codedent_de_type char(8) no Discount entitlement typeu_version char(1) yesdent_de_number char(13) yes Discount entitlement number

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    20/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 20

    4.1.8 informix.non_travel_trans (Record type 7) (FTR500)

    This record contains the details of a non travel financial transaction.There will be zero or one instance of this for each financial transaction. (There willeither be a ticket record or a non travel transaction record for each FTR)

    Field name Data type Nulls Field description and origin

    fint_trans_date date no system generated transaction date

    fint_trans_id integer no system generated transaction id. CLK will utilize IDnumbers 50001-99999. QTT will utilize ID numbers30001-50000 until old system is decommissioned then IDnumbers utilized will be 1-50000.Transaction id sequence by default will be reset weeklyon Sunday evenings.

    u_version char(1) yes

    ntvl_pax_name_last char(30) yes passenger last name

    ntvl_pax_name_firs char(20) yes passenger first name

    ntvl_agnt_emp_num char(6) yes agent employee number

    ttct_type_code char(3) yes TTCO type codettco_owner char(8) yes TTCO owner number

    ntvl_tkt_open char(13) yes opening ticket stock number

    ntvl_tkt_close char(13) yes closing ticket stock number

    ntvl_ices_date date yes ICES card date

    ntvl_lost_doc char(1) yes indicator, if true, the document has been reported stolen

    ntvl_description char(33) yes free flow text description

    ntvl_gl_account char(10) yes general ledger account number

    ntvl_stlm_revr_ind char(1) yes indicator, if true, the cash drawer reversed accountingwas used for the cash drawer

    ntvl_psnr_locator char(6) yes NTP Locator

    psnr_locator char(6) yes PNR Locator

    bank_details varchar(255) yes Banking Details

    4.1.9 informix.prod_item_fint_txn (Record type 8) (FTR600)

    This record contains the details of the non travel products sold in a non-travel FTR.There will be zero to many instances of this for each financial transaction (zeroinstances if a non-travel transaction does not exist)

    Field name Data type Nulls Field description and origin

    fint_trans_date date no system generated transaction date

    fint_trans_id integer no system generated transaction id. CLK will utilize IDnumbers 50001-99999. QTT will utilize ID numbers30001-50000 until old system is decommissioned then IDnumbers utilized will be 1-50000.Transaction id sequence by default will be reset weeklyon Sunday evenings.

    prod_product_type char(8) no product type code

    pdit_product_item char(10) no product item code

    u_version char(1) yes

    acnt_num char(3) no cash drawer account numberpift_unit_price decimal(7,2) yes item unit price

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    21/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 21

    pift_quant_sold integer yes quantity sold

    pift_status_ind char(1) yes indicator, if true, the item has been refunded

    fint_total_amt decimal(7,2) yes total amount for products sold (calculated from item unitprice * quantity sold)

    fint_total_gst Decimal(6,2) yes gst on total amount for products sold

    4.1.10 informix.sett_item_fint_txn (Record type 9) (FTR700)

    This record contains the details of the settlement items sold in a non-travel FTR.There will be zero to many instances of this for each financial transaction (zeroinstances if a non-travel transaction does not exist)

    Field name Data type Nulls Field description and origin

    fint_trans_date date no system generated transaction date

    fint_trans_id integer no system generated transaction id. CLK will utilize IDnumbers 50001-99999. QTT will utilize ID numbers

    30001-50000 until old system is decommissioned then IDnumbers utilized will be 1-50000.Transaction id sequence by default will be reset weeklyon Sunday evenings.

    stlm_type char(8) no financial settlement type code

    stit_settle_item char(10) no financial settlement item code

    u_version char(1) yes

    acnt_num char(3) no cash drawer account number

    sift_amount decimal(7,2) yes settlement amount

    acnt_num_cntry char(3) yes cash drawer account number for country sales tax

    sift_tax_country decimal(7,2) yes country sales tax amount - entered by an agent

    acnt_num_prov char(3) yes cash drawer account number for province sales tax

    sift_tax_province decimal(7,2) yes province sales tax amount - entered by an agent

    sift_status_ind char(1) yes indicator, if true, the item has been refunded

    4.1.11 informix.fin_trans_fop (Record type 10) (FTR210)

    This record contains the forms of payment used for each FTR.There may be one to many for each financial transaction.

    Field name Data type Nulls Field description and origin

    fint_trans_date date no system generated transaction date - current systemtoday (YYYY-MM-DD)

    fint_trans_id integer no system generated transaction id - (based on thesyst_fin_lst_num from system_parameter FINTXNoccurrence) . CLK will utilize ID numbers 50001-99999.QTT will utilize ID numbers 30001-50000 until old systemis decommissioned then ID numbers utilized will be 1-50000.Transaction id sequence by default will be reset weeklyon Sunday evenings.

    ffop_sequence_num smallint no form of payment sequence number stating from 1

    u_version char(1) yes

    fpay_fop_id char(2) no form of payment code; from input;

    fpay_s_r_account char(3) yes form of payment sales account; frominformix.form_of_paymentfor refund: form of payment refund account

    ffop_amount decimal(7,2) no amount assigned to this form of payment; from input

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    22/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 22

    ffop_amount_rcv decimal(7,2) yes amount received by the agent/operator; from input;

    ffop_authorize_num char(6) yes authorization number for credit card; from input

    ffop_account_num char(24) yes account number associated with the form of payment, ifany; from input or informix.passenger

    ffop_description char(35) yes description text associated with the from of payment;from input

    ffop_currency char(3) yes currency code; from input (not used for QTT/CLK)ffop_curr_rate decimal(12,6) yes currency rate calculated in relation to Canadian dollar;from iformix.currency/curr_cur_exch_buy (not used forQTT/CLK)

    ffop_accnt_foreign char(3) yes account number for foreign exchange; hard codedaccount number; (not used for QTT/CLK)

    ffop_ttco_type char(3) yes TTCO type for commercial account (not used forQTT/CLK)

    ffop_ttco_owner char(8) yes TTCO owner for commercial account (not used forQTT/CLK)

    ffop_cad_amount decimal(7,2) yes Amount in base currency

    ffop_taxable_ind char(1) yes Taxable indicator

    billing_name varchar(60) yes Name on credit card

    expiry_month char(2) yes Credit card expiry month

    expiry_year char(4) yes Credit card expiry year

    Authorization_dt datetime yes (not used)

    response_id varchar(20) yes (not used)

    bank_id varchar(20 yes (not used)

    iso_code varchar(20 yes (not used)

    trans_id varchar(24 yes Used to store the credit card order number made up ofTTCO of the Agent creating the transaction, the PNRLocator (format 3 alpha and 3 numeric, eg. ABC123), aunique identifier (001, 002 ), and a Sale or Refund

    indicator (S/R). eg. CLK12345678_AAA123_001_Scash_rounding decimal(7,2) yes Cash rounding

    ffop_gst decimal(7,2) yes GST for form of payment

    4.1.12 Trailer Record (Record type 99)

    This table contains some summary information about the current FTR extract.There will be one instance of this for the FTR extract.

    Field name Data type Nulls Field description and originExtract date date no Date of the FTR extract

    Extract time time no Time of the FTR extractTotal record count integer no Number of records in the FTR extract (includes header

    and trailer records)Total Auto fare collected Decimal

    (12,2)no Sum of the automated fare (fint_fare_auto) in the FTR

    extractTrailer name char(23) no Literal CLK will use ORION FTR TRAILER

    RECORD and QTT will use QRORI FTR TRAILERRECORD

    Total FTR count Integer no Number of FTRs in the FTR extract.

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    23/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 23

    4.2 FTR Reconciliation Summary

    4.2.1 Ticket Summary (Record type T)

    This table contains the summary for the Ticket FTRs on the extract.There will be one summary instance for each primary carrier (CLK or QTT) and

    primary TTCO type (CLK or QTT) combination.Also, the final instance will be a summary for all primary carriers (CLK or QTT) andall primary TTCO types (CLK or QTT).

    Since there will only be one primary carrier and primary TTCO type, there will be amaximum of one summary instance for the carrier CLK or QTT and one finalsummary instance.

    Field name Data type Nulls Field description and originFint_iss_ttct_tpcd Char (3) no Issuing TTCO type for the summary record (for the final

    summary instance will be *)

    Tkcp_rsvt_car_code Char (3) no Carrier code for the summary record (for the finalsummary instance will be *)

    Fint_trans_id Integer no Count of the number of ticket FTR records for thissummary

    Tkcp_rev_auto Decimal (12,2) no Sum of the rail portion of the collected fare (revenue)attributed to the itinerary segment in the ticket coupons ofthe ticket FTR records for this summary

    Tkcp_rev_nadj Decimal (12,2) no Sum of the rail portion of the non-adjusted fare amountattributed to the itinerary segment in the ticket coupons ofthe ticket FTR records for this summary

    Tkcp_evnt_rev Decimal (12,2) no Sum of the event driven revenue attribute to the itinerarysegment in the ticket coupons of the ticket FTR recordsfor this summary

    4.2.2 Non-Travel Product Summary (Record type N)

    This table contains the summary for the Non-travel Product FTRs on the extract.There will be one summary instance for each product type and primary TTCO type(CLK or QTT) combination. (ordered by product type)Also, the final instance will be a summary for all product types and all primary TTCOtypes (CLK or QTT).

    Field name Data type Nulls Field description and originFint_iss_ttct_tpcd Char (3) no Issuing TTCO type for the summary record (for the finalsummary instance will be *)

    Prod_product_type Char (8) no Product type for the summary record (for the finalsummary instance will be *)

    Fint_trans_id Integer no Count of the number of non-travel product FTR recordsfor this summary

    Pift_quant_sold*pift_unit_price

    Decimal (12,2) no Sum of the number of products sold and unit prices in thenon-travel product FTR records for this summary

    4.2.3 Financial Settlement Summary (Record type F)

    This table contains the summary for the Financial Settlement FTRs on the extract.

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    24/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 24

    There will be one summary instance for each financial settlement type and primaryTTCO type (CLK or QTT) combination. (ordered by financial settlement type)Also, the final instance will be a summary for all financial settlement types and allprimary TTCO types (CLK or QTT).

    Field name Data type Nulls Field description and originFint_iss_ttct_tpcd Char (3) no Issuing TTCO type for the summary record (for the finalsummary instance will be *)

    Stlm_type Char (8) no Settlement type for the summary record (for the finalsummary instance will be *)

    Fint_trans_id Integer no Count of the number of financial settlement FTR recordsfor this summary

    Sift_amount Decimal (12,2) no Sum of the settlement amounts in the financial settlementFTR records for this summary

    4.3 FTR Reconciliation Detail

    4.3.1 Ticket Coupon (Record type T)

    This table contains the detail for each ticket coupon of the Ticket FTRs on theextract.

    Field name Data type Nulls Field description and originFint_trans_date Date no System generated transaction dateFint_trans_id Integer no System generated transaction idFint_iss_ttct_tpcd Char (3) no Issuing TTCO typeTkcp_rsvt_car_code Char (3) no Carrier codeTkcp_rev_auto Decimal (7,2) no the rail portion of the collected fare (revenue) attributed to

    the itinerary segment in the ticket couponTkcp_rev_nadj Decimal (7,2) no the rail portion of the non-adjusted fare amount attributedto the itinerary segment in the ticket coupon

    Tkcp_evnt_rev Decimal (7,2) no the event driven revenue attribute to the itinerary segmentin the ticket coupon

    4.3.2 Non-Travel Product Item (Record type N)

    This table contains the detail for each product item of the Non-travel Product FTRson the extract.

    Field name Data type Nulls Field description and originFint_trans_date Date no System generated transaction dateFint_trans_id Integer no System generated transaction idFint_iss_ttct_tpcd Char (3) no Issuing TTCO typeProd_product_type Char (8) no product typePift_quant_sold Decimal (7,2) no quantity soldpift_unit_price Decimal (7,2) no item unit price

    4.3.3 Financial Settlement Item (Record type F)

    This table contains the detail for each financial settlement item of the FinancialSettlement FTRs on the extract.

    Field name Data type Nulls Field description and origin

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    25/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 25

    Fint_trans_date Date no System generated transaction dateFint_trans_id Integer no System generated transaction idFint_iss_ttct_tpcd Char (3) no Issuing TTCO typeStlm_type Char (8) no Settlement typeSift_amount Decimal (7,2) no settlement amount

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    26/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 26

    5 Additional Fields

    Fields appearing in the FTR Extract for Orion that were not included in the TravelLink

    FTR Extract are as follows:

    Record type 1

    Field Descriptiononerail_fee Onerail internal use (not required for RC or QR

    Finance)ext_to_financials Date field (not required for RC or QR Finance)gst_rounding1 GST rounding for first fint_trans_fopgst_rounding2 GST rounding for second fint_trans_fopcollected_gst GST collectedtravelled_gst GST related to travelled part of ticket

    refunded_gst GST related to refunded part of ticketautofare_gst GST related to the automated fare fare calculatedby the system

    fint_comm_clawback Commission amount to be clawbacked from initialsales agent

    fint_commission_gst GST related to commission amount for agentfint_flat_commission Flat commission amount for agentfint_flat_commission_gst GST related to flat commission amount for agentfint_obo_ind On-behalf-of indicatorfint_delivery_method Ticket delivery method textfint_delivery_address Ticket delivery address textfint_override_remark Override remarks - text

    Record type 2

    Field Descriptiontket_internet Flag to indicate internet bookingstkct_bus_name Name of business for tax invoicetkct_abn ABN or address of business for tax invoicetket_exchange Flag to indicate ticket used as ticket exchangenonrefundable_gst GST related to the non refundable portion of the tickettket_ntvl_ftr_date For booking fee, FTR date cross reference to the linked

    non-travel product otherwise nulltket_ntvl_ftr_id For booking fee, FTR id cross reference to the linked

    non-travel product otherwise nulltket_sub_date for substitute ticket, FTR date - cross reference to the

    original ticket otherwise null;tket_sub_id for substitute ticket, FTR number - cross reference to the

    original ticket otherwise null;

    Record type 3

    Field Descriptionprice_override_flag Indicator; if true, this itinerary segments fare has

    been overriddenpayment_split_flag Indicator; if true, the split between the amounts for

    the first and second forms of payment of thisitinerary segments fare has been changed

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    27/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 27

    tkcp_commission Percentage commission amount of the commissionearned/refunded by an agent; commissionamount=tkcp_comm_perc (times) tkcp_charge_coll(fare collected for sales) or commissionamount=tkcp_comm_perc (times) tkcp_refund_coll(fare refunded for refunds)

    tkcp_commission_gst GST related to percentage commission amount foragent

    tkcp_comm_perc commission rate of the commission earned by anagent; based on the ttc_organization of the issuingagent;if today is less thaninformix.ttc_organization/ttco_comm_end_da,

    informix.ttc_organization/ttco_comm1otherwiseinformix.ttc_organization/ttco_comm2.

    tkcp_flat_commission Flat rate commission amount earned/refunded byan agent

    tkcp_flat_commission_gst GST related to flat rate commission amount foragent

    tkcp_comm_clawback Commission amount to be clawbacked from initialsales agenttkcp_orig_coupon_number Cross-reference to the ticket coupon on the original

    sales FTR for reservations that did not change aftera ticket exchange.

    Record type 7

    Field Descriptionntvl_psnr_locator NTP Locatorpsnr_locator PNR Locatorbank_details Banking Details

    Record type 10

    Field Descriptionbilling_name Name on credit cardexpiry_month Credit card expiry monthexpiry_year Credit card expiry yearauthorization_dt Credit Card - future use (not required for RC or QR

    Finance)response_id Credit Card - future use (not required for RC or QR

    Finance)bank_id Credit Card - future use (not required for RC or QR

    Finance)iso_code Credit Card - future use (not required for RC or QRFinance)

    trans_id Credit Card - future use (not required for RC or QRFinance)

    cash_rounding Cash roundingffop_gst GST for form of payment

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    28/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 28

    6 Appendix

    6.1 Fare Calculations

    Prices for PNRs and Tickets are calculated in Orion at leg level.

    The Gross fare for each leg (LegnGross) is calculated using the Gross fares from thebasic fares tables in the database (Distance Fares, Zone Fares, Market Fares, EventFares)

    From the Gross fare for each leg (LegnGross), the GST and Net fare are calculatedfor each leg using the following formulas:

    The database fields will be populated as outlined below if there is no fare overrideand there is one form of payment (default cash)(Cash rounding is not being included in these calculations)

    GST rate is stored in the system currently 10%

    LegnGross

    LegnGST = LegnGross * GST rate / (1 + GST rate)

    # tkcp_fop1_gst (ticket_coupon table) if only one FOP is used# ffop_gst (fin_trans_fop table) if only one FOP is used

    LegnNet = LegnGross -LegnGST# tkcp_charge_coll (ticket_coupon table)# tkcp_fop1_amount (ticket_coupon table) if only one FOP is used# ffop_amount (fin_trans_fop table) if only one FOP is used

    Gross Total Fare = Sum of LegnGross

    GST Total Fare = Gross Total Fare * GST rate / (1 + GST rate)# fint_gst_coll (financial_transact table)

    Net Total Fare = Gross Total Fare - GST Total Fare# fint_fare_coll (financial_transact table)

    6.2 Proportioning Calculations

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    29/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 29

    If the fare value is altered by using the Price Override functionality within the PNR,the Net, GST and Gross fares for each leg will be recalculated.

    If more than one form of payment is used, the Net, GST and Gross fares for each legwill be recalculated and apportioned to each form of payment

    Gross Total Fare is taken from the Price Override

    Fop1 Total Gross is taken from the Form of Payment inputFop2 Total Gross is taken from the Form of Payment input

    Either FOP may be altered, with the result always being:Fop1 Total Gross + Fop2 Total Gross = Gross Total Fare

    GST is calculated for each FOPFop1 GST Total = Fop1 Total Gross * GST rate / (1 +GST rate)

    # ffop_gst (fin_trans_fop table)

    Fop2 GST Total = Fop2 Total Gross * GST rate / (1 +GST rate)# ffop_gst (fin_trans_fop table)

    Total GST is calculatedGST Total Fare = Gross Total Fare * GST rate / (1 +GST rate), rounded to 2 decimal places

    Exception: A form of payment may be exclusive of GST. If this is true,GST Total Fare = Fop1 Total GST + Fop2 Total GST

    Calculations are then performed at leg level:

    Each leg is given a weight, calculated by:Weight Legn= Original LegnGross / Original Gross Total

    Gross amount calculated for each leg:FopnLegnGross = (FopnTotal Gross * Weight Legn)+ rounding amount from previous leg,rounded to 2 decimal places

    Rounding amount is the remainder when the Gross is rounded to 2 d.p.Rounding amount for previous leg will be zero for the first leg.

    GST is calculated for each leg:FopnLegnGST = FopnLegnGross / 11, rounded to 2 decimal places.

    # tkcp_fop1_gst (ticket_coupon table)# tkcp_fop2_gst (ticket_coupon table)

    Exception: If form of payment is exclusive of GST.FopnLegnGST = 0

    Net amount is calculated for each leg:

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    30/31

    FTR Extract

    OR-ICD-001-Orion-FTR Extract-Interface-Controlv2.6.docPage 30

    FopnLegnNet = FopnLegnGross - FopnLegnGST# tkcp_fop1_amount (ticket_coupon table)# tkcp_fop2_amount (ticket_coupon table)

    LegnNet = Fop1 LegnNet + Fop2 LegnNet# tkcp_charge_coll (ticket_coupon table)

    GST rounding for FOP1 is calculated to cater for any rounding error when an evendollar amount is divided by 2Fop1 GST Rounding = GST Total Fare - Fop2 GST Total Sum Fop1 LegnGST

    # gst_rounding1 (financial_transact table)

    GST rounding for FOP1 is then calculatedFop2 GST Rounding = Fop2 GST Total Sum Fop2 LegnGST

    # gst_rounding2 (financial_transact table)

    Net Fare is then calculated for each FOPFopnNet Total = Sum of FopnLegnNet - FopnGST Rounding

    # ffop_amount (fin_trans_fop table)

    Then Total Net Fare is calculatedNet Total Fare = Fop1 Net Total + Fop2 Net Total

    # fint_fare_coll (financial_transact table)

  • 8/7/2019 OR-ICD-001-Orion-FTR Extract-Interface-Controlv2 6

    31/31

    FTR Extract

    6.3 File Locations

    6.3.1 CLK File Locations

    The FTR Extract Files for CLK will be available in the following locations:

    6.3.1.1 CLK Production Environment

    The Production FTR extract files will reside in:

    6.3.1.2 CLK Test Environment

    The Test FTR extract files will reside in:

    6.3.1.3 CLK Training Environment

    The Train FTR extract files will reside in:

    6.3.1.4 CLK Disaster Recovery Environment

    The DR FTR extract files will reside in:

    6.3.2 QR File Locations

    The FTR Extract Files for QR will be available in the following locations:

    6.3.2.1 QR Production Environment

    The Production FTR extract files will reside in:qrsftp@sftp://202.146.30.44:5758/toQR/

    6.3.2.2 QR Test Environment

    The Test FTR extract files will reside in:qrsftp_test@sftp://202.146.30.75:5758/toQR/

    6.3.2.3 QR Training Environment

    The Train FTR extract files will reside in:qrsftp_train@sftp://202.146.30.75:5758/toQR/

    6.3.2.4 QR Disaster Recovery Environment

    The DR FTR extract files will reside in:qrsftp_dr@sftp://202.146.30.75:5758/toQR/