commissionPayoutsCount

Requires permission commissions:commission:read.

Returns how many commission payouts match the same person and period as commissionPayouts, ignoring paging, for a pager. 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 CommissionPayoutsCount {
  commissionPayoutsCount
}

cURL

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

Response:

{
  "data": {
    "commissionPayoutsCount": 0
  }
}

commissionPayoutsCount(
  period: String
  userId: String
): Int!

Arguments

commissionPayoutsCount.period ● String scalar

The commission period, as YYYY-MM. Omit it for every period.

commissionPayoutsCount.userId ● String scalar

The ID of the sales rep.

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.