1. Home
2. JSON
3. ClientTravelPolicy

ClientTravelPolicy Data Type

Travel Policy for a client, including air, car and hotel travel settings.

Properties

name	data type	constraints	description
client	Client	required	The client that this travel policy is for.
approvalRequirement	ClientTravelPolicyApproval
designatedApprover	User
airRefundable	boolean	required boolean
airHasContract	boolean	required boolean
airNumberStops	ClientTravelPolicyStops
airTimeWindowPreference	ClientTravelPolicyPreference
airAirportPreference	ClientTravelPolicyPreference
airAdvancedPurchase	number
airThreshold	number
airThresholdPercent	number
airThresholdAction	ClientTravelPolicyAction
airServiceClass	ClientTravelPolicyServiceClass
airExceptionsAllowed	boolean	required boolean
airNonPreferredVendor	boolean	required boolean
airNonPreferredVendorAction	ClientTravelPolicyAction
airRefundableSearch	boolean	required boolean
hotelReimburseRate	number
hotelReimburseRateAction	ClientTravelPolicyAction
hotelExceptionAction	ClientTravelPolicyAction
hotelNonPreferredVendor	boolean	required boolean
hotelNonPreferredVendorAction	ClientTravelPolicyAction
carSizeLimitAction	ClientTravelPolicyAction
carMaxDailyRate	number
carMaxDailyRateAction	ClientTravelPolicyAction
carNonPreferredVendor	boolean	required boolean
carNonPreferredVendorAction	ClientTravelPolicyAction
railAllowed	boolean	required boolean
railBusinessAllowed	boolean	required boolean
notes	string	max size: 2048, min size: 0
locked	boolean	required boolean
dateLockExpired	boolean	required boolean
locksAfter	number		Days after creation to auto lock
airIsLowestLogical	boolean	required boolean
updated	number
overrideParentAir	boolean	required boolean
overrideParentHotel	boolean	required boolean
overrideParentCar	boolean	required boolean
overrideParentGeneral	boolean	required boolean
sendEmailAfterTicketing	boolean	required boolean	Send an email after ticketing.
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

{
  "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" : "..."
    } ]
  },
  "approvalRequirement" : {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "designatedApprover" : {
    "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" : "..."
    } ]
  },
  "airRefundable" : true,
  "airHasContract" : true,
  "airNumberStops" : {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "airTimeWindowPreference" : {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "airAirportPreference" : {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "airAdvancedPurchase" : 12345,
  "airThreshold" : 12345,
  "airThresholdPercent" : 12345.0,
  "airThresholdAction" : {
    "name" : "...",
    "description" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "airServiceClass" : {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "airExceptionsAllowed" : true,
  "airNonPreferredVendor" : true,
  "airNonPreferredVendorAction" : {
    "name" : "...",
    "description" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "airRefundableSearch" : true,
  "hotelReimburseRate" : 12345,
  "hotelReimburseRateAction" : {
    "name" : "...",
    "description" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "hotelExceptionAction" : {
    "name" : "...",
    "description" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "hotelNonPreferredVendor" : true,
  "hotelNonPreferredVendorAction" : {
    "name" : "...",
    "description" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "carSizeLimitAction" : {
    "name" : "...",
    "description" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "carMaxDailyRate" : 12345,
  "carMaxDailyRateAction" : {
    "name" : "...",
    "description" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "carNonPreferredVendor" : true,
  "carNonPreferredVendorAction" : {
    "name" : "...",
    "description" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "railAllowed" : true,
  "railBusinessAllowed" : true,
  "notes" : "...",
  "locked" : true,
  "dateLockExpired" : true,
  "locksAfter" : 12345,
  "airIsLowestLogical" : true,
  "updated" : 12345,
  "overrideParentAir" : true,
  "overrideParentHotel" : true,
  "overrideParentCar" : true,
  "overrideParentGeneral" : true,
  "sendEmailAfterTicketing" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}