commissions

Requires permission commissions:commission:read.

Lists commission entries earned on sales, optionally filtered, for the whole organization or only the caller's scope. Send skip and take to page, and use commissionsCount 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 Commissions {
  commissions {
    id
    orderNumber
    customerName
    repName
    status
    createdAt
    chain {
      userName
      level
      rate
      rateMissing
      role
      userId
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Commissions {\n  commissions {\n    id\n    orderNumber\n    customerName\n    repName\n    status\n    createdAt\n    chain {\n      userName\n      level\n      rate\n      rateMissing\n      role\n      userId\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "commissions": [
      {
        "id": "id",
        "orderNumber": "string",
        "customerName": "string",
        "repName": "string",
        "status": "LOCKED",
        "createdAt": "2025-01-15T00:00:00Z",
        "chain": [
          {
            "userName": "string",
            "level": 0,
            "rate": 0,
            "rateMissing": true,
            "role": "string",
            "userId": "string"
          }
        ]
      }
    ]
  }
}

commissions(
  filters: CommissionFiltersInput
  skip: Int
  take: Int
): [Commission!]!

Arguments

commissions.filters ● CommissionFiltersInput input

Optional filters: person, period, status and sort order.

commissions.skip ● Int scalar

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

commissions.take ● Int scalar

How many entries to return.

Type

Commission object

A commission earned by one person on one order. A hierarchical order has one row per member of the reporting chain.