commissionPayouts

Requires permission commissions:commission:read.

Lists commission payouts made to sales reps, optionally for one person or period. Send skip and take to page, and use commissionPayoutsCount 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 CommissionPayouts {
  commissionPayouts {
    id
    repName
    status
    createdAt
    commissionCount
    paidAt
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CommissionPayouts {\n  commissionPayouts {\n    id\n    repName\n    status\n    createdAt\n    commissionCount\n    paidAt\n  }\n}"
}
EOF

Response:

{
  "data": {
    "commissionPayouts": [
      {
        "id": "id",
        "repName": "string",
        "status": "LOCKED",
        "createdAt": "2025-01-15T00:00:00Z",
        "commissionCount": 0,
        "paidAt": "2025-01-15T00:00:00Z"
      }
    ]
  }
}

commissionPayouts(
  period: String
  skip: Int
  take: Int
  userId: String
): [CommissionPayout!]!

Arguments

commissionPayouts.period ● String scalar

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

commissionPayouts.skip ● Int scalar

How many payouts to skip. Omit skip and take to return the whole scoped list.

commissionPayouts.take ● Int scalar

How many payouts to return.

commissionPayouts.userId ● String scalar

The ID of the sales rep.

Type

CommissionPayout object

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