ClientServiceFee Data Type

A service fee explains the details of when a fee is posted by the TMC to the client. Created by nick on 4/16/14.

Properties
name data type constraints description
amount number required double
order number required int The order is the priority-level that the service fee is applied. Higher priority will get applied. Two service fees with the same priority will both be applied.
laborer ServiceFeeLaborer   The person that does a unit of work.
product ServiceFeeProduct   The product of the work.
accrualFrequency ServiceFeeAccrualFrequency   The frequency at which the debt is accrued.
payType ServiceFeePayType   The agreed upon payment type. Like cash or credit.
payFrequency ServiceFeePayFrequency   The rate at which the debt is paid.
paymentForm PaymentForm   The form of payment, if an exact form of payment is chosen instead of a pay type.
surcharge boolean required boolean Whether or not this charge should be applied in addition to another charge.
onAirline AirVendor   The airline that this service fee applies on.
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

{
  "amount" : 12345.0,
  "order" : 12345,
  "laborer" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "product" : {
    "code" : "...",
    "name" : "...",
    "accuracy" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "accrualFrequency" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "payType" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "payFrequency" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "paymentForm" : {
    "client" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "payType" : {
      "code" : "...",
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "maskedNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "surcharge" : true,
  "onAirline" : {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}