commissionBeneficiaries

Requires permission commissions:commission:read.

Lists who earns commission, one page at a time, with each beneficiary's total, pending, locked and paid amounts over the whole filtered set. Use commissionBeneficiariesCount for the total. Requires permission to read commissions.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query CommissionBeneficiaries {
  commissionBeneficiaries {
    name
    levels
    locked
    orders
    paid
    pending
    periods {
      locked
      pending
      period
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CommissionBeneficiaries {\n  commissionBeneficiaries {\n    name\n    levels\n    locked\n    orders\n    paid\n    pending\n    periods {\n      locked\n      pending\n      period\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "commissionBeneficiaries": [
      {
        "name": "string",
        "levels": [
          0
        ],
        "locked": 0,
        "orders": 0,
        "paid": 0,
        "pending": 0,
        "periods": [
          {
            "locked": 0,
            "pending": 0,
            "period": "string"
          }
        ]
      }
    ]
  }
}

commissionBeneficiaries(
  filters: CommissionFiltersInput
  skip: Int
  take: Int
): [CommissionBeneficiary!]!

Arguments

commissionBeneficiaries.filters ● CommissionFiltersInput input

Optional filters, the same as commissions.

commissionBeneficiaries.skip ● Int scalar

How many beneficiaries to skip.

commissionBeneficiaries.take ● Int scalar

How many beneficiaries to return.

Type

CommissionBeneficiary object

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.