Skip to main content

Commission

A commission earned by one person on one order. A hierarchical order has one row per member of the reporting chain.

type Commission {
  appliedRate: Float!
  baseCommissionAmount: Float
  baseOrderAmount: Float
  chain: [CommissionChainEntry!]
  commissionAmount: Float!
  createdAt: DateTime!
  currency: String
  customerName: String
  effectiveRate: Float!
  exchangeRate: Float
  id: ID!
  items: [CommissionItem!]
  level: Int!
  lockedAt: DateTime
  mode: String!
  orderAmount: Float!
  orderNumber: String!
  paidAt: DateTime
  partnerId: String!
  payoutId: String
  period: String!
  rateMissing: Boolean!
  repName: String
  roleSnapshot: String
  salesOrderId: String!
  sourceRepId: String
  status: CommissionStatus!
  userId: String!
}

Fields

`Commission.appliedRate` ● `Float!` non-null scalar

The rate applied, in percent.

`Commission.baseCommissionAmount` ● `Float` scalar

The commission in the organization's base currency. Empty on rows from before base amounts were stored.

`Commission.baseOrderAmount` ● `Float` scalar

The order amount in the organization's base currency. Empty on rows from before base amounts were stored.

`Commission.chain` ● `[CommissionChainEntry!]` list object

The reporting chain saved on the commission when it was created.

`Commission.commissionAmount` ● `Float!` non-null scalar

The commission, in the organization's base currency.

`Commission.createdAt` ● `DateTime!` non-null scalar

When the record was created.

`Commission.currency` ● `String` scalar

ISO 4217 currency code.

`Commission.customerName` ● `String` scalar

The name of the customer on the order.

`Commission.effectiveRate` ● `Float!` non-null scalar

The commission as a percent of the order amount.

`Commission.exchangeRate` ● `Float` scalar

The order's frozen rate from its currency to the base currency, saved when the commission was created.

`Commission.id` ● `ID!` non-null scalar

The unique ID of this record.

`Commission.items` ● `[CommissionItem!]` list object

The order lines the commission is made of.

`Commission.level` ● `Int!` non-null scalar

The level in the reporting chain. 1 is the assigned rep.

`Commission.lockedAt` ● `DateTime` scalar

When the commission was locked.

`Commission.mode` ● `String!` non-null scalar

How the commission was worked out, for example HIERARCHICAL for the organization's reporting structure.

`Commission.orderAmount` ● `Float!` non-null scalar

The order amount the commission is worked out on.

`Commission.orderNumber` ● `String!` non-null scalar

The number of the order.

`Commission.paidAt` ● `DateTime` scalar

When the commission was paid.

`Commission.partnerId` ● `String!` non-null scalar

The ID of the partner.

`Commission.payoutId` ● `String` scalar

The ID of the payout that settled the commission.

`Commission.period` ● `String!` non-null scalar

The month the commission belongs to.

`Commission.rateMissing` ● `Boolean!` non-null scalar

True when the commission was recorded at 0% because no rate is set for the person's role. It is not an earned 0%.

`Commission.repName` ● `String` scalar

The name of the person who earns the commission.

`Commission.roleSnapshot` ● `String` scalar

The role the person had when the commission was created.

`Commission.salesOrderId` ● `String!` non-null scalar

The ID of the sales order.

`Commission.sourceRepId` ● `String` scalar

The ID of the rep whose order produced the commission.

`Commission.status` ● `CommissionStatus!` non-null enum

Where the commission stands: PENDING, LOCKED, PAID or REVERSED.

`Commission.userId` ● `String!` non-null scalar

The ID of the user.

Returned By

commissions query ● myCommissions query

Member Of

CommissionOrderGroup object

Fields
Returned By
Member Of