Skip to main content

CommissionBeneficiary

What one person earns across every order in the filtered set, split by status. It is added up by the database over the whole set.

type CommissionBeneficiary {
  levels: [Int!]!
  locked: Float!
  name: String!
  orders: Int!
  paid: Float!
  pending: Float!
  periods: [CommissionBeneficiaryPeriod!]!
  role: String
  total: Float!
  userId: String!
}

Fields​

CommissionBeneficiary.levels ● [Int!]! non-null scalar​

The chain levels the person earned at, lowest first. Hierarchical rows only.

CommissionBeneficiary.locked ● Float! non-null scalar​

The amount locked.

CommissionBeneficiary.name ● String! non-null scalar​

The name of the person.

CommissionBeneficiary.orders ● Int! non-null scalar​

How many different orders have a row for the person that is not reversed.

The amount paid.

CommissionBeneficiary.pending ● Float! non-null scalar​

The amount still pending.

CommissionBeneficiary.periods ● [CommissionBeneficiaryPeriod!]! non-null object​

The pending and locked amounts for each period.

CommissionBeneficiary.role ● String scalar​

The person's role.

CommissionBeneficiary.total ● Float! non-null scalar​

Pending plus locked plus paid. Reversed amounts are left out.

CommissionBeneficiary.userId ● String! non-null scalar​

The ID of the user.

Returned By​

commissionBeneficiaries query