invoice Data Type

An invoice represents a transaction of booking. So if a traveler pays for his whole itinerary on one credit card at the same time, he'll have one invoice.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs constraints description
agent employeeInfo element 0/1   The agent that ran the invoice.
airJustification airJustification element 0/1   The reason code for why the lowest fare was not chosen.
assistingAgent employeeInfo element 0/1   The agent that is physically running the ticket. This person may not be getting the commission.
carJustification carJustification element 0/1   The reason code as to why the lowest rate or preferred car rental was not chosen.
feeJustification feeJustification element 0/1   The reason code as to why the service fee is not the normal amount.
highFare double element 0/1   The high fare is the highest amount that the invoice may have cost.
hotelJustification hotelJustification element 0/1   The reason code as to why the lowest rate or preferred hotel was not chosen.
issueDate dateTime element 0/1   The issued date of the reservation.
itinerary itinerary element 1/1 required The itinerary that this invoice pays for.
lowFare double element 0/1   The lowest amount that the invoice may have cost.
number string element 0/1 max size: 32, min size: 0  
reservations list of reservation element 0/unbounded    
Properties inherited from baseHibernateEntity
id long element 0/1   The unique internal ID of the object.
version long element 0/1   For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions.
Properties inherited from baseEntity
violations list of simpleViolation element 0/unbounded   A list of constraint violations, if any, that this object has.

Example

