AgentCommissionStatement Data Type

An entry statement of commissions that an agent has been paid (or is expected to be paid). Created by nick on 3/18/16.

Properties
name data type description
status AgentCommissionStatementStatus The current status of the commission.
paidAmount number The amount that the TMC has paid to the agent for this commission.
expectedAmount number The amount that the agent expects to receive from the TMC.
appliedDate number The date that the commission went into the applied status.
paymentDate number The latest date that the agent should have received their commission. To be clear, this is the latest date that the TMC is required to have it in the mail.
closeDate number The date that the TMC closed the invoice with this commission. Closing means that no more changes can be made to the invoice's financials.
type ReservationType The type of travel that this commission is paying for.
segmentNumber number The number of the segment that this commission is paying for in the invoice.
invoice Invoice The ID of the invoice that this commission is paying for.
vendorName string The name of the vendor that is paying the commission (through the TMC).
agent EmployeeInfo The agent that is or has received the commission.
confirmationNumber string The identifying confirmation number of the commission.
travelerName string The name of the traveler that this commission is paying for.
ticketNumber string The ticket number of the ticket that this commission is paying for.
commission AgentCommission The commission that this statement has been applied to.
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

{
  "status" : {
    "description" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "paidAmount" : 12345.0,
  "expectedAmount" : 12345.0,
  "appliedDate" : 12345,
  "paymentDate" : 12345,
  "closeDate" : 12345,
  "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,
      "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,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "commission" : {
    "type" : {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "segmentNumber" : 12345,
    "invoice" : {
      "itinerary" : { },
      "number" : "...",
      "reservations" : [ { }, { } ],
      "lowFare" : 12345.0,
      "highFare" : 12345.0,
      "agent" : { },
      "airJustification" : { },
      "hotelJustification" : { },
      "carJustification" : { },
      "feeJustification" : { },
      "assistingAgent" : { },
      "issueDate" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "vendorName" : "...",
    "confirmationNumber" : "...",
    "travelerName" : "...",
    "ticketNumber" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}