ClientItinerarySetting Data Type

An object defining the basic abilities we want all of our hibernate objects to have.

Properties
name data type description
showSegments boolean Whether to show the segments for an itinerary.
showInvoices boolean Whether to show the invoices for an itinerary.
showCreditCard boolean Whether to show the credit card for an itinerary
showCorpDiscount boolean Whether the client wants to show the corporate discount number or not.
showInvoiceHistory boolean Whether or not to show all invoice history.
showPdf boolean Whether or not to send the pdf.
showClientName boolean Whether or not to show the client's name at the top of the itinerary.
showServiceFees boolean Whether or not to show the service fees.
showCalendar boolean Whether or not to send the itinerary as a calendar.
overrideEmail string An email that all itineraries for this client should be sent to instead of their passengers.
client Client
showTravelPolicy boolean True / false whether to show the travel policy.
overrideFromAddress string Override the email that all emails come from.
overrideFromName string Override the agent name that all emails come from.
multiEventCalendar boolean
whiteLabel boolean
showPastSegments boolean true / false whether to show past segments. This is adjusted upon how the user chooses to view the airtinerary and is not persistent.
showAgent boolean true / false whether to hide the agent name in the itinerary.
invoiceFirst boolean
showTaxes boolean
udid number The udid # of the udid to show at the top of the itinerary.
udid2 number
showExchangeDetails boolean
showMembership boolean
showTaxTotals boolean
showCarMembership boolean
showExtendedCreditCard boolean
showAirDetails boolean
showHotelDetails boolean
showCarDetails boolean
sendText boolean
showHotelSpecialPrint boolean
emailTemplate EmailTemplate Email template override in case the client wants a special format custom to just them.
showHotelFax boolean Whether or not to show the hotel's fax number.
includeSegmentsInEstimates boolean Whether or not to include car and hotel amounts into the estimated totals on PNRs.
noCarbonCopy boolean Make all CCs BCCs instead by default for this client.
utcCalendar boolean Whether or not to send the calendars in UTC time as opposed to local time.
showPromos boolean Whether or not to show promotional links or banners on the client's itineraries.
passengerInvoices boolean Whether or not to group the tickets by passenger instead of invoice.
showReservationsInCalendar boolean Whether or not to show car/hotel reservations in calendars.
shortReservationsInCalendar boolean Whether or not to only have check-in times as the reminder for cars & hotels.
showHotelTotals boolean Whether or not to display hotel totals in Airtineraries.
showTicketEstimates boolean Whether or not to include ticket (air) estimates on Airtineraries.
showOneTicketPerType boolean Merge all of one ticket type into one ticket number.
showCarTotals boolean Whether or not to display car totals in Airtineraries.
showHotelTax boolean Whether or not to display hotel tax info in Airtineraries.
showNamesInCalendarEvents boolean Whether or not to display passenger names in every calendar event.
outlookSafeCalendar boolean Whether or not to use outlook safe triggers in calendars.
segmentCalendars boolean Whether or not to separate each segment into its own calendar.
showTerminal boolean Whether or not to show terminal information on air segments.
zeroInvoices boolean Whether or not to show zero amount invoices on itineraries.
serviceFeeVendor string The default name to use for service fee reservations.
showRefunds boolean Whether or not to show refunded amounts on invoices.
showHotelSupplementalInstructions boolean Whether or not to show hotel supplemental instructions in the notes of hotel segments.
showCarSupplementalInstructions boolean Whether or not to show car supplemental instructions in the notes of car segments.
showHotelRateEndDates boolean Whether or not to show the end dates for effective dates on hotel rate changes.
showHotelRoomDescriptions boolean Whether or not to show the room descriptions on hotels.
showApprovalFare boolean Whether or not to show invoice information on travel approvals.
showHiddenTickets boolean Whether or not to show inactive tickets on the itineraries.
Properties inherited from BaseHibernateEntity
id number The unique internal ID of the object.
version number For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions.
Properties inherited from BaseEntity
violations array of SimpleViolation A list of constraint violations, if any, that this object has.

Example

{
  "showSegments" : true,
  "showInvoices" : true,
  "showCreditCard" : true,
  "showCorpDiscount" : true,
  "showInvoiceHistory" : true,
  "showPdf" : true,
  "showClientName" : true,
  "showServiceFees" : true,
  "showCalendar" : true,
  "overrideEmail" : "...",
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "showTravelPolicy" : true,
  "overrideFromAddress" : "...",
  "overrideFromName" : "...",
  "multiEventCalendar" : true,
  "whiteLabel" : true,
  "showPastSegments" : true,
  "showAgent" : true,
  "invoiceFirst" : true,
  "showTaxes" : true,
  "udid" : 12345,
  "udid2" : 12345,
  "showExchangeDetails" : true,
  "showMembership" : true,
  "showTaxTotals" : true,
  "showCarMembership" : true,
  "showExtendedCreditCard" : true,
  "showAirDetails" : true,
  "showHotelDetails" : true,
  "showCarDetails" : true,
  "sendText" : true,
  "showHotelSpecialPrint" : true,
  "emailTemplate" : {
    "subject" : "...",
    "code" : "...",
    "name" : "...",
    "htmlContent" : "...",
    "design" : {
      "header" : "...",
      "footer" : "...",
      "style" : "...",
      "includeUnsubscribeLink" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "fromName" : "...",
    "fromAddress" : "...",
    "textContent" : "...",
    "smtpHost" : "...",
    "hostUser" : "...",
    "hostPassword" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "showHotelFax" : true,
  "includeSegmentsInEstimates" : true,
  "noCarbonCopy" : true,
  "utcCalendar" : true,
  "showPromos" : true,
  "passengerInvoices" : true,
  "showReservationsInCalendar" : true,
  "shortReservationsInCalendar" : true,
  "showHotelTotals" : true,
  "showTicketEstimates" : true,
  "showOneTicketPerType" : true,
  "showCarTotals" : true,
  "showHotelTax" : true,
  "showNamesInCalendarEvents" : true,
  "outlookSafeCalendar" : true,
  "segmentCalendars" : true,
  "showTerminal" : true,
  "zeroInvoices" : true,
  "serviceFeeVendor" : "...",
  "showRefunds" : true,
  "showHotelSupplementalInstructions" : true,
  "showCarSupplementalInstructions" : true,
  "showHotelRateEndDates" : true,
  "showHotelRoomDescriptions" : true,
  "showApprovalFare" : true,
  "showHiddenTickets" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}