CommissionSummary

A rep's commission figures.

type CommissionSummary {
  defaultRate: Float!
  lastMonthTotal: Float!
  lastPayoutDate: DateTime
  lifetimeEarned: Float!
  lifetimeOutstanding: Float!
  lifetimePaid: Float!
  period: String!
  rateMissing: Boolean!
  thisMonthLocked: Float!
  thisMonthOrders: Int!
  thisMonthPaid: Float!
  thisMonthPending: Float!
  thisMonthTotal: Float!
}

Fields

CommissionSummary.defaultRate ● Float! non-null scalar

The rep's commission rate, in percent.

CommissionSummary.lastMonthTotal ● Float! non-null scalar

Last calendar month's commission, pending plus locked plus paid.

CommissionSummary.lastPayoutDate ● DateTime scalar

The date of the last payout.

CommissionSummary.lifetimeEarned ● Float! non-null scalar

The commission earned over all time.

CommissionSummary.lifetimeOutstanding ● Float! non-null scalar

The commission earned and not yet paid.

CommissionSummary.lifetimePaid ● Float! non-null scalar

The commission paid over all time.

CommissionSummary.period ● String! non-null scalar

The period the figures are for.

CommissionSummary.rateMissing ● Boolean! non-null scalar

True when the rep's role has no active rate, so the default rate is an unconfigured 0 and not a configured 0%.

CommissionSummary.thisMonthLocked ● Float! non-null scalar

This month's commission locked.

CommissionSummary.thisMonthOrders ● Int! non-null scalar

How many orders earned commission this month.

CommissionSummary.thisMonthPaid ● Float! non-null scalar

This month's commission paid.

CommissionSummary.thisMonthPending ● Float! non-null scalar

This month's commission still pending.

CommissionSummary.thisMonthTotal ● Float! non-null scalar

This month's commission, pending plus locked plus paid.

Returned By

myCommissionSummary query