An Airbank ticket is a voucher that represents value left over from an airline ticket. This value can be traded at value for services with the airline the original ticket was marketed from.
| name | data type | constraints | description |
|---|---|---|---|
| ticketNumber | string | required | The ticket number of the reservation that this voucher represents. |
| validatingAirline | string | required | The airline that this ticket was originally marketed from. |
| pcc | string | The pseudo city code that this ticket was bought in. | |
| invoiceNumber | number | The invoice number associated with this ticket. | |
| recordLocator | string | required | The record locator that this ticket is from. |
| airlineLocator | string | The confirmation number that the ticket is associated with. | |
| refundable | boolean | required boolean | Whether or not this ticket is refundable for cash. |
| ticketDate | number | The date the ticket was invoiced. | |
| expireDate | number | The date that this voucher will expire. Typically a year after issue. | |
| departDate | number | The departure date of the flight this ticket was associated with. | |
| manuallyAdded | boolean | required boolean | Whether or not this voucher was added manually. |
| dateAdded | number | required | The date this voucher was added to Airportal. |
| status | string | The current status of this voucher. | |
| ticketType | string | required | The type of ticket the voucher is connected to. |
| gds | GlobalDistributionSystem | The GDS that this ticket exists in. | |
| notes | string | Any notes about this voucher. | |
| value | number | The current value of this voucher. | |
| client | Client | required | The account that this voucher belongs to. |
| user | User | The traveler that this voucher belongs to. | |
| history | array of History | The last 10 transactions inflicted upon this voucher. | |
| obeSyncLog | array of ObeSyncLog | A list of synchronizations with the online booking tool for this account. | |
| returnDate | number | The completion date of the flight this ticket is associated with. | |
| penalty | number | The estimated penalty that exchanging this ticket will cost. | |
| firstName | string | The first name of the traveler that owns this voucher. | |
| middleName | string | The middle name of the traveler that owns this voucher. | |
| lastName | string | The last name of the traveler that owns this voucher. | |
| string | The email address of the traveler that owns this voucher. | ||
| obeSynced | boolean | Whether or not this ticket currently exists in the account's online booking tool. | |
| auditState | number | ||
| everUnused | boolean | required boolean | |
| agent | EmployeeInfo | The agent that invoiced the ticket. | |
| creditCardType | string | ||
| creditCardNumber | string | ||
| transactions | array of Transaction | ||
| transferable | boolean | required boolean | Whether or not this ticket is transferable to another user in the same company. |
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" : "...",
"validatingAirline" : "...",
"pcc" : "...",
"invoiceNumber" : 12345,
"recordLocator" : "...",
"airlineLocator" : "...",
"refundable" : true,
"ticketDate" : 12345,
"expireDate" : 12345,
"departDate" : 12345,
"manuallyAdded" : true,
"dateAdded" : 12345,
"status" : "...",
"ticketType" : "...",
"gds" : {
"code" : "...",
"name" : "...",
"enabled" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"notes" : "...",
"value" : 12345.0,
"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" : "..."
} ]
},
"user" : {
"answer" : "...",
"emailed" : true,
"newUser" : true,
"temporaryPassword" : "...",
"question" : "...",
"obeUserName" : "...",
"obePassword" : "...",
"obeSyncId" : "...",
"created" : 12345,
"modifiedDate" : 12345,
"emailedWhen" : 12345,
"travelgpaLogin" : "...",
"groups" : [ {
"name" : "...",
"permissions" : [ { }, { } ],
"description" : "...",
"role" : { },
"type" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
}, {
"name" : "...",
"permissions" : [ { }, { } ],
"description" : "...",
"role" : { },
"type" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
} ],
"active" : true,
"prefix" : "...",
"firstName" : "...",
"lastName" : "...",
"middleName" : "...",
"suffix" : "...",
"email" : "...",
"tripitAuthorized" : true,
"supportTitle" : "...",
"automatedNotifications" : true,
"enableHotelAttachment" : true,
"atHomeNotificationMethod" : {
"name" : "...",
"code" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"inTravelNotificationMethod" : {
"name" : "...",
"code" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"cellPhoneNumber" : "...",
"userCurrentClient" : {
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"defaultClient" : {
"status" : { },
"parentClient" : { },
"accountNumber" : "...",
"name" : "...",
"type" : { },
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"defaultPlannerGroup" : {
"status" : { },
"parentClient" : { },
"accountNumber" : "...",
"name" : "...",
"type" : { },
"id" : 12345,
"version" : 12345,
"violations" : [ { }, { } ]
},
"showWelcomeDialog" : true,
"siteTour" : true,
"unusedTicketEmail" : true,
"surveyEmail" : true,
"wt0EmailEnabled" : true,
"wt0EmailDaily" : true,
"wt0EmailDay" : 12345,
"wt0EmailHour" : 12345,
"marketingSubscribed" : true,
"responsive" : true,
"businessPhoneNumber" : "...",
"homePhoneNumber" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"history" : [ {
"timestamp" : 12345,
"userName" : "...",
"field" : "...",
"oldValue" : "...",
"newValue" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}, {
"timestamp" : 12345,
"userName" : "...",
"field" : "...",
"oldValue" : "...",
"newValue" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
} ],
"obeSyncLog" : [ {
"timestamp" : 12345,
"action" : "...",
"success" : true,
"response" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}, {
"timestamp" : 12345,
"action" : "...",
"success" : true,
"response" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
} ],
"returnDate" : 12345,
"penalty" : 12345.0,
"firstName" : "...",
"middleName" : "...",
"lastName" : "...",
"email" : "...",
"obeSynced" : true,
"auditState" : 12345,
"everUnused" : true,
"agent" : {
"user" : {
"answer" : "...",
"emailed" : true,
"newUser" : true,
"temporaryPassword" : "...",
"question" : "...",
"obeUserName" : "...",
"obePassword" : "...",
"obeSyncId" : "...",
"created" : 12345,
"modifiedDate" : 12345,
"emailedWhen" : 12345,
"travelgpaLogin" : "...",
"groups" : [ { }, { } ],
"active" : true,
"prefix" : "...",
"firstName" : "...",
"lastName" : "...",
"middleName" : "...",
"suffix" : "...",
"email" : "...",
"tripitAuthorized" : true,
"supportTitle" : "...",
"automatedNotifications" : true,
"enableHotelAttachment" : true,
"atHomeNotificationMethod" : { },
"inTravelNotificationMethod" : { },
"cellPhoneNumber" : "...",
"userCurrentClient" : { },
"defaultClient" : { },
"defaultPlannerGroup" : { },
"showWelcomeDialog" : true,
"siteTour" : true,
"unusedTicketEmail" : true,
"surveyEmail" : true,
"wt0EmailEnabled" : true,
"wt0EmailDaily" : true,
"wt0EmailDay" : 12345,
"wt0EmailHour" : 12345,
"marketingSubscribed" : true,
"responsive" : true,
"businessPhoneNumber" : "...",
"homePhoneNumber" : "...",
"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,
"onsiteAgent" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
},
"creditCardType" : "...",
"creditCardNumber" : "...",
"transactions" : [ {
"timestamp" : 12345,
"description" : "...",
"debit" : 12345.0,
"credit" : 12345.0,
"travelerName" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}, {
"timestamp" : 12345,
"description" : "...",
"debit" : 12345.0,
"credit" : 12345.0,
"travelerName" : "...",
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
} ],
"transferable" : true,
"id" : 12345,
"version" : 12345,
"violations" : [ {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
}, {
"propertyName" : "...",
"failureMessage" : "...",
"stackTrace" : "..."
} ]
}