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.

Properties
name data type constraints description
itinerary Itinerary required The itinerary that this invoice pays for.
number string max size: 32, min size: 0
reservations array of Reservation  
lowFare number   The lowest amount that the invoice may have cost.
highFare number   The high fare is the highest amount that the invoice may have cost.
agent EmployeeInfo   The agent that ran the invoice.
airJustification AirJustification   The reason code for why the lowest fare was not chosen.
hotelJustification HotelJustification   The reason code as to why the lowest rate or preferred hotel was not chosen.
carJustification CarJustification   The reason code as to why the lowest rate or preferred car rental was not chosen.
feeJustification FeeJustification   The reason code as to why the service fee is not the normal amount.
assistingAgent EmployeeInfo   The agent that is physically running the ticket. This person may not be getting the commission.
issueDate number   The issued date of the reservation.
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

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