Skip to main content

CommissionPayout

A payout settling a rep's commissions for a period.

type CommissionPayout {
  commissionCount: Int!
  createdAt: DateTime!
  id: ID!
  paidAt: DateTime
  period: String!
  reference: String
  repName: String
  status: CommissionStatus!
  totalAmount: Float!
  userId: String!
}

Fields​

CommissionPayout.commissionCount ● Int! non-null scalar​

How many commissions it settles.

CommissionPayout.createdAt ● DateTime! non-null scalar​

When the record was created.

CommissionPayout.id ● ID! non-null scalar​

The unique ID of this record.

When it was paid.

CommissionPayout.period ● String! non-null scalar​

The period the payout covers.

CommissionPayout.reference ● String scalar​

The payment reference.

CommissionPayout.repName ● String scalar​

The name of the rep.

CommissionPayout.status ● CommissionStatus! non-null enum​

The status of the payout.

CommissionPayout.totalAmount ● Float! non-null scalar​

The total paid out.

CommissionPayout.userId ● String! non-null scalar​

The ID of the user.

Returned By​

commissionPayouts query ● generateCommissionPayout mutation ● markCommissionPayoutPaid mutation