Reservation Data Type

A reservation is a ticket or receipt made for a trip. This also includes service or penalty fees, but not car and hotel reservations because those are not charged at the time of reservation.

Properties
name data type constraints description
ticketNumber string max size: 16, min size: 0 The ticket number of the reservation.
issueDate number   The issued date of the reservation.
electronic boolean required boolean true / false if this ticket was booked electronically
type ReservationType required The travel type this reservation is for.
status ReservationStatus required The status of this ticket.
payments array of Payment   The payments for this reservation.
hidden boolean required boolean Whether the reservation should be hidden by the end user or not.
passengerName string   The passenger name that is on the ticket.
totalAmount number   The total amount that is owed.
baseAmount number   The amount that is owed before taxes.
taxes array of ReservationTax   The taxes included with this fare.
vendor string   The name of the vendor receiving the funds for this ticket.
addCollect number   The amount that must be paid to make the difference after an exchange.
commissionAmount number   The commission amount the agency can expect for this ticket.
refundable boolean required boolean Whether or not this ticket is refundable.
exchangedTicketNumber string   The number for the ticket that was exchanged for this one.
fareCalculation string   The fare calculation is a short explanation of the fares and their pricing.
endorsement string   Returns the endorsement describing the restrictions of the fare
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

{
  "ticketNumber" : "...",
  "issueDate" : 12345,
  "electronic" : true,
  "type" : {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "status" : {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "payments" : [ {
    "amount" : 12345.0,
    "currency" : "...",
    "paymentCode" : "...",
    "creditCardType" : "...",
    "notes" : "...",
    "lastDigits" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "amount" : 12345.0,
    "currency" : "...",
    "paymentCode" : "...",
    "creditCardType" : "...",
    "notes" : "...",
    "lastDigits" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "hidden" : true,
  "passengerName" : "...",
  "totalAmount" : 12345.0,
  "baseAmount" : 12345.0,
  "taxes" : [ {
    "amount" : 12345.0,
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "amount" : 12345.0,
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "vendor" : "...",
  "addCollect" : 12345.0,
  "commissionAmount" : 12345.0,
  "refundable" : true,
  "exchangedTicketNumber" : "...",
  "fareCalculation" : "...",
  "endorsement" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}