HplSettings Data Type

HPL Settings stores the configuration for how Airportal should create payment remittances for hotel services. User: Kurt Stauffer Date: 9/24/13 Time: 9:45 AM

Properties
name data type constraints description
hplEnabled boolean required boolean is the configuration enabled to be processed by the virtual pay service
hplLite boolean required boolean does the client forgo using a generated virtual card in favor of an insecure physical card
allowAllHotelCharges boolean required boolean Can the card be used for all charges for a room?
contactNumberOverride string  
showMainContactLine boolean required boolean
showCardHolderContactLine boolean required boolean
customText string   The first custom block of text that gets printed to the payment form PDF.
customText2 string   The second custom block of text that gets printed to the payment form PDF.
downloadPdfAuthorization boolean required boolean When true, a traveler for this.client can download the payment form from their itinerary
emailAuthorization boolean required boolean When true, a traveler for this.client can email the payment for from their itinerary.
faxAuthorization boolean required boolean When true, a traveler for this.client can send the payment via fax or Sertifi from their itinerary.
udfDateFormat string   The date format for user defined fields.
client Client  
maskedCreditCard MaskedCreditCard   The form of payment used if this HPL setup is using a multi-use card instead of a one time use card.
faxOnThursThruSun boolean required boolean Clients with this setting will deliver payment to domestic hotels on Thursday for check-ins that occur Saturday&Sunday
issuingBank string  
virtualPayContact VirtualPayContact   Get vpay contact
folioEmail string   The folio email is the email address that the hotel should forward invoicing information onto.
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

{
  "hplEnabled" : true,
  "hplLite" : true,
  "allowAllHotelCharges" : true,
  "contactNumberOverride" : "...",
  "showMainContactLine" : true,
  "showCardHolderContactLine" : true,
  "customText" : "...",
  "customText2" : "...",
  "downloadPdfAuthorization" : true,
  "emailAuthorization" : true,
  "faxAuthorization" : true,
  "udfDateFormat" : "...",
  "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" : "..."
    } ]
  },
  "maskedCreditCard" : {
    "id" : 12345,
    "clientId" : 12345,
    "number" : "...",
    "expireDate" : 12345,
    "cvc" : "...",
    "type" : "...",
    "bank" : "...",
    "name" : "...",
    "title" : "...",
    "phone" : "...",
    "email" : "...",
    "ghostCard" : true,
    "cardFront" : "...",
    "cardBack" : "...",
    "signature" : true,
    "payType" : {
      "code" : "...",
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "address1" : "...",
    "address2" : "...",
    "zip" : "...",
    "city" : "...",
    "region" : {
      "name" : "...",
      "code" : "...",
      "country" : { },
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }
  },
  "faxOnThursThruSun" : true,
  "issuingBank" : "...",
  "virtualPayContact" : {
    "client" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "name" : "...",
    "title" : "...",
    "phone" : "...",
    "ext" : "...",
    "email" : "...",
    "signature" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "folioEmail" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}