commissionBeneficiariesCount

Requires permission commissions:commission:read.

Returns how many distinct beneficiaries match the filter, for the pager of commissionBeneficiaries. 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 CommissionBeneficiariesCount {
  commissionBeneficiariesCount
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CommissionBeneficiariesCount {\n  commissionBeneficiariesCount\n}"
}
EOF

Response:

{
  "data": {
    "commissionBeneficiariesCount": 0
  }
}

commissionBeneficiariesCount(
  filters: CommissionFiltersInput
): Int!

Arguments

commissionBeneficiariesCount.filters ● CommissionFiltersInput input

Optional filters. The same ones as commissionBeneficiaries.

Type

Int scalar

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.