myCommissions

Requires an authenticated session.

Lists the signed-in user's own commission entries, optionally for one period or one status. Only their own entries are ever returned.

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 MyCommissions {
  myCommissions {
    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 MyCommissions {\n  myCommissions {\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": {
    "myCommissions": [
      {
        "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"
          }
        ]
      }
    ]
  }
}

myCommissions(
  period: String
  status: CommissionStatus
): [Commission!]!

Arguments

myCommissions.period ● String scalar

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

myCommissions.status ● CommissionStatus enum

Only return entries in this status.

Type

Commission object

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