<invoice>
  <itinerary>
    <recordLocator>...</recordLocator>
    <agentName>...</agentName>
    <client>
      <status/>
      <parentClient/>
      <accountNumber>...</accountNumber>
      <name>...</name>
      <type/>
    </client>
    <office>
      <pcc>...</pcc>
      <name>...</name>
      <address1>...</address1>
      <address2>...</address2>
      <address3>...</address3>
      <city>...</city>
      <state>...</state>
      <zip>...</zip>
      <parentCompany/>
      <active>...</active>
      <branch>...</branch>
      <clientPrefix>...</clientPrefix>
      <profileSettings/>
      <afterHoursNumber>...</afterHoursNumber>
      <collectVoidLogs>...</collectVoidLogs>
      <gds/>
      <arcNumber>...</arcNumber>
      <logo>...</logo>
      <logoLink>...</logoLink>
      <afterHoursInternationalNumber>...</afterHoursInternationalNumber>
      <tollFreeNumber>...</tollFreeNumber>
      <phoneNumber>...</phoneNumber>
      <onlineOffice/>
      <showTmcAppLinks>...</showTmcAppLinks>
      <vipTollFree>...</vipTollFree>
      <vipAfterHours>...</vipAfterHours>
      <cityCode/>
      <tmcHeadQuarters>...</tmcHeadQuarters>
    </office>
    <departureDate>...</departureDate>
    <completionDate>...</completionDate>
    <importDate>...</importDate>
    <gds>
      <code>...</code>
      <name>...</name>
      <enabled>...</enabled>
    </gds>
    <latest>...</latest>
    <citySummary>...</citySummary>
    <departureCity>
      <code>...</code>
      <countryCode>...</countryCode>
      <latitude>...</latitude>
      <longitude>...</longitude>
      <name>...</name>
      <stateOrCountry>...</stateOrCountry>
      <airportName>...</airportName>
      <region/>
      <timeZone/>
      <retentionOnly>...</retentionOnly>
      <position>...</position>
      <unique>...</unique>
      <alias>...</alias>
    </departureCity>
    <arrivalCity>
      <code>...</code>
      <countryCode>...</countryCode>
      <latitude>...</latitude>
      <longitude>...</longitude>
      <name>...</name>
      <stateOrCountry>...</stateOrCountry>
      <airportName>...</airportName>
      <region/>
      <timeZone/>
      <retentionOnly>...</retentionOnly>
      <position>...</position>
      <unique>...</unique>
      <alias>...</alias>
    </arrivalCity>
    <arrivalDate>...</arrivalDate>
    <utcArrivalDate>...</utcArrivalDate>
    <startDate>...</startDate>
    <endDate>...</endDate>
    <purpose>...</purpose>
    <explanation>...</explanation>
    <authorizationCode>...</authorizationCode>
    <costCenterCode>...</costCenterCode>
    <departmentCode>...</departmentCode>
    <clientCode>...</clientCode>
    <regionCode>...</regionCode>
    <billable>...</billable>
    <travelerCode>...</travelerCode>
    <managerCode>...</managerCode>
    <projectCode>...</projectCode>
    <status>
      <name>...</name>
      <position>...</position>
    </status>
    <observers>
      <status/>
      <parentClient/>
      <accountNumber>...</accountNumber>
      <name>...</name>
      <type/>
    </observers>
    <id>...</id>
    <version>...</version>
  </itinerary>
  <number>...</number>
  <reservations>
    <ticketNumber>...</ticketNumber>
    <issueDate>...</issueDate>
    <electronic>...</electronic>
    <type>
      <name>...</name>
    </type>
    <status>
      <name>...</name>
    </status>
    <payments>
      <amount>...</amount>
      <currency>...</currency>
      <paymentCode>...</paymentCode>
      <creditCardType>...</creditCardType>
      <notes>...</notes>
      <lastDigits>...</lastDigits>
    </payments>
    <hidden>...</hidden>
    <passengerName>...</passengerName>
    <totalAmount>...</totalAmount>
    <baseAmount>...</baseAmount>
    <taxes>
      <amount>...</amount>
      <code>...</code>
    </taxes>
    <vendor>...</vendor>
    <addCollect>...</addCollect>
    <commissionAmount>...</commissionAmount>
    <refundable>...</refundable>
    <exchangedTicketNumber>...</exchangedTicketNumber>
    <fareCalculation>...</fareCalculation>
    <endorsement>...</endorsement>
    <id>...</id>
    <version>...</version>
  </reservations>
  <lowFare>...</lowFare>
  <highFare>...</highFare>
  <agent>
    <user>
      <answer>...</answer>
      <emailed>...</emailed>
      <newUser>...</newUser>
      <temporaryPassword>...</temporaryPassword>
      <question>...</question>
      <obeUserName>...</obeUserName>
      <obePassword>...</obePassword>
      <obeSyncId>...</obeSyncId>
      <created>...</created>
      <modifiedDate>...</modifiedDate>
      <emailedWhen>...</emailedWhen>
      <travelgpaLogin>...</travelgpaLogin>
      <groups/>
      <active>...</active>
      <prefix>...</prefix>
      <firstName>...</firstName>
      <lastName>...</lastName>
      <middleName>...</middleName>
      <suffix>...</suffix>
      <email>...</email>
      <tripitAuthorized>...</tripitAuthorized>
      <supportTitle>...</supportTitle>
      <automatedNotifications>...</automatedNotifications>
      <enableHotelAttachment>...</enableHotelAttachment>
      <atHomeNotificationMethod/>
      <inTravelNotificationMethod/>
      <cellPhoneNumber>...</cellPhoneNumber>
      <userCurrentClient/>
      <defaultClient/>
      <defaultPlannerGroup/>
      <showWelcomeDialog>...</showWelcomeDialog>
      <siteTour>...</siteTour>
      <unusedTicketEmail>...</unusedTicketEmail>
      <surveyEmail>...</surveyEmail>
      <wt0EmailEnabled>...</wt0EmailEnabled>
      <wt0EmailDaily>...</wt0EmailDaily>
      <wt0EmailDay>...</wt0EmailDay>
      <wt0EmailHour>...</wt0EmailHour>
      <marketingSubscribed>...</marketingSubscribed>
      <responsive>...</responsive>
      <businessPhoneNumber>...</businessPhoneNumber>
      <homePhoneNumber>...</homePhoneNumber>
    </user>
    <agentCode>...</agentCode>
    <office>
      <pcc>...</pcc>
      <name>...</name>
      <address1>...</address1>
      <address2>...</address2>
      <address3>...</address3>
      <city>...</city>
      <state>...</state>
      <zip>...</zip>
      <parentCompany/>
      <active>...</active>
      <branch>...</branch>
      <clientPrefix>...</clientPrefix>
      <profileSettings/>
      <afterHoursNumber>...</afterHoursNumber>
      <collectVoidLogs>...</collectVoidLogs>
      <gds/>
      <arcNumber>...</arcNumber>
      <logo>...</logo>
      <logoLink>...</logoLink>
      <afterHoursInternationalNumber>...</afterHoursInternationalNumber>
      <tollFreeNumber>...</tollFreeNumber>
      <phoneNumber>...</phoneNumber>
      <onlineOffice/>
      <showTmcAppLinks>...</showTmcAppLinks>
      <vipTollFree>...</vipTollFree>
      <vipAfterHours>...</vipAfterHours>
      <cityCode/>
      <tmcHeadQuarters>...</tmcHeadQuarters>
    </office>
    <workEmail>...</workEmail>
    <active>...</active>
    <type>...</type>
    <emailList>...</emailList>
    <category>...</category>
    <directLine>...</directLine>
    <hours>...</hours>
    <onlineAgent>...</onlineAgent>
    <recheckEmails>...</recheckEmails>
    <serviceFeesPct>...</serviceFeesPct>
    <otherServiceFeesPct>...</otherServiceFeesPct>
    <internationalAirCommissionPct>...</internationalAirCommissionPct>
    <miscCommissionPct>...</miscCommissionPct>
    <airCommissionPct>...</airCommissionPct>
    <hotelCommissionPct>...</hotelCommissionPct>
    <carCommissionPct>...</carCommissionPct>
    <employeeType>
      <code>...</code>
      <name>...</name>
    </employeeType>
    <ticketingAgent>...</ticketingAgent>
    <supportAgent>...</supportAgent>
    <onsiteAgent>...</onsiteAgent>
    <id>...</id>
    <version>...</version>
  </agent>
  <airJustification>
    <code>...</code>
    <description>...</description>
    <bcdCode>...</bcdCode>
    <id>...</id>
    <version>...</version>
  </airJustification>
  <hotelJustification>
    <code>...</code>
    <description>...</description>
    <allowsHotelAttachment>...</allowsHotelAttachment>
    <bcdCode>...</bcdCode>
    <id>...</id>
    <version>...</version>
  </hotelJustification>
  <carJustification>
    <code>...</code>
    <description>...</description>
    <id>...</id>
    <version>...</version>
  </carJustification>
  <feeJustification>
    <code>...</code>
    <description>...</description>
    <id>...</id>
    <version>...</version>
  </feeJustification>
  <assistingAgent>
    <user>
      <answer>...</answer>
      <emailed>...</emailed>
      <newUser>...</newUser>
      <temporaryPassword>...</temporaryPassword>
      <question>...</question>
      <obeUserName>...</obeUserName>
      <obePassword>...</obePassword>
      <obeSyncId>...</obeSyncId>
      <created>...</created>
      <modifiedDate>...</modifiedDate>
      <emailedWhen>...</emailedWhen>
      <travelgpaLogin>...</travelgpaLogin>
      <groups/>
      <active>...</active>
      <prefix>...</prefix>
      <firstName>...</firstName>
      <lastName>...</lastName>
      <middleName>...</middleName>
      <suffix>...</suffix>
      <email>...</email>
      <tripitAuthorized>...</tripitAuthorized>
      <supportTitle>...</supportTitle>
      <automatedNotifications>...</automatedNotifications>
      <enableHotelAttachment>...</enableHotelAttachment>
      <atHomeNotificationMethod/>
      <inTravelNotificationMethod/>
      <cellPhoneNumber>...</cellPhoneNumber>
      <userCurrentClient/>
      <defaultClient/>
      <defaultPlannerGroup/>
      <showWelcomeDialog>...</showWelcomeDialog>
      <siteTour>...</siteTour>
      <unusedTicketEmail>...</unusedTicketEmail>
      <surveyEmail>...</surveyEmail>
      <wt0EmailEnabled>...</wt0EmailEnabled>
      <wt0EmailDaily>...</wt0EmailDaily>
      <wt0EmailDay>...</wt0EmailDay>
      <wt0EmailHour>...</wt0EmailHour>
      <marketingSubscribed>...</marketingSubscribed>
      <responsive>...</responsive>
      <businessPhoneNumber>...</businessPhoneNumber>
      <homePhoneNumber>...</homePhoneNumber>
    </user>
    <agentCode>...</agentCode>
    <office>
      <pcc>...</pcc>
      <name>...</name>
      <address1>...</address1>
      <address2>...</address2>
      <address3>...</address3>
      <city>...</city>
      <state>...</state>
      <zip>...</zip>
      <parentCompany/>
      <active>...</active>
      <branch>...</branch>
      <clientPrefix>...</clientPrefix>
      <profileSettings/>
      <afterHoursNumber>...</afterHoursNumber>
      <collectVoidLogs>...</collectVoidLogs>
      <gds/>
      <arcNumber>...</arcNumber>
      <logo>...</logo>
      <logoLink>...</logoLink>
      <afterHoursInternationalNumber>...</afterHoursInternationalNumber>
      <tollFreeNumber>...</tollFreeNumber>
      <phoneNumber>...</phoneNumber>
      <onlineOffice/>
      <showTmcAppLinks>...</showTmcAppLinks>
      <vipTollFree>...</vipTollFree>
      <vipAfterHours>...</vipAfterHours>
      <cityCode/>
      <tmcHeadQuarters>...</tmcHeadQuarters>
    </office>
    <workEmail>...</workEmail>
    <active>...</active>
    <type>...</type>
    <emailList>...</emailList>
    <category>...</category>
    <directLine>...</directLine>
    <hours>...</hours>
    <onlineAgent>...</onlineAgent>
    <recheckEmails>...</recheckEmails>
    <serviceFeesPct>...</serviceFeesPct>
    <otherServiceFeesPct>...</otherServiceFeesPct>
    <internationalAirCommissionPct>...</internationalAirCommissionPct>
    <miscCommissionPct>...</miscCommissionPct>
    <airCommissionPct>...</airCommissionPct>
    <hotelCommissionPct>...</hotelCommissionPct>
    <carCommissionPct>...</carCommissionPct>
    <employeeType>
      <code>...</code>
      <name>...</name>
    </employeeType>
    <ticketingAgent>...</ticketingAgent>
    <supportAgent>...</supportAgent>
    <onsiteAgent>...</onsiteAgent>
    <id>...</id>
    <version>...</version>
  </assistingAgent>
  <issueDate>...</issueDate>
  <id>...</id>
  <version>...</version>
  <violations/>
</invoice>